Repository navigation
Establish service-to-service API standards - #865
Conversation
Deploying contributing-docs with
|
| Latest commit: |
bad08b9
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f849b200.contributing-docs.pages.dev |
| Branch Preview URL: | https://docs-adr-0036-internal-api-s.contributing-docs.pages.dev |
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
"Internal" already names the client-facing API everywhere else at Bitwarden: the server repo splits its OpenAPI into public and internal documents and serves the latter at specs/internal/swagger.json, and public-api.md on this site calls the same surface the private API. The scope paragraph here had to disclaim the title to say which "internal" it meant. Service-to-service is the term ADR-0035 rule 4 now gates on and the term this document already used for the relationship, so the gate and the standard match without a mapping. Scope is stated as a caller test — whose callers are other Bitwarden services — rather than a reachability test, matching rule 4. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Ranges was the only wire-grammar section with no RFC 2119 keyword, while Filtering, Multi-value parameters, Sorting and Sparse fieldsets are all MUST. The escape rule for commas is already normative against this syntax, so the syntax itself has to be citable in review. Same for the all-caps enum convention, which sat unmarked in a bullet that ends with a MUST. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
🤖 Bitwarden Claude Code ReviewOverall Assessment: APPROVE Documentation-only change adding ADR-0036, which now proposes only that service-to-service APIs |
Deferred until the acceptance phase.
Establish the internal API standards of a service-oriented architecture.