Repository navigation
docs(api): align specs, README and design records with server behavior - #1114
Merged
Merged
Conversation
OpenAPI: SurveyResponse status enum (x-go-type string keeps Go types), DELETE collaborate description, ClientCallbackQueryParam description, restore descriptions, and GET /api/server-info (generated route replaces the custom one). AsyncAPI: /ws/notifications channel and interim ErrorPayload note. Design records get as-built notes; x-tmi-authz-schema.md corrected; README storage/configuration/WebSocket sections rewritten; docs/survey-api-design.md deleted (wiki migration separate). Human decision (Eric, 2026-10-17): restore is owner-only; drop "or administrators" from the seven restore descriptions (option A). Fixes #1089 Fixes #1090 Fixes #1091 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Add subscription_updated to the AsyncAPI notification docs, add 400 and 503 to /api/server-info, collapse HandleServerInfo into GetServerInfo, refresh SEM markers, use the codebase term overridden in the README. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…iption Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015szS68rpMLaq712AFsbMfr
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015szS68rpMLaq712AFsbMfr
ericfitz
force-pushed
the
docs/1089-1091-doc-alignment
branch
from
October 18, 2026 04:02
ccc55dd to
7ca35f0
Compare
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.
Summary
x-go-type: stringkeeps the Go types)GET /api/server-infois documented with 400 and 503; the generated route replaces the hand-written one/ws/notificationschannel, includingsubscription_updated..claude/CLAUDE.md: Store[T] reference fixed.x-tmi-authz-schema.mdcorrected; the staledocs/survey-api-design.mdis deleted; key fixed inscripts/analyze-endpoints.py.Test plan
make validate-openapi,make validate-asyncapi,make generate-api; the embedded spec matchesmake verifyFixes #1089
Fixes #1090
Fixes #1091
🤖 Generated with Claude Code
https://claude.ai/code/session_015szS68rpMLaq712AFsbMfr