fix(docs): separate SDK routes from dashboard routes in API reference#38
Merged
Conversation
P2-15: Clarify authentication split between SDK/CLI routes (/v1/sdk/* with X-Capiscio-Registry-Key) and dashboard routes (/v1/* with Clerk JWT). Changes: - reference/server/index.md: Split endpoint table into SDK, Dashboard, and Public sections - reference/server/badge-ca.md: Fix IAL-0 to show Clerk auth, IAL-1 to use /v1/sdk/ paths - getting-started/complete-workflow.md: Use /v1/sdk/agents for registration, CLI for badge request
✅ Documentation Build SuccessfulThe documentation build completed successfully and passed validation checks.
|
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
Clarify the authentication split between SDK/CLI routes and dashboard routes in the server API reference documentation.
Documentation Audit Reference
Phase: P2-15
Severity: Medium
Changes
docs/reference/server/index.md: Split endpoint summary into SDK, Dashboard, and Public route groups with correct auth methodsdocs/reference/server/badge-ca.md: Fix IAL-0 example to show Clerk JWT (dashboard auth), fix IAL-1 examples to use/v1/sdk/pathsdocs/getting-started/complete-workflow.md: Use/v1/sdk/agentsfor agent registration, replace raw curl badge request with CLI commandVerification
mkdocs build --strictpassescapiscio-server/internal/api/router.go