Uploaded image for project: 'OpenAM'
  1. OpenAM
  2. OPENAM-16601

AM API explorer: missing descriptor for the /users endpoint

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Won't Do
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: API descriptor
    • Labels:
      None

      Description

      Hello,

      In the AM API explorer, if we select the root of the /users endpoint tree, we get a message saying that there is no descriptor for it:

      No operations defined in spec!

      Whereas, in the AM development guide https://backstage.forgerock.com/docs/am/6.5/dev-guide/#about-crest-api-descriptors, we can see that it has been picked for illustrating the _action parameters, for example:

      POST /users?_action=create HTTP/1.1
       Host: example.com
       Accept: application/json
       Content-Length: ...
       Content-Type: application/json
       { JSON resource }

      It would be good to align both API Explorer and documentation, by adding a descriptor for the /users endpoint in the AM API explorer.

      Cheers

      Julien

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              julien.chausse Julien Chausse
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: