Repository navigation
Design 0006: APIs follow the AEPs - #66
Merged
Merged
Conversation
Refs #64 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues block the proposed API standards documentation.
No open issues 🎉
What changed in this PR
Adds proposed design 0006 to establish shared API standards before swimblocks/fetch-service becomes the first API called by other SwimBlocks repositories.
Changes:
- Adopts AEP guidance, with stable-edition rules and documented reasons for deviations.
- Prefers protobuf-first definitions and requires OpenAPI 3.1 publication for HTTP APIs, plus pinned CI linters.
- Defines versioning, errors, authentication and explicit API-definition review, with rollout tracked in #64.
| File | Description |
|---|---|
docs/design/README.md |
Adds design 0006 to the index as proposed. |
docs/design/0006-aep-apis.md |
Documents API standards, review requirements and staged rollout. |
Review effort: Balanced
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
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.
Refs #64 (the issue tracks the rollout this record describes, so it stays open after this merges)
What & why
Adds design 0006.
swimblocks/fetch-servicewill be the first SwimBlocks API that other repos call, so the design rules are settled before it's written: APIs follow the AEPs./v1/path prefixswimblocks.<api>.v<N>Testing
Design record only. Reviewed in crit: 6 comments, all addressed.
Checklist
ruff check .clean (n/a, docs only)🤖 Generated with Claude Code