feat: add openapi specification generation#69
Merged
Lakes41 merged 7 commits intoJun 28, 2026
Conversation
Lakes41
approved these changes
Jun 28, 2026
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I have successfully completed your request to generate and publish an
OpenAPI JSON artifact for the Access API.
Here is a summary of the changes I made:
) that builds the Fastify app, reads the Swagger spec using
@fastify/swagger , and writes the JSON spec to docs/openapi.json at the
root of the repository.
openapi.ts" ) inside apps/access-api/package.json to make it easy to run.
wallet parameter from request.body wasn't perfectly typed as
0x${string} for your service types, which was blocking the spec generation
with ts-node .
GitHub action will automatically run the generator in CI and check if
docs/openapi.json is modified. If it is modified or out of date, the CI
build will fail, ensuring developers commit their updated specs.
instructions under "OpenAPI Specification" that contributors can follow to
regenerate it after modifying API routes.
feature/generate-openapi-spec .
closes #49