Uploaded image for project: 'Active and Available Inventory'
  1. Active and Available Inventory
  2. AAI-2417

Examples API for AAI Traversal custom query API

XMLWordPrintable

      Related to documentation of Traversal custom query in AAI-2408 and swagger-generated REST API documentation, it would be useful to have an "examples" API that would generate the suitable request bodies with the expected/necessary parameters.

      This is similar to the Resources "examples" API that shows the schema of the object classes.

      In this case, the output could include one example of each stored-query in the system, showing the appropriate values for:

      • format query parameter
      • start URL
      • query name with required query parameters

      It would also be good if the format query parameter could be moved into the request body as well.

            jimmydot jimmydot
            keong keong
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: