capabilities_info object

capabilities_info

required

root level object

Contains information about capabilities. MUST be provided for every participant that provides services within DSGO

publicServices

optional

array of objects in capabilities_info

MUST contain a list of public features

identifier

required

string in publicServices

Identifier of the data service, MUST be unique and defined by the data service provider

title

required

string in publicServices

Human readable name of the data service, MUST be limited to a maximum of 100 characters

description

optional

string in publicServices

Short description of the data service, MUST be limited to a maximum of 1000 characters

endpointDescription

optional

string in publicServices

URL that provides a description of the service endpoint. Could be for instance a URL to an OpenAPI description, a WSDL document, a a SPARQL Service Description, a DCAT Data Catalog, etc.

endpointUrl

required

string in publicServices

URL to the data service

tokenEndpoint

optional

string in publicServices

URL where access token for the feature could be retrieved. This is optional because if title is access token, it is not needed to mention it twice, or if the data service does not require an access token.

status

required

string in publicServices

Provides information on the status of the service. Must be either active or deprecated

serviceType

required

string in publicServices

A framework-defined service is required from a framework perspective (including for instance the /capabilities endpoint), a dataspace-defined service is required from a dataspace perspective and a self-defined service is define by the provider of the service (actual data services are part of this category). Allowed values areframework-defined, dataspace-defined, self-defined

version

required

object in publicServices

Versioning information of the provided service.

compliesWithFrameworkVersions

optional

array of strings in version

Array of framework versions that the service complies with, at a framework level. If not included, the service is assumed to be compliant with the latest version. The versions can be retrieved using the /versions endpoint. NOG AANPASSEN Required for framework-defined services.

compliesWithDataspaceVersions

optional

array of strings in version

Array of dataspace versions that the service complies with, at a dataspace level.

capabilityVersion

required

array of strings in version

Version of the provided data service. Not related to the version numbering of the framework or dataspace.

methods

optional

array of strings in publicServices

Array of HTTP methods supported by the endpoint, for example:GET, POST, UPDATE, DELETE, etc.

aal*

optional

string in publicServices

Authentication Assurance Levels defined for the data service. Allowed values are adSeal, QSeal and ClientPassword.

conformsTo*

optional

array of strings in publicServices

MUST contain a (reference to) (one or more) recognised standard to indicate ontologies, semantics, schemes to which the resource in the data service conforms. In order to be machine-readable, this MUST contain an array of URLs, if this is not possible, it MAY contain a human-readable description of the standard.

data_service_info*

optional

object in publicServices

Data service specification. MUST contain a valid data_service_info object. See data_service_info object for more information.

restrictedServices

Optional

Array of objects in capabilities_info

MUST contain supported restricted features. The structure and parameters are exactly the same as defined in publicServices above. This object should only be provided to the parties which provided a valid access token. If an access token was not provided or restricted endpoints do not exist, restrictedServices MUST not be returned.