Skip to content

docs: document session sharing for 1.x (#562) - #657

Open
boxcee-interview wants to merge 1 commit into
kagent-dev:mainfrom
boxcee-interview:fix/issue-562
Open

boxcee-interview wants to merge 1 commit into
kagent-dev:mainfrom
boxcee-interview:fix/issue-562

Conversation

@boxcee-interview

Copy link
Copy Markdown
Contributor

Closes #562

Session sharing had no page in the 1.x docs, while the ttl field is referenced from "Controller identity" and "Operational considerations" on the assumption that one exists. This adds 1.x/agents/share-a-session.md (weight 60, after Human in the loop) covering the surface from the issue:

  • the capability model: a share is a token that acts with the owner's access, not a grant to a named user
  • READ_ONLY presented as a scope, with the insecure-mode caveat that it is not a security boundary in a default install
  • ttl, expiresAt, and the config.sessions.shareMaxTtl cap, including rejection of a ttl above the cap
  • spending a share via X-Share-Token, and revoking via RevokeSessionShare
  • no CLI verb: gRPC and UI only

The cap is linked to the existing pages rather than restated.

How to Test

# in docs-site/
hugo mod get ./...
hugo --config hugo.yaml,hugo.preview.yaml -D --gc --minify
# -> HUGO_EXIT=0, no new ERROR/WARN lines (the single WARN is the pre-existing
#    `.Site.Data was deprecated` notice)
ls public/kagent/1.x/agents/share-a-session/index.html
# -> page renders; glossary term "Session" resolves; both linked anchors
#    (operational-considerations#expire-idle-sessions,
#     about/substrate-runtime/identity#controller-authentication-modes) exist

Signed-off-by: Moritz Schmitz von Hülst <mschmitzvonhuelst@gmail.com>
@boxcee-interview

Copy link
Copy Markdown
Contributor Author

The deploy check failed in the Preview workflow: wrangler aborted with 'In a non-interactive environment, it's necessary to set a CLOUDFLARE_API_TOKEN environment variable' (job 122985167728). The change itself is a single docs markdown file, so the content/build checks all passed — this looks like a missing repo secret rather than something in the diff. A re-run (or restoring the secret) should clear it; no code change from me here.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document session sharing

1 participant