This schema defines the structure of an extension to SRU/CQL
used by CLARIN-FCS.
An Endpoint MUST provide this information in the
<extraResponseData> element of the result
to an explain operation, if (and only if) a
CLARIN-FCS client performed the request with the
x-clarin-fcs-endpoint-description extra
request parameter with a value of true.
The root element of the Endpoint description extension for
CLARIN-FCS extension.
An Endpoint MUST provide this information in the
<extraResponseData>
element of the result to an explain operation,
if (and only if) a CLARIN-FCS client performed the request
with the x-clarin-fcs-endpoint-description
extra request parameter with a value of true.
A list of Capabilities, that are supported by this Endpoint.
A Capability, encoded by an URI, that is supported by this Endpoint.
For valid URIs, consult the CLARIN-FCS specification.
A list of Data Views, that are supported
by this Endpoint.
The MIME type of a supported Data View.
An unique ID for this support Data View. This value will be used,
when referencing in the <AvailableDataViews> element in
the <Resource> description.
This attribute indicated the delivery policy of this supported Data View.
This Data View is automatically sent by the Endpoint for supported Resources.
This Data View needs to be explicatively requested by the Client.
A list of top-level resources, that are available
at an Endpoint. An Endpoint MUST
declare at least one top-level resource.
Extension point to allow Endpoints to embed custom data in the Endpoint Description.
CLARIN-FCS clients SHOULD ignore any data they do not understand.
Version used for Endpoint Description. Endpoints MUST use the value "1".
A list of resources, that are available
at an Endpoint. An Endpoint MUST
declare at least one resource.
Detailed description of a resource that is available at an
Endpoint. A resource is a searchable
entity at an Endpoint, e.g. a single corpus.
A human readable title for the resource. An English version is
mandatory.
An optional human-readable description of the resource. Is should
be at most one sentence. If supplied, an English version is
mandatory.
A link to a website for the resource, e.g. a landing page for a corpus.
The (relevant) languages available within the resource.
A ISO 639-3 three letter language code. This
element should be repeated for all languages
(relevant) available within the resource.
This element contains a reference to all Data Views that are
supported by this resource in the @ref attribute.
If a resource has searchable sub-resources
the Endpoint MUST supply additional finer grained
<Resource> elements. A sub-resource is a
searchable entity within a resource, e.g. a sub-corpus.
Extension point to allow Endpoints to embed custom data in the Endpoint Description
for a specific resource. CLARIN-FCS clients SHOULD ignore any data they do not understand.
The persistent identifier of this resource. This
value MUST be the same as the MdSelfLink
of the CMDI record describing the collection.