Add documentation for activity.kind policy enum#718
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
| } | ||
| ``` | ||
|
|
||
| #### Allow a specific user to perform a specific activity kind (full list [here](/features/policies/language#activity-kinds)) |
There was a problem hiding this comment.
I think it's worth mentioning guidance on this vs. resource + action as well -- lots of ways to skin the cat now (each nuanced)
|
|
||
| <Note> ** Legacy features, deprecated in the latest SDKs. </Note> | ||
|
|
||
| ### Activity kinds |
There was a problem hiding this comment.
This is an area that needs to be updated with every activity update. I think we need something on the process side, particularly in mono, that flags that this exists and to not neglect it. I'd recommend updating the mono PR description, updating its AGENTS.md file(s), creating a Valet skill, or some combination of these.
There was a problem hiding this comment.
Pull request overview
Adds documentation for the policy language’s activity.kind field, intended to provide a version-agnostic way to match activities across type versions.
Changes:
- Document
activity.kindalongsideactivity.typein the policy language struct/type reference. - Add an “Activity kinds” section with a kind → activity type mapping table and guidance to prefer
kindfor forward compatibility. - Add new access-control policy examples demonstrating
activity.kindusage.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| features/policies/language.mdx | Adds activity.kind field docs and a new “Activity kinds” mapping section. |
| features/policies/examples/access-control.mdx | Adds example policies using activity.kind for version-agnostic matching. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -314,6 +315,113 @@ The language is strongly typed which makes policies easy to author and maintain. | |||
|
|
|||
| <Note> ** Legacy features, deprecated in the latest SDKs. </Note> | |||
| | POST_TVC_QUORUM_KEY_SHARE | ACTIVITY_TYPE_POST_TVC_QUORUM_KEY_SHARE | | ||
|
|
PR adds documentation for
activity.kindin the policy engine. This namespace is a grouping on activities of the same type across versions.