docs(openapi): declare GET /v1/customer/bycompany/{id} 200 envelope (#340)#341
Merged
CryptoJones merged 1 commit intoMay 19, 2026
Merged
Conversation
Same missing-content-schema pattern fixed for /v1/customer/{id}
in #312, POST /v1/customer in #316, POST /v1/timeentry in #326,
and POST /v1/customer/bulk in #332 — now for the paginated list
endpoint. The spec previously said only `description: 'OK'`, so
SDK generators reading the spec couldn't model the
Link-header-paired pagination envelope the controller emits:
{ message, count, limit, offset, customers: Customer[] }
Declare the shape and pin it with a test in
`tests/api/openapi.test.js`.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Closes #340.
Summary
Same missing-content-schema fix pattern as #312, #316, #326, #332 — now for the paginated list endpoint. Declare
{message, count, limit, offset, customers: Customer[]}and pin with a test.Test plan
npm run lint && npm test— 788 passing (was 787).Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/