Skip to content

Conversation

javirln
Copy link
Member

@javirln javirln commented Jun 17, 2025

This patch introduces several changes that enable the generation of OpenAPI specifications for selected services defined within Chainloop.

Key updates include:

  • Corrects the malformed buf.lock file, resolving failures encountered during buf dep update.
  • Removed deprecated GitHub action related to buf that unifies all actions into one.
  • Adds a generic openapi_metadata.proto file containing common specification information.
  • Annotates the ReferrerService and its dependent messages to expose their REST API specifications.
  • Updates the make api command to generate the OpenAPI specification, convert it from Swagger 2.0 to OpenAPI 3.0.1, and handle the resulting files.
  • Introduces a generic openapi-extra.yaml file, which includes definitions of API endpoints that are not covered by the proto service. The case of the DownloadService.
  • Introduces a shell script that adjusts the generated security schema, enabling proper execution of the OpenAPI specification in playground environments. This is necessary because Swagger 2.0 lacks support for the Bearer security type, which would otherwise prevent requests from functioning correctly.
  • Formats all proto files running buf format -w.

Signed-off-by: Javier Rodriguez <javier@chainloop.dev>
Signed-off-by: Javier Rodriguez <javier@chainloop.dev>
@javirln javirln self-assigned this Jun 18, 2025
Signed-off-by: Javier Rodriguez <javier@chainloop.dev>
@javirln javirln marked this pull request as ready for review June 18, 2025 09:17
@javirln javirln requested a review from jiparis June 18, 2025 09:25
@javirln javirln changed the title WIP chore(docs): Generate basic OpenAPI specification chore(docs): Generate basic OpenAPI specification Jun 18, 2025
Copy link
Member

@jiparis jiparis left a comment

Choose a reason for hiding this comment

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

Nice job!

javirln added 2 commits June 18, 2025 11:30
Signed-off-by: Javier Rodriguez <javier@chainloop.dev>
Signed-off-by: Javier Rodriguez <javier@chainloop.dev>
@javirln javirln merged commit 14c9c94 into chainloop-dev:main Jun 18, 2025
13 checks passed
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.

3 participants