Uploaded image for project: 'Hybrid Cloud Console'
  1. Hybrid Cloud Console
  2. RHCLOUD-31601

[API Catalog] Add support for a URL Prefix property to API Catalog definition file

XMLWordPrintable

    • Platform Pipeline Sprint 85, Platform Pipeline Sprint 86, Platform Pipeline Sprint 87

      Many OpenAPI specs include a server property that does not include a fully qualified URL path to the spec.

      Example from https://console.redhat.com/api/system-baseline/v1/openapi.json

      servers: [
        {
          url: "/api/system-baseline/v1"
        }
      ] 

      (See others APIs defined in RHINENG-2768)

       

      Other APIs define a the full URL (https://console.redhat.com/api/ingress/v1/openapi.json)

      [
        {
          url: "https://cloud.redhat.com/api/ingress/v1",description: "Production"
        }
      ] 

      or https://console.redhat.com/api/compliance/v1/openapi.json

      [
        {
          url: "https://{defaultHost}/api/compliance",
          variables: {
          defaultHost: {
            default: "console.redhat.com"
            }
          }
        },
        {
          url: "https://{defaultHost}/api/compliance/v1",
          variables: {
          defaultHost: {
            default: "console.redhat.com"
            }
          }
        }
      ]

       

      Goal: Provide a property in the API Catalog definition file (Discovery.yml) that allows an override of the URL for the example code section.

        1. image-2024-03-22-15-28-59-397.png
          27 kB
          Greg McCullough
        2. Screenshot from 2024-04-22 19-41-41.png
          29 kB
          Dalia Cervantes

              rh-ee-dcervant Dalia Cervantes
              gmccullo@redhat.com Greg McCullough
              Votes:
              0 Vote for this issue
              Watchers:
              10 Start watching this issue

                Created:
                Updated:
                Resolved: