Skip to content

Commit

Permalink
Fix typo in fcs 2.0 spec
Browse files Browse the repository at this point in the history
  • Loading branch information
Querela authored Jun 29, 2023
1 parent 1aab315 commit dbc795d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion fcs-core-2.0/interface-specification.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ Resource Fragments::

A Resource `SHOULD` be the most precise unit of data that is directly addressable as a "whole". A Resource `SHOULD` contain a Resource Fragment, if the hit consists of just a part of the Resource unit (for example if the hit is a sentence within a large text). A Resource Fragment `SHOULD` be addressable within a resource, i.e. it has an offset or a resource-internal identifier. Using Resource Fragments is `OPTIONAL`, but Endpoints are encouraged to use them. If the Endpoint encodes a hit with a Resource Fragment, the actual hit `SHOULD` be encoded as a Data View within the Resource Fragment.

Endpoints `SHOULD` always provide a link to the resource itself, i.e. each Resource or Resource Fragment` SHOULD` be identified by a persistent identifier or providing a URI that is unique for the Endpoint. Even if direct linking is not possible, i.e. due to licensing issues, the Endpoints `SHOULD` provide a URI to link to a web-page describing the corpus or collection, including instruction on how to obtain it. Endpoints `SHOULD` provide links that are as specific as possible (and logical), i.e. if a sentence within a resource cannot be addressed directly, the Resource Fragment `SHOULD NOT` contain a persistent identifier or an URI.
Endpoints `SHOULD` always provide a link to the resource itself, i.e. each Resource or Resource Fragment `SHOULD` be identified by a persistent identifier or providing a URI that is unique for the Endpoint. Even if direct linking is not possible, i.e. due to licensing issues, the Endpoints `SHOULD` provide a URI to link to a web-page describing the corpus or collection, including instruction on how to obtain it. Endpoints `SHOULD` provide links that are as specific as possible (and logical), i.e. if a sentence within a resource cannot be addressed directly, the Resource Fragment `SHOULD NOT` contain a persistent identifier or an URI.

If the Endpoint can provide both, a persistent identifier as well as a URI, for either Resource or Resource Fragment, then they `SHOULD` provide both. When working with results, Clients `SHOULD` prefer persistent identifiers over regular URIs.

Expand Down

0 comments on commit dbc795d

Please sign in to comment.