From bb086330723f1dd56d21164b80b1d16b93d70fbd Mon Sep 17 00:00:00 2001 From: stepskop Date: Mon, 8 Dec 2025 15:14:36 +0100 Subject: [PATCH 1/5] docs: add `actorPermissionLevel` to OpenAPI spec --- apify-api/openapi/components/schemas/actors/Actor.yaml | 7 +++++++ .../components/schemas/actors/UpdateActorRequest.yaml | 8 +++++++- apify-api/openapi/paths/actors/acts@{actorId}.yaml | 2 ++ 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/apify-api/openapi/components/schemas/actors/Actor.yaml b/apify-api/openapi/components/schemas/actors/Actor.yaml index 34cb6c6002..eb413ae273 100644 --- a/apify-api/openapi/components/schemas/actors/Actor.yaml +++ b/apify-api/openapi/components/schemas/actors/Actor.yaml @@ -36,6 +36,13 @@ properties: isPublic: type: boolean example: false + actorPermissionLevel: + type: string + nullable: true + enum: + - LIMITED_PERMISSIONS + - FULL_PERMISSIONS + example: LIMITED_PERMISSIONS createdAt: type: string example: '2019-07-08T11:27:57.401Z' diff --git a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml index 6be07cd905..3d13366fba 100644 --- a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml +++ b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml @@ -11,6 +11,13 @@ properties: isPublic: type: boolean example: false + actorPermissionLevel: + type: string + nullable: true + enum: + - LIMITED_PERMISSIONS + - FULL_PERMISSIONS + example: LIMITED_PERMISSIONS seoTitle: type: string nullable: true @@ -102,4 +109,3 @@ required: - name - isPublic - versions - diff --git a/apify-api/openapi/paths/actors/acts@{actorId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}.yaml index 89f32a89a8..8a30eb117c 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}.yaml @@ -140,6 +140,7 @@ put: name: MyActor description: My favourite Actor! isPublic: false + actorPermissionLevel: 'LIMITED_PERMISSIONS' seoTitle: My Actor seoDescription: My Actor is the best title: My Actor @@ -197,6 +198,7 @@ put: username: jane35 description: My favourite Actor! isPublic: false + actorPermissionLevel: 'LIMITED_PERMISSIONS' createdAt: '2019-07-08T11:27:57.401Z' modifiedAt: '2019-07-08T14:01:05.546Z' stats: From 9fabbfab8283209a966713360a5dabc92c5fa3c7 Mon Sep 17 00:00:00 2001 From: stepskop Date: Mon, 8 Dec 2025 15:22:10 +0100 Subject: [PATCH 2/5] chore: make the response not nullable --- apify-api/openapi/components/schemas/actors/Actor.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/apify-api/openapi/components/schemas/actors/Actor.yaml b/apify-api/openapi/components/schemas/actors/Actor.yaml index eb413ae273..85ec0a6fe0 100644 --- a/apify-api/openapi/components/schemas/actors/Actor.yaml +++ b/apify-api/openapi/components/schemas/actors/Actor.yaml @@ -38,7 +38,6 @@ properties: example: false actorPermissionLevel: type: string - nullable: true enum: - LIMITED_PERMISSIONS - FULL_PERMISSIONS From 50018adaa5d1eb60ef532b64cdfd303fba9b8b44 Mon Sep 17 00:00:00 2001 From: stepskop Date: Fri, 12 Dec 2025 13:17:38 +0100 Subject: [PATCH 3/5] chore: make permission level reusable component --- apify-api/openapi/components/schemas/actors/Actor.yaml | 6 +----- .../components/schemas/actors/ActorPermissionLevel.yaml | 5 +++++ .../components/schemas/actors/UpdateActorRequest.yaml | 6 +----- 3 files changed, 7 insertions(+), 10 deletions(-) create mode 100644 apify-api/openapi/components/schemas/actors/ActorPermissionLevel.yaml diff --git a/apify-api/openapi/components/schemas/actors/Actor.yaml b/apify-api/openapi/components/schemas/actors/Actor.yaml index 85ec0a6fe0..9fab58ec5b 100644 --- a/apify-api/openapi/components/schemas/actors/Actor.yaml +++ b/apify-api/openapi/components/schemas/actors/Actor.yaml @@ -37,11 +37,7 @@ properties: type: boolean example: false actorPermissionLevel: - type: string - enum: - - LIMITED_PERMISSIONS - - FULL_PERMISSIONS - example: LIMITED_PERMISSIONS + $ref: ./ActorPermissionLevel.yaml createdAt: type: string example: '2019-07-08T11:27:57.401Z' diff --git a/apify-api/openapi/components/schemas/actors/ActorPermissionLevel.yaml b/apify-api/openapi/components/schemas/actors/ActorPermissionLevel.yaml new file mode 100644 index 0000000000..75a8a81423 --- /dev/null +++ b/apify-api/openapi/components/schemas/actors/ActorPermissionLevel.yaml @@ -0,0 +1,5 @@ +type: string +enum: + - LIMITED_PERMISSIONS + - FULL_PERMISSIONS +example: LIMITED_PERMISSIONS \ No newline at end of file diff --git a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml index 3d13366fba..aef69f5924 100644 --- a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml +++ b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml @@ -12,12 +12,8 @@ properties: type: boolean example: false actorPermissionLevel: - type: string nullable: true - enum: - - LIMITED_PERMISSIONS - - FULL_PERMISSIONS - example: LIMITED_PERMISSIONS + $ref: ./ActorPermissionLevel.yaml seoTitle: type: string nullable: true From 604a7354b258d0ef29d8ecfc1470b3ddbee3a551 Mon Sep 17 00:00:00 2001 From: stepskop Date: Fri, 12 Dec 2025 13:26:46 +0100 Subject: [PATCH 4/5] chore: add description to permission level --- .../components/schemas/actors/ActorPermissionLevel.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/apify-api/openapi/components/schemas/actors/ActorPermissionLevel.yaml b/apify-api/openapi/components/schemas/actors/ActorPermissionLevel.yaml index 75a8a81423..569d6b9388 100644 --- a/apify-api/openapi/components/schemas/actors/ActorPermissionLevel.yaml +++ b/apify-api/openapi/components/schemas/actors/ActorPermissionLevel.yaml @@ -1,5 +1,8 @@ type: string +description: > + Permission level the Actor is run under. + For more information, see the [Actor permissions documentation](https://docs.apify.com/platform/actors/development/permissions). enum: - LIMITED_PERMISSIONS - FULL_PERMISSIONS -example: LIMITED_PERMISSIONS \ No newline at end of file +example: LIMITED_PERMISSIONS From bd8c424c8e60a4c76db627ec376aedbc085e1743 Mon Sep 17 00:00:00 2001 From: stepskop Date: Fri, 12 Dec 2025 13:35:12 +0100 Subject: [PATCH 5/5] chore: permission level copy --- .../openapi/components/schemas/actors/ActorPermissionLevel.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apify-api/openapi/components/schemas/actors/ActorPermissionLevel.yaml b/apify-api/openapi/components/schemas/actors/ActorPermissionLevel.yaml index 569d6b9388..f9c3bedf91 100644 --- a/apify-api/openapi/components/schemas/actors/ActorPermissionLevel.yaml +++ b/apify-api/openapi/components/schemas/actors/ActorPermissionLevel.yaml @@ -1,6 +1,6 @@ type: string description: > - Permission level the Actor is run under. + Determines permissions that the Actor requires to run. For more information, see the [Actor permissions documentation](https://docs.apify.com/platform/actors/development/permissions). enum: - LIMITED_PERMISSIONS