Uploaded image for project: 'Nuxeo Documentation'
  1. Nuxeo Documentation
  2. NXDOC-527

Add JSON examples for POST/PUT calls in the REST API documentation

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Developer documentation, REST API

      Description

      I realised during training that we have no place to find information about required fields when doing a POST/PUT call, to create / update a document.

      => Usually people tend to do a GET and try to determine what is needed or not. This is not good.

      => Add examples (could be added to the REST API entity types page for instance).

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              bchauvin Bertrand Chauvin
              Participants:
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: