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

As PO, I can refer to a documentation/rules page when asking for the development of a new rest endpoint

    Details

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

      Description

      Developer will find in this documentation page all the guidelines he should respect:

      • short briefing on what has to be written (webengine module, responsewritter)...
      • rules to respect on : the adapters names, the entity-type names (ex: CamelCase), differents returns formats that have to be implemented ..

      Also existing APIs should follow this recommendations.
      Test case:

      • I can browse the page on the wiki.
      • I have a list of what has been refactored

      Each user story implying to develop a new Rest endpoint will refer to this page for the things to check in the end.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              aescaffre Alain Escaffre
              Participants:
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - 6 hours
                6h
                Remaining:
                0m
                Logged:
                Time Not Required
                Not Specified

                  PagerDuty

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