Skip to content

Commit

Permalink
Proofing.
Browse files Browse the repository at this point in the history
  • Loading branch information
Querela committed Sep 4, 2024
1 parent 0b4b2d0 commit 24c02c3
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion fcs-core-1.0/attachments/Endpoint-Description.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@
<xs:annotation>
<xs:documentation>
<h:p>
A human readable title for the resource. An English version is
A human-readable title for the resource. An English version is
mandatory.
</h:p>
</xs:documentation>
Expand Down
2 changes: 1 addition & 1 deletion fcs-core-1.0/fcs-to-sru-cql-binding.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ According to the Capabilities supported by the Endpoint the Explain record `MUST
+
Other capabilities may define how the `<zr:indexInfo>` element is to be used, therefore it is `NOT RECOMMENDED` for Endpoints to use it in custom extensions.

To support auto-configuration in CLARIN-FCS, the Endpoint `MUST` provide support _Endpoint Description_. The Endpoint Description is included in explain response utilizing SRUs extension mechanism, i.e. by embedding an XML fragment into the `<sru:extraResponseData>` element. The Endpoint `MUST` include the Endpoint Description _only_ if the Client performs an explain request with the _extra request parameter_ `x-fcs-endpoint-description` with a value of `true`. If the Client performs an explain request _without_ supplying this extra request parameter the Endpoint `MUST NOT`` include the Endpoint Description. The format of the Endpoint Description XML fragment is defined in <<Endpoint Description>>.
To support auto-configuration in CLARIN-FCS, the Endpoint `MUST` provide an _Endpoint Description_. The Endpoint Description is included in explain response utilizing SRUs extension mechanism, i.e. by embedding an XML fragment into the `<sru:extraResponseData>` element. The Endpoint `MUST` include the Endpoint Description _only_ if the Client performs an explain request with the _extra request parameter_ `x-fcs-endpoint-description` with a value of `true`. If the Client performs an explain request _without_ supplying this extra request parameter the Endpoint `MUST NOT`` include the Endpoint Description. The format of the Endpoint Description XML fragment is defined in <<Endpoint Description>>.

The following example shows a request and response to an _explain_ request with added extra request parameter `x-fcs-endpoint-description`:

Expand Down
2 changes: 1 addition & 1 deletion fcs-core-1.0/interface-specification.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ The `<ed:Resource>` element contains a basic description of a resource that is a

* one or more `<ed:Title>` elements (`REQUIRED`)
+
A human readable title for the resource. A `REQUIRED` `@xml:lang` attribute indicates the language of the title. An English version of the title is `REQUIRED`. The list of titles `MUST NOT` contain duplicate entries for the same language.
A human-readable title for the resource. A `REQUIRED` `@xml:lang` attribute indicates the language of the title. An English version of the title is `REQUIRED`. The list of titles `MUST NOT` contain duplicate entries for the same language.

* zero or more `<ed:Description>` elements (`OPTIONAL`)
+
Expand Down

0 comments on commit 24c02c3

Please sign in to comment.