Skip to content

Fix OpenAPI schema#1008

Merged
stv0g merged 4 commits intomasterfrom
fix-oas
Mar 25, 2026
Merged

Fix OpenAPI schema#1008
stv0g merged 4 commits intomasterfrom
fix-oas

Conversation

@pjungkamp
Copy link
Contributor

I've noticed several smaller issues with our doc/openapi schema.

  1. We were using OpenAPI 3.0.3, which isn't fully JSON Schema draft v7 compatible. I've updated our schema to 3.1.0.
  2. The doc/package.json and doc/package-lock.json bit-rotted away. I did some basic maintenance.
  3. We didn't even try to test/lint our schema in CI. I've added a redocly lint call to our build:openapi CI and fixed or suppressed all errors to make it pass.

Open Questions

  • I've disabled the security-defined redocly lint... we don't have any security on our API...
  • I've also disabled the lint flagging the servers list in doc/openapi/openapi.yaml for using localhost. Is that list still correct? I can't access the k8s endpoint from the open internet... is there a public endpoint?
  • Should we update and maintain the doc/package.json, or remove it entirely? It is useful for local development on the schema.
  • Should the doc/package-lock.json really be committed into our repository?

Signed-off-by: Philipp Jungkamp <philipp.jungkamp@rwth-aachen.de>
Signed-off-by: Philipp Jungkamp <philipp.jungkamp@rwth-aachen.de>
Signed-off-by: Philipp Jungkamp <philipp.jungkamp@rwth-aachen.de>
Signed-off-by: Philipp Jungkamp <philipp.jungkamp@rwth-aachen.de>
Copy link
Contributor

@stv0g stv0g left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great :) Thanks a lot!

@stv0g stv0g merged commit eb5ebfa into master Mar 25, 2026
3 checks passed
@stv0g stv0g deleted the fix-oas branch March 25, 2026 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants