Uploaded image for project: 'OASIS Open Data Protocol (OData) TC'
  1. OASIS Open Data Protocol (OData) TC
  2. ODATA-81

Rewrite section 3 Service Root URL for clarity and readability

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: V4.0_WD01
    • Fix Version/s: V4.0_WD01
    • Component/s: URL Conventions
    • Labels:
      None
    • Proposal:
      Hide

      `The service root URL identifies the root of an OData service. This URL MUST point to an AtomPub Service Document (as specified in [RFC5023]).`

      `Per default this service document MUST follow the OData conventions for AtomPub Service Documents. If a different format has been explicitely requested, a corresponding alternate representation of an Atom Service Document MUST be delivered. [OData-JSON] specifies such an alternate JSON-based representation of a service document.`

      `Regardless of format, the service document is required to be returned from the root of an OData service to provide clients with a generic and simple mechanism to enumerate all collections of resources offered by the data service.`

      Show
      `The service root URL identifies the root of an OData service. This URL MUST point to an AtomPub Service Document (as specified in [RFC5023] ).` `Per default this service document MUST follow the OData conventions for AtomPub Service Documents. If a different format has been explicitely requested, a corresponding alternate representation of an Atom Service Document MUST be delivered. [OData-JSON] specifies such an alternate JSON-based representation of a service document.` `Regardless of format, the service document is required to be returned from the root of an OData service to provide clients with a generic and simple mechanism to enumerate all collections of resources offered by the data service.`
    • Resolution:
      Hide

      https://www.oasis-open.org/apps/org/workgroup/odata/download.php/46942/odata-url-conventions-v1.0-wd01-2012-09-18-RH.doc

      Accepted: https://www.oasis-open.org/committees/download.php/46960/odata_meeting-8_on-20120920_minutes.html

      Show
      https://www.oasis-open.org/apps/org/workgroup/odata/download.php/46942/odata-url-conventions-v1.0-wd01-2012-09-18-RH.doc Accepted: https://www.oasis-open.org/committees/download.php/46960/odata_meeting-8_on-20120920_minutes.html

      Description

      Consider splitting and rewriting the only paragraph of this section:

      `The service root URL identifies the root of an OData service. The resource identified by this URL MUST be an AtomPub Service Document (as specified in [RFC5023]) and follow the OData conventions for AtomPub Service Documents (or an alternate representation of an Atom Service Document if a different format is requested). [OData-JSON] specifies such an alternate JSON-based representation of a service document. The service document is required to be returned from the root of an OData service to provide clients with a simple mechanism to enumerate all of the collections of resources available for the data service.`

      as proposed.

        Attachments

          Activity

            People

            • Assignee:
              handl Ralf Handl
              Reporter:
              sdrees Stefan Hagen
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: