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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

apitypes: openapi spec #2308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a2fb6f
types/v1: add JSON API v1 types and schemas
hdonnay Sep 3, 2025
d815883
openapi: rebuild OpenAPI spec
hdonnay Sep 15, 2025
6110f81
misc: remove API doc make target, CI check
hdonnay Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
cmd/build.go export-subst
*.go diff=golang
Documentation/reference/api.md linguist-generated
5 changes: 0 additions & 5 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,6 @@ jobs:
printf '::error file=%s,title=Bad Filename::Disallowed character in file name\n' "$file"
done
exit $(git ls-files -- ':/:*[<>:"|?*]*' | wc -l)
- name: Check API Reference
if: ${{ !cancelled() && steps.checkout.conclusion == 'success' }}
run: |
npx widdershins --search false --language_tabs 'python:Python' 'go:Golang' 'javascript:Javascript' --summary ./openapi.yaml -o ./Documentation/reference/api.md
git diff --exit-code
- name: Check Container Versions
if: ${{ !cancelled() && steps.checkout.conclusion == 'success' }}
run: |
Expand Down
4 changes: 3 additions & 1 deletion Documentation/howto/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API Definition

Clair provides its API definition via an OpenAPI specification. You can view our OpenAPI spec [here](https://raw.githubusercontent.com/quay/clair/main/openapi.yaml)
Clair provides its API definition via an OpenAPI specification. You can view our OpenAPI spec [here][openapi_v1].

The OpenAPI spec can be used in a variety of ways.
* Generating http clients for your application
Expand All @@ -11,3 +11,5 @@ The OpenAPI spec can be used in a variety of ways.
See [Testing Clair](./testing.md) to learn how the local dev tooling starts a local swagger editor. This is handy for making changes to the spec in real time.

See [API Reference](../reference/api.md) for a markdown rendered API reference.

[openapi_v1]: https://github.com/quay/clair/tree/main/httptransport/api/v1
Loading
Loading