Changes between Version 62 and Version 63 of Taskforces/FCS/FCS-Specification-Draft
- Timestamp:
- 06/13/17 13:22:37 (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Taskforces/FCS/FCS-Specification-Draft
v62 v63 767 767 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 [#endpointDescription Endpoint Description]. 768 768 769 The following example shows a request and response to an ''explain'' request with added extra request parameter `x-fcs-endpoint-description`:769 The following example shows a SRU 1.2 request and response to an ''explain'' request with added extra request parameter `x-fcs-endpoint-description`: 770 770 * HTTP GET request: Client → Endpoint: 771 771 {{{#!sh … … 841 841 }}} 842 842 843 And a SRU 2.0 example request and response to an ''explain'' request with added extra request parameter `x-fcs-endpoint-description`: 844 * HTTP GET request: Client → Endpoint: 845 {{{#!sh 846 http://repos.example.org/fcs-endpoint2?operation=explain&x-fcs-endpoint-description=true 847 }}} 848 * HTTP Response: Endpoint → Client: 843 849 {{{#!xml 844 850 <sruResponse:explainResponse>