Repository navigation
docs: Add ADR 0040 - API standards for request, response, and error payloads - #881
Draft
mike-gorman-bitwarden wants to merge 1 commit into
Draft
mike-gorman-bitwarden wants to merge 1 commit into
mike-gorman-bitwarden wants to merge 1 commit into
Conversation
…ayloads Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Oct 5, 2026
Deploying contributing-docs with
|
| Latest commit: |
efef2d3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://513f6060.contributing-docs.pages.dev |
| Branch Preview URL: | https://docs-adr-0040-api-payload-st.contributing-docs.pages.dev |
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.
🎟️ Tracking
Follow-up to ADR-0036 (#865).
📔 Objective
Adds ADR-0040, "API standards for request, response, and error payloads", with status Proposed. Sets what every request and response shares: the payload envelope (
data,meta, andid/type/attributeson every resource), standard fields, JSON value rules (dates, enumerations, whitespace, empty strings andnull), naming, content negotiation, method semantics, status codes, exhaustive request validation, and the error format, with the recorded departure from RFC 9457.