index_info¶
CONFIG: ServerConfig = ServerConfig()
module-attribute
¶
This singleton loads the config from a hierarchy of sources (see
customise_sources
)
and makes it importable in the server code.
ERROR_RESPONSES: Optional[dict[int, dict[str, Any]]] = {err.status_code: {'model': ErrorResponse, 'description': err.title}for err in POSSIBLE_ERRORS}
module-attribute
¶
__api_version__ = '1.1.0'
module-attribute
¶
router = APIRouter(redirect_slashes=True)
module-attribute
¶
IndexInfoAttributes
¶
Bases: BaseInfoAttributes
Attributes for Base URL Info endpoint for an Index Meta-Database
Source code in optimade/models/index_metadb.py
17 18 19 20 21 22 23 24 25 |
|
IndexInfoResource
¶
Bases: BaseInfoResource
Index Meta-Database Base URL Info endpoint resource
Source code in optimade/models/index_metadb.py
46 47 48 49 50 51 52 53 54 55 56 57 |
|
IndexInfoResponse
¶
Bases: Success
Source code in optimade/models/responses.py
53 54 55 56 |
|
model_config = ConfigDict(json_encoders={datetime: lambda : v.astimezone(timezone.utc).strftime('%Y-%m-%dT%H:%M:%SZ')})
class-attribute
instance-attribute
¶
The specification mandates that datetimes must be encoded following RFC3339, which does not support fractional seconds, thus they must be stripped in the response. This can cause issues when the underlying database contains fields that do include microseconds, as filters may return unexpected results.
either_data_meta_or_errors_must_be_set()
¶
Overwriting the existing validation function, since 'errors' MUST NOT be set.
Source code in optimade/models/optimade_json.py
387 388 389 390 391 392 393 394 395 396 397 398 399 400 |
|
IndexRelationship
¶
Bases: BaseModel
Index Meta-Database relationship
Source code in optimade/models/index_metadb.py
34 35 36 37 38 39 40 41 42 43 |
|
RelatedLinksResource
¶
Bases: BaseResource
A related Links resource object
Source code in optimade/models/index_metadb.py
28 29 30 31 |
|
get_base_url(parsed_url_request)
¶
Get base URL for current server
Take the base URL from the config file, if it exists, otherwise use the request.
Source code in optimade/server/routers/utils.py
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
|
get_info(request)
¶
Source code in optimade/server/routers/index_info.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
|
meta_values(url, data_returned, data_available, more_data_available, schema=None, **kwargs)
¶
Helper to initialize the meta values
Source code in optimade/server/routers/utils.py
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
|