Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-12368

As a developper, I should be able to specify the version of the API I am using.

    XMLWordPrintable

    Details

    • Type: User story
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 5.8
    • Component/s: Rest API

      Description

      When Nuxeo makes some evolutions to the API that breaks the compatibility, my app still works as I can specify in the URL the version of the API I use (and the former version of the API is in the list of still supported versions).

      pattern:

      /api/v1/id/{docId}...
      

      Note: using the version segment is mandatory
      Note bis : the version is used mostly for giving guarantees to the API user that the JSON entities won't change when migrating to newer version of Nuxeo.

      Acceptance
      ---------------
      Calling any of Nuxeo current REST Endpoint with the version segment equal to "v1" works
      Callling any of Nuxeo current REST Endpoin without any version segment returns a webengine exception
      Calling any of Nuxeo current REST Endpoint with any other string than "v1" returns webengine exception

        Attachments

          Activity

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - 4 hours
                4h
                Remaining:
                Remaining Estimate - 4 hours
                4h
                Logged:
                Time Spent - Not Specified
                Not Specified

                  PagerDuty

                  Error rendering 'com.pagerduty.jira-server-plugin:PagerDuty'. Please contact your Jira administrators.