Skip to content

Request: openapi.yaml - Publish a pre-bundled YAML file #523

@j-westover

Description

@j-westover

The current openapi.yaml uses external $refs to hundreds of files at http://redfish.dmtf.org/schemas/v1/*.yaml. Every consumer must:

  1. Fetch hundreds of external schema files over HTTP during bundling
  2. Handle transitive ref chains (wrapper files → versioned files → sibling schemas)
  3. Work around bundler differences in how cross-file local $refs are resolved

Different bundling tools produce different results. This forces consumers to implement workarounds for their specific toolchain.

Proposal

Publish an openapi_bundled.yaml (or .json) alongside openapi.yaml in the Redfish-Publications repository with all external $refs resolved to internal #/components/schemas/ references.

This is a one-time addition to the build pipeline — likely a single redocly bundle command or equivalent — and would:

  • Eliminate HTTP fetching during consumer builds
  • Remove all bundler-specific edge cases
  • Provide a single canonical bundled representation
  • Make the spec immediately usable by any OpenAPI tool without preprocessing

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions