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

Extract the full list of REST API Descriptors without installing the product

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: 6.5.3
    • Fix Version/s: None
    • Component/s: API descriptor
    • Labels:
    • Rank:
      1|i042fk:
    • Support Ticket IDs:

      Description

      Currently, there is no way to retrieve all REST API documentation, at once, without the need to install the product. None of the links we have on the topic, have the REST API documented in full: 

      https://backstage.forgerock.com/docs/am/6.5/apidocs/index.html 

      https://backstage.forgerock.com/docs/am/6.5/dev-guide/#use-openapi-descriptors 

      https://backstage.forgerock.com/docs/am/6.5/dev-guide/#about-crest-api-descriptors 

      It may be possible to read the descriptors, however, this only works per single endpoint and is therefore cumbersome and time-consuming: 

      curl -o myapi.json http://127.0.0.1:8080/openam/json/users/demo/services/dashboard?_api

       

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            alex.belovski Alex Belovski
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated: