-
Notifications
You must be signed in to change notification settings - Fork 151
feat: update generalAccess docs #2127
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,15 @@ | ||
| title: UpdateDatasetRequest | ||
| required: | ||
| - name | ||
| type: object | ||
| properties: | ||
| name: | ||
| type: string | ||
| generalAccess: | ||
| type: string | ||
| enum: | ||
| - RESTRICTED | ||
| - ANYONE_WITH_ID_CAN_READ | ||
| - FOLLOW_USER_SETTING | ||
| example: RESTRICTED | ||
| example: | ||
| name: new-dataset-name | ||
| generalAccess: RESTRICTED |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -46,3 +46,10 @@ properties: | |
| consoleUrl: | ||
| type: string | ||
| example: 'https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC' | ||
| generalAccess: | ||
| type: string | ||
| enum: | ||
| - RESTRICTED | ||
| - ANYONE_WITH_ID_CAN_READ | ||
| - FOLLOW_USER_SETTING | ||
| example: RESTRICTED | ||
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,15 @@ | ||
| title: UpdateRequestQueueRequest | ||
| required: | ||
| - name | ||
| type: object | ||
| properties: | ||
| name: | ||
| type: string | ||
| generalAccess: | ||
| type: string | ||
| enum: | ||
| - RESTRICTED | ||
| - ANYONE_WITH_ID_CAN_READ | ||
| - FOLLOW_USER_SETTING | ||
| example: RESTRICTED | ||
| example: | ||
| name: new-request-queue-name | ||
| generalAccess: RESTRICTED |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,15 @@ | ||
| title: UpdateStoreRequest | ||
| required: | ||
| - name | ||
| type: object | ||
| properties: | ||
| name: | ||
| type: string | ||
| generalAccess: | ||
| type: string | ||
| enum: | ||
| - RESTRICTED | ||
| - ANYONE_WITH_ID_CAN_READ | ||
| - FOLLOW_USER_SETTING | ||
| example: RESTRICTED | ||
| example: | ||
| name: new-store-name | ||
| generalAccess: RESTRICTED |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -186,8 +186,12 @@ get: | |||||
| put: | ||||||
| tags: | ||||||
| - Actor runs | ||||||
| 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. | ||||||
|
||||||
| 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. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Either "account level" or "account-level permissions/settings/whatever".
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * `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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe that this enum could be extracted into the components and referenced here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, refactored 👍