feat: update generalAccess docs #2127
Conversation
github-actions
bot
added
the
t-core-services
| generalAccess: | ||
| type: string | ||
| enum: | ||
| - RESTRICTED | ||
| - ANYONE_WITH_ID_CAN_READ | ||
| - FOLLOW_USER_SETTING | ||
| example: RESTRICTED |
There was a problem hiding this comment.
I believe that this enum could be extracted into the components and referenced here.
There was a problem hiding this comment.
Good point, refactored 👍
|
Preview for this PR was built for commit |
stepskop
left a comment
stepskop
left a comment
There was a problem hiding this comment.
Agree with Honza here. Besides that, good 👍
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
| summary: Update status message | ||
| summary: Update run | ||
| description: | | ||
| This endpoint can be used both to update the run’s status message and to configure its general resource access level. |
There was a problem hiding this comment.
| This endpoint can be used both to update the run’s status message and to configure its general resource access level. | |
| This endpoint can be used to update both the run’s status message and to configure its general resource access level. |
| Allowed values: | ||
| * `FOLLOW_USER_SETTING` - The run inherits the general access setting from the account-level. |
There was a problem hiding this comment.
Either "account level" or "account-level permissions/settings/whatever".
| * `FOLLOW_USER_SETTING` - The run inherits the general access setting from the account-level. | ||
| * `ANYONE_WITH_ID_CAN_READ` - The run can be viewed anonymously by anyone who has its ID. | ||
| * `RESTRICTED` - Only users with explicit access to the resources can access the run. |
There was a problem hiding this comment.
| * `RESTRICTED` - Only users with explicit access to the resources can access the run. | |
| * `RESTRICTED` - Only users with explicit access to the resource can access the run. |
| - ANYONE_WITH_ID_CAN_READ | ||
| - FOLLOW_USER_SETTING | ||
| example: RESTRICTED | ||
| description: "Defines general access level for the resource." |
There was a problem hiding this comment.
| description: "Defines general access level for the resource." | |
| description: Defines the general access level for the resource. |
| generalAccess: | ||
| type: string | ||
| enum: | ||
| - RESTRICTED | ||
| - ANYONE_WITH_ID_CAN_READ | ||
| - FOLLOW_USER_SETTING | ||
| example: RESTRICTED |
There was a problem hiding this comment.
Is the duplicate content necessary? Can't a reference be used here, as in the KeyValueStore.yaml file?
There was a problem hiding this comment.
Good point, missed that 👍
|
Preview for this PR was built for commit |
We noticed that we don't have information about updating
generalAccessin docs.This PR updates docs to include
generalAccessfor update(PUT) endpoints of:Note
Documents and exposes
generalAccessin schemas and PUT endpoints for runs, datasets, key‑value stores, and request queues, and expands the run update endpoint to cover both status and access.actor-runs/Run.yaml: AddgeneralAccess(enum) and include it inrequired.generalAccess(enum) todatasets/Dataset.yaml,key-value-stores/KeyValueStore.yaml,request-queues/RequestQueue.yaml.generalAccess(with examples):datasets/UpdateDatasetRequest.yaml,request-queues/UpdateRequestQueueRequest.yaml,store/UpdateStoreRequest.yaml,actor-runs/UpdateRunRequest.yaml.datasets@{datasetId}.yaml,key-value-stores@{storeId}.yaml,request-queues@{queueId}.yaml: Update descriptions to allow updatingnameandgeneralAccess; addgeneralAccessto request examples.actor-runs@{runId}.yaml: Rename summary to "Update run" and expand description to coverstatusMessageandgeneralAccess(allowed values, effects).Written by Cursor Bugbot for commit abbd7d2. Configure here.