Repository navigation
[Automated] Draft docs (kagent): feat(session): let a session share expire - #582
Open
github-actions[bot] wants to merge 1 commit into
Open
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…xpire Signed-off-by: GitHub Action <action@github.com>
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.
kagent-dev/kagent#2987 — feat(session): let a session share expire
Docs versions:
1.x(first shipped in v1.0.0-alpha8)What changes for users: Clients can set
CreateSessionShareRequest.ttlto bound how long a Session share token grants access, and operators can cap requested lifetimes withcontroller.sessionShareMaxTTL. The default cap is0, so a share created withoutttlremains unbounded as before. An expired token is treated as not found, while the owner can still list and revoke the expired share.What the docs now say: The Identity page now explains
CreateSessionShareRequest.ttl,SessionShare.expiresAt, expired-token behavior, and the operator cap. Operational considerations now listscontroller.sessionShareMaxTTL, including the default, cap behavior, and rejected values.Not verified: No cluster; the configuration and API calls are unrun.
How
kagent-2987was drafted, and what was not verifiedPlan, and what changed it
controller.sessionShareMaxTTLandKAGENT_SESSION_SHARE_MAX_TTL, while the existing share semantics live onabout/substrate-runtime/identity.md.Why a documentation change is necessary
The pull request adds
CreateSessionShareRequest.ttl,SessionShare.expiresAt, and thecontroller.sessionShareMaxTTLHelm value. The Identity page already explains Session shares and revocation, but it did not describe expiring tokens or the returned expiry field. The operational page already explains Session retention settings, so it is the prose page where an operator can learn how to cap share lifetimes.What changed on disk
docs-site/content/kagent/1.x/about/substrate-runtime/identity.md: Added share TTL,expiresAt, expired-token behavior, and a link to the operator cap.docs-site/content/kagent/1.x/operations/operational-considerations.md: Addedcontroller.sessionShareMaxTTLto the Session expiration settings table.How to verify this change
controller.sessionShareMaxTTLset to72h.SessionService.CreateSessionShareto create a share withoutttl; the response includesshare.expiresAtabout 72 hours after creation.ttllonger than72h; the request fails withInvalidArgumentand says that the share TTL must not exceed72h.expiresAt; presenting the token returns not found, whileListSessionSharesstill includes the share for the owner.Proposed release note
Wrote
proposed-release-note.mdfor this feature.What was not verified
The configuration was not applied to a cluster, so every command and API call in this diff is unrun.
How the pages were chosen (triage report)
Draft a documentation change
kagent-dev/kagent#2987 — feat(session): let a session share expire
kagent-dev/websiteCreateSessionShareRequesttakes no lifetime, andGetSessionShareByTokenHashchecks nothing but the hash and the session's state. A client that keeps one share per conversation, for the people the owner lets in, has no way to bound it once the conversation is abandoned. AREAD_WRITEshare can also renadocs/env.mdgo/api/gen/kagent/api/v1alpha1/sessions.pb.gogo/core/internal/grpcserver/session.gogo/core/internal/service/session/service.gogo/core/pkg/app/app.gogo/core/pkg/env/session.goDraft branch:
pr-tracker-draft-kagent-2987Important
The test suite has not run on this pull request. It was opened by
github-actions[bot], and GitHub does not start workflows for pull requests opened with the repository's own token. This repository's checks are held asaction_requireduntil somebody presses Approve and run on the Checks tab. Checks that come from GitHub Apps rather than Actions, such as DCO, run on their own.Please approve the checks before reviewing the content: an absence of failures here means the tests have not run, not that they passed.