Links
LinksResource (EntryResource)
pydantic-model
¶
A Links endpoint resource object
LinksResourceAttributes (Attributes)
pydantic-model
¶
Links endpoint resource object attributes
base_url: Union[pydantic.networks.AnyUrl, optimade.models.jsonapi.Link]
pydantic-field
required
¶
JSON API links object, pointing to the base URL for this implementation
description: str
pydantic-field
required
¶
Human-readable description for the OPTIMADE API implementation a client may provide in a list to an end-user.
homepage: Union[pydantic.networks.AnyUrl, optimade.models.jsonapi.Link]
pydantic-field
required
¶
JSON API links object, pointing to a homepage URL for this implementation
link_type: str
pydantic-field
required
¶
The link type of the represented resource in relation to this implementation. MUST be one of these values: 'child', 'root', 'external', 'providers'.
name: str
pydantic-field
required
¶
Human-readable name for the OPTIMADE API implementation a client may provide in a list to an end-user.