Add OpenAPI examples for apis#854
Merged
greatest0fallt1me merged 1 commit intoJul 27, 2026
Merged
Conversation
|
@Emoji-dot Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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.
close #643
Implemented the API marketplace OpenAPI example work and kept it scoped to spec/docs plus a focused regression test. The updated files are the OpenAPI spec, the new API OpenAPI example test, and the contract testing note.
What changed
Added request/response examples for GET /api/apis
Added request/response examples for POST /api/apis
Added response examples for GET /api/apis/{id}
Added request/response examples for POST /api/apis/{id}/endpoints/bulk
Documented that API marketplace OpenAPI examples now have regression coverage
There are no runtime API behavior changes here. This is a documentation/spec improvement only.
Checks
npm run test:serial -- src/routes/apis.openapi.test.ts passed
npx eslint 'src/routes/apis.openapi.test.ts' passed
Note
When I ran a broader OpenAPI example suite earlier, an existing unrelated failure showed up in src/routes/billing.openapi.test.ts because the billing spec is missing a 429 example. I did not change that endpoint as part of this task.
Review note
Everything requested here is implemented except Code review approved, which is an external workflow step rather than something I can complete inside the repo.