Skip to content

Establish service-to-service API standards - #865

Merged
mike-gorman-bitwarden merged 25 commits into
mainfrom
docs/adr-0036-internal-api-standards
Sep 24, 2026
Merged

mike-gorman-bitwarden merged 25 commits into
mainfrom
docs/adr-0036-internal-api-standards

Conversation

@mike-gorman-bitwarden

@mike-gorman-bitwarden mike-gorman-bitwarden commented Sep 15, 2026 •

Copy link
Copy Markdown
Contributor

Establish the internal API standards of a service-oriented architecture.

@mike-gorman-bitwarden mike-gorman-bitwarden added the ai-review Request a Claude code review label Sep 15, 2026
@github-actions github-actions Bot added the adr label Sep 15, 2026
@mike-gorman-bitwarden mike-gorman-bitwarden changed the title docs: add ADR 0036, internal API standards Establish internal API standards Sep 15, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 15, 2026 •

Copy link
Copy Markdown

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

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

View logs

Comment thread docs/architecture/server/service-to-service-api-standards.md Outdated
Comment thread docs/architecture/server/service-to-service-api-standards.md Outdated
Comment thread docs/architecture/server/service-to-service-api-standards.md Outdated
Comment thread docs/architecture/server/service-to-service-api-standards.md Outdated
Comment thread docs/architecture/server/internal-api-standards.md Outdated
Comment thread docs/architecture/adr/0036-internal-api-standards.md Outdated
Comment thread docs/architecture/adr/0036-service-to-service-api-standards.md Outdated
Comment thread docs/architecture/adr/0036-internal-api-standards.md Outdated
Comment thread docs/architecture/server/service-to-service-api-standards.md Outdated
Comment thread docs/architecture/server/service-to-service-api-standards.md Outdated
Comment thread docs/architecture/server/internal-api-standards.md Outdated
Comment thread docs/architecture/server/service-to-service-api-standards.md Outdated
Comment thread docs/architecture/server/internal-api-standards.md Outdated
Comment thread docs/architecture/server/service-to-service-api-standards.md Outdated
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Comment thread docs/architecture/server/internal-api-standards.md Outdated
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>
Comment thread docs/architecture/server/service-to-service-api-standards.md Outdated
Comment thread docs/architecture/server/service-to-service-api-standards.md Outdated
Comment thread docs/architecture/server/service-to-service-api-standards.md Outdated
"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>
@mike-gorman-bitwarden mike-gorman-bitwarden changed the title Establish internal API standards Establish service-to-service API standards Sep 22, 2026
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>
Comment thread docs/architecture/server/service-to-service-api-standards.md Outdated
Comment thread docs/architecture/adr/0036-service-to-service-api-standards.md Outdated
Comment thread docs/architecture/adr/0036-service-to-service-api-standards.md Outdated
Comment thread docs/architecture/server/service-to-service-api-standards.md Outdated
Comment thread docs/architecture/adr/0036-service-to-service-api-standards.md Outdated
Comment thread docs/architecture/adr/0036-service-to-service-api-standards.md
@bitwarden bitwarden deleted a comment from github-actions Bot Sep 24, 2026
@github-actions

github-actions Bot commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

🤖 Bitwarden Claude Code Review

Overall Assessment: APPROVE

Documentation-only change adding ADR-0036, which now proposes only that service-to-service APIs
conform to a documented set of standards, plus one custom-words.txt entry (fieldsets) for the
new prose. Reviewed the ADR at HEAD against the MADR template on the ADR index: frontmatter,
heading, AdrTable, considered options with pros/cons, decision outcome, consequences, and plan
are all present and consistent with ADR-0035. The earlier critical finding is resolved — no
reference to the removed docs/architecture/server/service-to-service-api-standards.md remains
anywhere in the repository, so the site's onBrokenLinks: "throw" build is no longer at risk, and
the only relative link (./0035-service-oriented-architecture.md) resolves. No lines exceed the
100-column prettier width, and the new dictionary word is placed in correct case-insensitive
order and is still used by the document.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adr ai-review Request a Claude code review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants