Changes between Version 62 and Version 63 of Taskforces/FCS/FCS-Specification-Draft


Ignore:
Timestamp:
06/13/17 13:22:37 (7 years ago)
Author:
Leif-Jöran
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Taskforces/FCS/FCS-Specification-Draft

    v62 v63  
    767767To 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].
    768768
    769 The following example shows a request and response to an ''explain'' request with added extra request parameter `x-fcs-endpoint-description`:
     769The following example shows a SRU 1.2 request and response to an ''explain'' request with added extra request parameter `x-fcs-endpoint-description`:
    770770* HTTP GET request: Client → Endpoint:
    771771{{{#!sh
     
    841841}}}
    842842
     843And 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
     846http://repos.example.org/fcs-endpoint2?operation=explain&x-fcs-endpoint-description=true
     847}}}
     848* HTTP Response: Endpoint → Client:
    843849{{{#!xml
    844850<sruResponse:explainResponse>