chore(docs): Generate basic OpenAPI specification #2116
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch introduces several changes that enable the generation of OpenAPI specifications for selected services defined within Chainloop.
Key updates include:
buf.lock
file, resolving failures encountered during buf dep update.openapi_metadata.proto
file containing common specification information.make api
command to generate the OpenAPI specification, convert it from Swagger 2.0 to OpenAPI 3.0.1, and handle the resulting files.openapi-extra.yaml
file, which includes definitions of API endpoints that are not covered by the proto service. The case of theDownloadService
.buf format -w
.