Skip to content

info

/info/*

This file describes the router for:

/info/{entry}

where, entry may be left out.

ENTRY_INFO_SCHEMAS: dict[str, type[EntryResource]] = {'databases': LinksResource, 'gateways': GatewayResource, 'queries': QueryResource} module-attribute

This dictionary is used to define the /info/<entry_type> endpoints.

get_entry_info(request, entry) async

GET /info/{entry}

Get information about the gateway service's entry-listing endpoints.

Source code in optimade_gateway/routers/info.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
@ROUTER.get(
    "/info/{entry}",
    response_model=EntryInfoResponse,
    response_model_exclude_defaults=False,
    response_model_exclude_none=False,
    response_model_exclude_unset=True,
    tags=["Info"],
    responses=ERROR_RESPONSES,
)
async def get_entry_info(request: Request, entry: str) -> EntryInfoResponse:
    """`GET /info/{entry}`

    Get information about the gateway service's entry-listing endpoints.
    """
    valid_entry_info_endpoints = ENTRY_INFO_SCHEMAS.keys()
    if entry not in valid_entry_info_endpoints:
        raise NotFound(
            detail=(
                f"Entry info not found for {entry}, valid entry info endpoints are: "
                f"{', '.join(valid_entry_info_endpoints)}"
            ),
        )

    schema = ENTRY_INFO_SCHEMAS[entry]
    queryable_properties = {"id", "type", "attributes"}
    properties = await aretrieve_queryable_properties(
        schema, queryable_properties, entry_type=entry
    )

    output_fields_by_format = {"json": list(properties)}

    return EntryInfoResponse(
        data=EntryInfoResource(
            formats=list(output_fields_by_format),
            description=getattr(schema, "__doc__", "Entry Resources"),
            properties=properties,
            output_fields_by_format=output_fields_by_format,
        ),
        meta=meta_values(
            url=request.url,
            data_returned=1,
            data_available=1,
            more_data_available=False,
            schema=CONFIG.schema_url,
        ),
    )

get_info(request) async

GET /info

An introspective endpoint for the gateway service.

Source code in optimade_gateway/routers/info.py 
41
42
43
44
45
46
47
48
49
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
85
86
87
88
89
90
91
92
93
@ROUTER.get(
    "/info",
    response_model=InfoResponse,
    response_model_exclude_defaults=False,
    response_model_exclude_none=False,
    response_model_exclude_unset=True,
    tags=["Info"],
    responses=ERROR_RESPONSES,
)
async def get_info(request: Request) -> InfoResponse:
    """`GET /info`

    An introspective endpoint for the gateway service.
    """
    return InfoResponse(
        data=BaseInfoResource(
            id=BaseInfoResource.model_fields["id"].default,
            type=BaseInfoResource.model_fields["type"].default,
            attributes=BaseInfoAttributes(
                api_version=__api_version__,
                available_api_versions=[
                    {
                        "url": (
                            f"{get_base_url(request.url)}"
                            f"/v{__api_version__.split('.', maxsplit=1)[0]}"
                        ),
                        "version": __api_version__,
                    }
                ],
                formats=["json"],
                entry_types_by_format={"json": list(ENTRY_INFO_SCHEMAS.keys())},
                available_endpoints=sorted(
                    [
                        "docs",
                        "info",
                        "links",
                        "openapi.json",
                        "redoc",
                        "search",
                        *list(ENTRY_INFO_SCHEMAS.keys()),
                    ]
                ),
                is_index=False,
            ),
        ),
        meta=meta_values(
            url=request.url,
            data_returned=1,
            data_available=1,
            more_data_available=False,
            schema=CONFIG.schema_url,
        ),
    )