Repository navigation
Align api.md section 8 and add heartbeat throttle - #45
Merged
Merged
Conversation
A review of api.md sections 5 to 8 against the implementation found a stale table, a stale response example, and a throttle the doc promised for student heartbeats but the stack did not set.
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.
What changed
Found by checking every endpoint in api.md sections 5 to 8 against the code and the synthesized API Gateway config:
Why
The doc and code disagreed in five places. Frontend mocks are built from api.md, so it needs to match.
How to test
cd backend && npm test && npm run test:py(17 CDK tests, 74 Python tests).Remaining gap:
POST /student/hints(stretch) is not built.Stacked on #9.