feat(api): oasdiff OpenAI openAPI spec against ours (#3529)

Browse source

# What does this PR do?

diff the `/v1/` routes that are OpenAI compatible against the OpenAI
openAPI spec. This will of course only trigger on PRs where the spec is
changed.

This will catch errors with new handwritten additions to our openAI
compat routes.

Instead of fetching the OpenAPI spec from a dynamic URL, which could
cause non-deterministic build failures,

this change uses a local copy stored at `docs/static/openai-spec.yml`.

This makes the conformance check fully reproducible and prevents CI
failures caused by uncontrolled upstream changes.

I am marking this test with `continue-on-error: true`, until we get rid
of all of the errors. Nevertheless, this is a nice utility to have so
folks know if their spec changes introduce more breaking changes or fix
breakages when comparing to the OpenAI openapi spec.

## Test Plan

test should pass.

Signed-off-by: Charlie Doern <cdoern@redhat.com>

...

This commit is contained in:

Charlie Doern 2025-12-01 18:27:08 -05:00 • committed by GitHub

parent 89807dc117

commit aaecd0327c

No known key found for this signature in database

GPG key ID: B5690EEEBB952194

3 changed files with 66760 additions and 0 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

66741

docs/static/openai-spec-2.3.0.yml vendored Normal file

View file

File diff suppressed because it is too large Load diff