Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions apify-api/openapi/components/schemas/actor-runs/Run.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ required:
- defaultRequestQueueId
- buildNumber
- containerUrl
- generalAccess
type: object
properties:
id:
Expand Down Expand Up @@ -66,6 +67,13 @@ properties:
type: number
nullable: true
example: 0
generalAccess:
type: string
enum:
- RESTRICTED
- ANYONE_WITH_ID_CAN_READ
- FOLLOW_USER_SETTING
example: RESTRICTED
Comment on lines +70 to +76
Copy link
Contributor

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.

defaultKeyValueStoreId:
type: string
example: eJNzqsbPiopwJcgGQ
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
title: UpdateRunRequest
required:
- runId
- statusMessage
type: object
properties:
runId:
Expand All @@ -13,3 +10,10 @@ properties:
isStatusMessageTerminal:
type: boolean
example: true
generalAccess:
type: string
enum:
- RESTRICTED
- ANYONE_WITH_ID_CAN_READ
- FOLLOW_USER_SETTING
example: RESTRICTED
7 changes: 7 additions & 0 deletions apify-api/openapi/components/schemas/datasets/Dataset.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,12 @@ properties:
type: string
description: "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset."
nullable: true
generalAccess:
type: string
enum:
- RESTRICTED
- ANYONE_WITH_ID_CAN_READ
- FOLLOW_USER_SETTING
example: RESTRICTED
stats:
$ref: ./DatasetStats.yaml
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
Expand Up @@ -51,5 +51,12 @@ properties:
type: string
description: "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store."
nullable: true
generalAccess:
type: string
enum:
- RESTRICTED
- ANYONE_WITH_ID_CAN_READ
- FOLLOW_USER_SETTING
example: RESTRICTED
stats:
$ref: ./KeyValueStoreStats.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
18 changes: 17 additions & 1 deletion apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.

**Status message:**

You can set a single status message on your run that will be displayed in
the Apify Console UI. During an Actor run, you will typically do this in order
to inform users of your Actor about the Actor's progress.
Expand All @@ -196,6 +200,18 @@ put:
`isStatusMessageTerminal` property is optional and it indicates if the
status message is the very last one. In the absence of a status message, the
platform will try to substitute sensible defaults.

**General resource access:**

You can also update the run’s general resource access setting, which determines who can view the run and its related data.

Allowed values:

* `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.

When a run is accessible anonymously, all of the run’s default storages and logs also become accessible anonymously.
operationId: actorRun_put
parameters:
- name: runId
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ put:
- Storage/Datasets
summary: Update dataset
description: |
Updates a dataset's name using a value specified by a JSON object passed in the PUT payload.
Updates a dataset's name and general resource access level using a value specified by a JSON object passed in the PUT payload.
The response is the updated dataset object, as returned by the [Get dataset](#/reference/datasets/dataset-collection/get-dataset) API endpoint.
operationId: dataset_put
parameters:
Expand All @@ -91,6 +91,7 @@ put:
$ref: ../../components/schemas/datasets/UpdateDatasetRequest.yaml
example:
name: new-dataset-name
generalAccess: RESTRICTED
required: true
responses:
'200':
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ put:
- Storage/Key-value stores
summary: Update store
description: |
Updates a key-value store's name using a value specified by a JSON object
Updates a key-value store's name and general resource access level using a value specified by a JSON object
passed in the PUT payload.

The response is the updated key-value store object, as returned by the [Get
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ put:
- Storage/Request queues
summary: Update request queue
description: |
Updates a request queue's name using a value specified by a JSON object
Updates a request queue's name and general resource access level using a value specified by a JSON object
passed in the PUT payload.

The response is the updated request queue object, as returned by the
Expand Down
Loading