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

API documentation on image builder is outdated/incorrect

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Normal Normal
    • None
    • None
    • None
    • Platform Pipeline Sprint 84

      The API documentation on https://developers.redhat.com/api-catalog/api/image-builder is outdated and/or incorrect.

      If you look at e.g. the customizations section, you will see there are only 5 options: https://developers.redhat.com/api-catalog/api/image-builder#schema-Customizations

      If you look into a generated representation of our API schema from redoc, you will see there are many more: https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/osbuild/image-builder/main/internal/v1/api.yaml#tag/compose/operation/composeImage

      Here's a link to our API schema in our source code.

      https://github.com/osbuild/image-builder/blob/main/internal/v1/api.yaml

       

      Is something set up incorrectly or is this updated manually maybe? Are we doing something wrong? Thanks!

              gmccullo@redhat.com Greg McCullough
              ssteinbe@redhat.com Simon Steinbeiss
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Created:
                Updated:
                Resolved: