docs(config): update schema and documentation to use auth_token for authorization#41
Merged
docs(config): update schema and documentation to use auth_token for authorization#41
Conversation
…uthorization Signed-off-by: Adrián Constante <ad_con.reload@proton.me>
⚡ Benchmark ResultsTo add benchmarks, create functions starting with |
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
This pull request updates the documentation and schema for the Scale Daemon WebSocket API v1.0 to improve clarity and add security-related details. The main changes include expanding the documentation structure, specifying authentication requirements for configuration updates, and updating the schema to match the new field names.
Documentation improvements and security updates:
SCALE_WEBSOCKET_V1.mddocumentation with a new index, clearer sectioning, and additional details about endpoints and message types.configmessage structure to require anauth_tokenfield for authentication when security is enabled, including an example and updated field descriptions. [1] [2]Schema alignment:
scale_websocket.schema.jsonto rename the required field fromauthTokentoauth_tokento match the documentation and implementation.