Changes between Version 16 and Version 17 of Taskforces/FCS/FCS-Specification-Draft

Timestamp:

10/26/15 10:01:13 (9 years ago)

Author:

Oliver Schonefeld

Comment:

--

Taskforces/FCS/FCS-Specification-Draft

@@ -165 +165 @@
 
 The following XML namespace names and prefixes are used throughout this specification. The column "Recommended Syntax" indicates which syntax variant `SHOULD` be used by the Endpoint to serialize the XML response.
-||=Prefix =||=Namespace Name                                 =||=Comment                          =||=Recommended Syntax =||
-|| `fcs`   || `http://clarin.eu/fcs/resource`                 || CLARIN-FCS Resources              || prefixed ||
-|| `ed`    || `http://clarin.eu/fcs/endpoint-description`     || CLARIN-FCS Endpoint Description   || prefixed ||
-|| `hits`  || `http://clarin.eu/fcs/dataview/hits`            || CLARIN-FCS Generic Hits Data View || prefixed ||
-|| `adv`   || `http://clarin.eu/fcs/dataview/advanced`        || CLARIN-FCS Advanced Data View     || prefixed ||
-|| `sru`   || `http://www.loc.gov/zing/srw/`                  || SRU                               || prefixed ||
-|| `diag`  || `http://www.loc.gov/zing/srw/diagnostic/`       || SRU Diagnostics                   || prefixed ||
-|| `zr`    || `http://explain.z3950.org/dtd/2.0/`             || SRU/ZeeRex Explain                || prefixed ||
-{{{
-#!div style="border: 1px solid #000000; font-size: 75%"
-Careful with the SRU Namespaces; they probably need to be adjusted SRU 2.0 (=> OASIS).
+||=Prefix =||=Namespace Name                                       =||=Comment                          =||=Recommended Syntax =||
+|| `fcs`   || `http://clarin.eu/fcs/resource`                       || CLARIN-FCS Resources              || prefixed ||
+|| `ed`    || `http://clarin.eu/fcs/endpoint-description`           || CLARIN-FCS Endpoint Description   || prefixed ||
+|| `hits`  || `http://clarin.eu/fcs/dataview/hits`                  || CLARIN-FCS Generic Hits Data View || prefixed ||
+|| `adv`   || `http://clarin.eu/fcs/dataview/advanced`              || CLARIN-FCS Advanced Data View     || prefixed ||
+|| `sru`   || `http://docs.oasis-open.org/ns/search-ws/sruResponse` || SRU                               || prefixed ||
+|| `diag`  || `http://docs.oasis-open.org/ns/search-ws/diagnostic`  || SRU Diagnostics                   || prefixed ||
+|| `zr`    || `http://explain.z3950.org/dtd/2.0/`                   || SRU/ZeeRex Explain                || prefixed ||
+{{{
+#!div style="border: 1px solid #000000; font-size: 75%"
+What to do about SRU 1.2 backwards compatibility; they used to have XML namespaces from LOC.
 }}}
 
@@ -394 +394 @@
 
 === Versioning and Extensions
-==== Backwards Compatibility
+==== Backwards Compatibility #backwardsCompatibility
 {{{
 #!div style="border: 1px solid #000000; font-size: 75%"
@@ -402 +402 @@
 
 Clients `MUST` be compatible to CLARIN-FCS 1.0, thus must implement SRU 1.2. If a Client uses CLARIN-FCS 1.0 to talk to an Endpoint, it `MUST NOT` use features beyond the Basic Search capability. Clients `MUST` implement a heuristic to automatically determine which CLARIN-FCS protocol version, i.e. which version of the SRU protocol, can be used talk an Endpoint.
+
+When using SRU 1.2 Endpoints `SHOULD` use the following legacy XML namespace names (namespace URIs) for serializing responses:
+ * `http://www.loc.gov/zing/srw/` for SRU response documents, and
+ * `http://www.loc.gov/zing/srw/diagnostic/` for diagnostics within SRU response documents.
+Clients `MUST` be able to process the legacy XML namespaces as well as the OASIS XML namespaces. CLARIN-FCS deviates from the OASIS specification [#REF_SRU_Overview OASIS-SRU-Overview] and [#REF_SRU_12 OASIS-SRU-12] to ensure backwards comparability with SRU 1.2 services as they were defined by the [#REF_LOC_SRU_12 LOC-SRU12].
 
 Pseudo algorithm for version detection heuristic:
@@ -435 +440 @@
 Endpoints `SHOULD` implement APD Binding for SRU 1.2, as defined in [#REF_SRU_12 OASIS-SRU-12]. \\
 Endpoints and Clients `MAY` also implement APD binding for version 1.1.
-
-{{{
-#!div style="border: 1px solid #000000; font-size: 75%"
-TODO: think about XML namespaces
-}}}
-Endpoints and Clients `MUST` use the following XML namespace names (namespace URIs) for serializing responses:
- * `http://www.loc.gov/zing/srw/` for SRU response documents, and
- * `http://www.loc.gov/zing/srw/diagnostic/` for diagnostics within SRU response documents.
-CLARIN-FCS deviates from the OASIS specification [#REF_SRU_Overview OASIS-SRU-Overview] and [#REF_SRU_12 OASIS-SRU-12] to ensure backwards comparability with SRU 1.2 services as they were defined by the [#REF_LOC_SRU_12 LOC-SRU12].
+'''NOTE:''': when implementing SRU 1.2 Endpoints and Clients `MUST` behave like described in the section [#backwardsCompatibility Backwards Compatibility].
 
 Endpoints or Clients `MUST` support CQL conformance ''Level 2'' (as defined in [#REF_OASIS_CQL OASIS-CQL, section 6]), i.e. be able to ''parse'' (Endpoints) or ''serialize'' (Clients) all of CQL and respond with appropriate error messages to the search/retrieve protocol interface.