Repository navigation
Document shared API keys and repeater rollout - #37
Merged
Merged
Conversation
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.
The API docs still describe zones, boundaries, scopes and channels as anonymous APIs with once-per-target IP limits. Update them for the server v1.5.117 shared-key contract.
Add an API Keys and Access page covering reuse of Coverage keys, self-service group keys, endpoint permissions, custom GLOBAL access, header examples, separate read quotas, errors, private caching and the delayed repeater switch after app 1.4.1. Update all four existing API pages and navigation, including Coverage header support and cache guidance.
The rollout note explicitly distinguishes the released contract from deployment status. Existing keys and legacy Coverage URLs remain supported. Repeater enforcement is not described as already enabled.
Validation: mkdocs build --strict passes. API contract checked against MeshMapper_Server api_read_auth.php, coverage.php and the rollout guide.
Related rollout: MeshMapper/MeshMapper_Server#431.