Class Implementation

optimade/models/optimade_json.py:246–284

Information on the server implementation

class Implementation(BaseModel):
    """Information on the server implementation"""

    name: Annotated[
        str | None, StrictField(description="name of the implementation")
    ] = None

    version: Annotated[
        str | None,
        StrictField(description="version string of the current implementation"),
    ] = None

    homepage: Annotated[
        jsonapi.JsonLinkType | None,
        StrictField(
            description="A [JSON API links object](http://jsonapi.org/format/1.0/#document-links) pointing to the homepage of the implementation.",
        ),
    ] = None

    source_url: Annotated[
        jsonapi.JsonLinkType | None,
        StrictField(
            description="A [JSON API links object](http://jsonapi.org/format/1.0/#document-links) pointing to the implementation source, either downloadable archive or version control system.",
        ),
    ] = None

    maintainer: Annotated[
        ImplementationMaintainer | None,
        StrictField(
            description="A dictionary providing details about the maintainer of the implementation.",
        ),
    ] = None

    issue_tracker: Annotated[
        jsonapi.JsonLinkType | None,
        StrictField(
            description="A [JSON API links object](http://jsonapi.org/format/1.0/#document-links) pointing to the implementation's issue tracker.",
        ),
    ] = None


class ResponseMeta(jsonapi.Meta):