Uploaded image for project: 'OpenIDM'
  1. OpenIDM
  2. OPENIDM-1937

review examples in REST supported operations appendix

    XMLWordPrintable

Details

    • Bug
    • Status: Closed
    • Major
    • Resolution: Fixed
    • OpenIDM 3.0.0
    • OpenIDM 3.0.0
    • documentation
    • None
    • Sprint 21

    Description

      In this section of the doc:
      http://openidm.forgerock.org/doc/integrators-guide/index.html#rest-supported-operations

      We have examples like:

      Resources can be updated with a PUT request. Similar to create; however, an update must use the If-Match (not the If-None-Match ) header:
      PUT /managed/user/JDOE

      I don't see any reason to leave of classical example format with CURL. And if there is one, then it is a bit confusing here to say that we need some header but not show it in the example.

      Note that we should probably be aligned with what syntax is used in following sections of the REST appendix, like
      http://openidm.forgerock.org/doc/integrators-guide/index.html#rest-supported-methods

      So if we decide to stick with this syntax/layout we should, at least, put some (...) after the truncated example in the supported operations section (e.g. PUT without header and body)

      Attachments

        Activity

          People

            Lana Lana Frost
            laurent.bristiel Laurent Bristiel [X] (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: