Uploaded image for project: 'REST Client'
  1. REST Client
  2. MGNLRESTCL-91

Cannot target a path with no operationId defined in an OpenAPI v3 schema

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • Neutral
    • 2.0
    • None
    • None
    • None

    Description

      When creating a simple example to showcase an OpenAPI v3 rest call, I've found no way to retrieve data for just an endpoint path. See this spec:

               "/action/status_show": {
                  "get": {
                      "summary": "Get the site status",
                      "description": "Returns the site status",
                      "tags": [
                          "action"
                      ],
                      "responses": {
                          "200": {
                              "description": "Returns the site status, version, installed extensions"
                          }
                      }
                  }
              },
      

      The full OpenAPI v3 schema url is:

      https://raw.githubusercontent.com/bcgov/api-specs/master/bcdc/bcdc.json

      I think it should be possible with some placeholder for "/action/status_show" in the FTL:

      #assign bcResponse = restfn.call("bcdc", "/action/status_show")

      but currently we use something like OperationId to reference the :

      https://git.magnolia-cms.com/projects/MODULES/repos/rest-client/browse/magnolia-rest-client/src/main/java/info/magnolia/openapi/client/factory/OpenApiClientFactory.java#128

      which is not defined in the bcdc example schema.

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                jfranco Jorge Franco
                mdrapela Martin Drápela
                Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Bug DoR
                    Task DoD

                    Time Tracking

                      Estimated:
                      Original Estimate - Not Specified
                      Not Specified
                      Remaining:
                      Remaining Estimate - 0d
                      0d
                      Logged:
                      Time Spent - 7.5h
                      7.5h