httk.optimade.endpoints

Submodules

Functions

generate_entry_endpoint_reply(→ dict[str, Any])

generate_single_entry_endpoint_reply(→ dict[str, Any])

format_optimade_error(...)

generate_base_endpoint_reply(→ str)

generate_entry_info_endpoint_reply(→ dict[str, Any])

generate_info_endpoint_reply(→ dict[str, Any])

generate_links_endpoint_reply(→ dict[str, Any])

generate_versions_endpoint_reply(→ str)

generate_meta(→ dict[str, Any])

Package Contents

httk.optimade.endpoints.generate_entry_endpoint_reply(request: httk.optimade.model.request.ValidatedRequest, config: httk.optimade.model.config.OptimadeConfig, data: httk.optimade.model.results.QueryResults, related_resolver: RelatedResolver | None = None) → dict[str, Any][source]
httk.optimade.endpoints.generate_single_entry_endpoint_reply(request: httk.optimade.model.request.ValidatedRequest, config: httk.optimade.model.config.OptimadeConfig, data: httk.optimade.model.results.QueryResults, related_resolver: RelatedResolver | None = None) → dict[str, Any][source]
httk.optimade.endpoints.format_optimade_error(ex: Exception, request: httk.optimade.model.request.RawRequest, config: httk.optimade.model.config.OptimadeConfig, version: str = optimade_default_version) → httk.optimade.model.request.EndpointResponse[source]
httk.optimade.endpoints.generate_base_endpoint_reply(request: httk.optimade.model.request.ValidatedRequest, config: httk.optimade.model.config.OptimadeConfig) → str[source]
httk.optimade.endpoints.generate_entry_info_endpoint_reply(request: httk.optimade.model.request.ValidatedRequest, config: httk.optimade.model.config.OptimadeConfig, entry: str, schema: httk.optimade.schema.served.ServedSchema) → dict[str, Any][source]
httk.optimade.endpoints.generate_info_endpoint_reply(request: httk.optimade.model.request.ValidatedRequest, config: httk.optimade.model.config.OptimadeConfig, schema: httk.optimade.schema.served.ServedSchema) → dict[str, Any][source]
httk.optimade.endpoints.generate_versions_endpoint_reply(request: httk.optimade.model.request.ValidatedRequest, config: httk.optimade.model.config.OptimadeConfig) → str[source]
httk.optimade.endpoints.generate_meta(*, representation: str, api_version: str, config: httk.optimade.model.config.OptimadeConfig, data_count: int | None = None, more_data_available: bool = False, data_available: int | None = None, warnings: list[dict[str, Any]] | None = None, last_id: str | None = None) → dict[str, Any][source]