Skip to content

docs(config): update schema and documentation to use auth_token for authorization#41

Merged
adcondev merged 1 commit intomasterfrom
feat/login
Feb 23, 2026
Merged

docs(config): update schema and documentation to use auth_token for authorization#41
adcondev merged 1 commit intomasterfrom
feat/login

Conversation

@adcondev
Copy link
Owner

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:

  • Expanded the SCALE_WEBSOCKET_V1.md documentation with a new index, clearer sectioning, and additional details about endpoints and message types.
  • Updated the config message structure to require an auth_token field for authentication when security is enabled, including an example and updated field descriptions. [1] [2]
  • Added a new section describing structured error codes for control and configuration operations, including details about authentication errors and rate limiting.

Schema alignment:

  • Updated the JSON schema in scale_websocket.schema.json to rename the required field from authToken to auth_token to match the documentation and implementation.

…uthorization

Signed-off-by: Adrián Constante <ad_con.reload@proton.me>
@adcondev adcondev merged commit f5fe427 into master Feb 23, 2026
@adcondev adcondev deleted the feat/login branch February 23, 2026 20:56
@github-actions
Copy link

⚡ Benchmark Results

⚠️ No benchmarks found in the current codebase.

To add benchmarks, create functions starting with Benchmark in *_test.go files.

@adcondev adcondev restored the feat/login branch February 23, 2026 21:01
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants