Skip to content

docs: Add ADR 0041 - API standards for contracts and their evolution - #882

Closed
mike-gorman-bitwarden wants to merge 1 commit into
mainfrom
docs/adr-0041-api-contract-standards
Closed

mike-gorman-bitwarden wants to merge 1 commit into
mainfrom
docs/adr-0041-api-contract-standards

Conversation

@mike-gorman-bitwarden

@mike-gorman-bitwarden mike-gorman-bitwarden commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

🎟️ Tracking

Follow-up to ADR-0036 (#865).

📔 Objective

Adds ADR-0041, "API standards for contracts and their evolution", with status Proposed. Sets how contracts are described and evolve: OpenAPI and operation IDs, path structure (including keeping request scope out of paths), breaking changes and path versioning, how unrecognized fields, parameters, and headers are handled, and deprecation with the Deprecation, Sunset, and Link headers.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5f25257
Status: ✅  Deploy successful!
Preview URL: https://7790d074.contributing-docs.pages.dev
Branch Preview URL: https://docs-adr-0041-api-contract-s.contributing-docs.pages.dev

View logs

@mike-gorman-bitwarden
mike-gorman-bitwarden marked this pull request as ready for review October 14, 2026 09:10
@mike-gorman-bitwarden
mike-gorman-bitwarden requested a review from a team as a code owner October 14, 2026 09:10
@github-actions

github-actions Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

🤖 Bitwarden Claude Code Review

Overall Assessment: APPROVE

This review covers the new ADR docs/architecture/adr/0041-api-contract-standards.md (status Proposed). The ADR sets standards for OpenAPI descriptions, path structure and request scope, breaking changes and path versioning, how unrecognized input is handled, and deprecation headers. Its frontmatter, the AdrTable include, and its MADR structure follow the existing ADRs, and the example deprecation header values are valid. There is one open question: the document cites ADR-0039 and ADR-0043, and neither exists on main yet.

Code Review Details
  • ❓ : Cites ADR-0039 and ADR-0043, which are not on main yet, and relies on parameter conventions they presumably define
    • docs/architecture/adr/0041-api-contract-standards.md:22

Comment thread docs/architecture/adr/0041-api-contract-standards.md
@mike-gorman-bitwarden

Copy link
Copy Markdown
Contributor Author

This PR is superseded by #894. We have done our best to retain/incorporate all feedback received to date.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant