docs(openapi): Idempotency-Key parameter on all 16 single-POST endpoints#98
Merged
Merged
Conversation
The middleware applies to every /v1/* POST, but the OpenAPI spec previously only documented the header on the bulk variants (via the bulkPath() helper). SDK code-generators reading the spec saw single-create POSTs as non-idempotent, even though clients could in fact send Idempotency-Key safely. 16 single-POST entries gain `parameters: [idempotencyKeyHeader]`: customer, timeentry, worker, billingtype, inventoryitem, company, job, invoice, customerpayment, invoicejob, productentry, versioninfo, purchaseordervendor, purchaseorderheader, purchaseorderline, inventorytransaction. We don't add a `409` response code on the single POSTs — the same-key-different-body case is rare enough that just documenting the request header is sufficient for code-gen. The bulk variants keep their 409 doc (bulkPath() helper, unchanged). Tests: new OpenAPI assertion (1 case, 16 expectations) pins the Idempotency-Key header is present on each single-POST. Full suite: 479 pass / 4 skip (was 478/4). Lint clean. 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.
Follow-up to #89.
Summary
/v1/*POST, but the OpenAPI spec only documented the header on bulk endpoints.parameters: [idempotencyKeyHeader]. Code-generators reading the spec can now produce SDK methods that accept the header on single creates too.Test plan
This code proudly made in Nebraska. GO BIG RED! 🌽 https://xkcd.com/2347/