8000 apitypes: openapi spec by hdonnay · Pull Request #2308 · quay/clair · GitHub
[go: up one dir, main page]
Skip to content

apitypes: openapi spec #2308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

apitypes: openapi spec #2308

wants to merge 3 commits into from

Conversation

hdonnay
Copy link
Member
@hdonnay hdonnay commented Sep 26, 2025

This series (split from #2266) adds JSON Schema documents for all the types exposed in the HTTP API and adds a way to generate the OpenAPI specification from those, a jq script, and some other loose files.

TODO

  • Write+check all the "description" members for the JSON Schema documents.
  • Write+check all the "description" members for the OpenAPI document.
  • Check the generated API reference (./Documentation/reference/api.md) is at least as-useful as it was.

Coming later in series:

  • Cross-check and adjust the API implementation.
  • Implement the JSON marshaling and unmarshaling and check against the relevant JSON Schema.

@hdonnay
types/v1: add JSON API v1 types and schemas
6344749 
Signed-off-by: Hank Donnay <hdonnay@redhat.com>
@hdonnay hdonnay requested review from crozzy and BradLugo September 26, 2025 19:10
@hdonnay
Copy link
Member Author
hdonnay commented Sep 26, 2025

@crozzy @BradLugo RFC: I currently have the go generate work driven by a shell script written in zsh. Is that super annoying? I suppose I could port it to a go script.

@hdonnay
openapi: rebuild OpenAPI spec
d12da47 
Signed-off-by: Hank Donnay <hdonnay@redhat.com>
@hdonnay
misc: remove API doc make target, CI check
38723ef 
Creating this file is now handled by the same script that generates the
OpenAPI doc, so being able to build it independently and needing to
check it for drift don't make a ton of sense.

Signed-off-by: Hank Donnay <hdonnay@redhat.com>
@hdonnay hdonnay force-pushed the hack/apitypes/openapi branch from e22f298 to 38723ef Compare September 26, 2025 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@crozzy crozzy Awaiting requested review from crozzy

@BradLugo BradLugo Awaiting requested review from BradLugo

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@hdonnay
0