From 00d61f84c5e08fe2a055158f9762c6ad1b0cec81 Mon Sep 17 00:00:00 2001 From: Daniil Poletaev <44584010+danpoletaev@users.noreply.github.com> Date: Tue, 21 Jan 2025 16:23:33 +0100 Subject: [PATCH 1/5] feat(api): added OpenAPI response component --- .../actor-builds/GetOpenApiResponse.yaml | 348 ++++++++++++++++++ 1 file changed, 348 insertions(+) create mode 100644 apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml diff --git a/apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml b/apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml new file mode 100644 index 000000000..ff5a15e31 --- /dev/null +++ b/apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml @@ -0,0 +1,348 @@ +title: GetOpenApiResponse +type: object +properties: + openapi: + type: string + example: 3.0.1 + info: + type: object + properties: + title: + type: string + example: Your Magic Actor + version: + type: string + example: "1.0" + x-build-id: + type: string + example: "ID of build" + servers: + type: array + items: + type: object + properties: + url: + type: string + example: https://api.apify.com/v2 + paths: + type: object + properties: + /acts/~/run-sync-get-dataset-items: + type: object + properties: + post: + type: object + properties: + operationId: + type: string + example: run-sync-get-dataset-items + x-openai-isConsequential: + type: boolean + example: false + summary: + type: string + example: Executes an Actor, waits for its completion, and returns Actor's dataset items in response. + tags: + type: array + items: + type: string + example: ["Run Actor"] + requestBody: + type: object + properties: + required: + type: boolean + example: true + content: + type: object + properties: + application/json: + type: object + properties: + schema: + type: object + properties: + $ref: + type: string + example: '#/components/schemas/inputSchema' + parameters: + type: array + items: + type: object + properties: + name: + type: string + example: token + in: + type: string + example: query + required: + type: boolean + example: true + schema: + type: object + properties: + type: + type: string + example: string + description: + type: string + example: Enter your Apify token here + responses: + type: object + properties: + '200': + type: object + properties: + description: + type: string + example: OK + /acts/~/runs: + type: object + properties: + post: + type: object + properties: + operationId: + type: string + example: runs + x-openai-isConsequential: + type: boolean + example: false + summary: + type: string + example: Executes an Actor and returns information about the initiated run in response. + tags: + type: array + items: + type: string + example: ["Run Actor"] + requestBody: + type: object + properties: + required: + type: boolean + example: true + content: + type: object + properties: + application/json: + type: object + properties: + schema: + type: object + properties: + $ref: + type: string + example: '#/components/schemas/inputSchema' + parameters: + type: array + items: + type: object + properties: + name: + type: string + in: + type: string + example: query + required: + type: boolean + schema: + type: object + properties: + type: + type: string + description: + type: string + responses: + type: object + properties: + '200': + type: object + properties: + description: + type: string + example: OK + content: + type: object + properties: + application/json: + type: object + properties: + schema: + type: object + properties: + $ref: + type: string + example: '#/components/schemas/runsResponseSchema' + /acts/~/run-sync: + type: object + properties: + post: + type: object + properties: + operationId: + type: string + example: run-sync + x-openai-isConsequential: + type: boolean + example: false + summary: + type: string + example: Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response. + tags: + type: array + items: + type: string + example: ["Run Actor"] + requestBody: + type: object + properties: + required: + type: boolean + example: true + content: + type: object + properties: + application/json: + type: object + properties: + schema: + type: object + properties: + $ref: + type: string + example: '#/components/schemas/inputSchema' + parameters: + type: array + items: + type: object + properties: + name: + type: string + in: + type: string + example: query + required: + type: boolean + schema: + type: object + properties: + type: + type: string + description: + type: string + responses: + type: object + properties: + '200': + type: object + properties: + description: + type: string + example: OK + components: + type: object + properties: + schemas: + type: object + properties: + inputSchema: + type: object + properties: + type: + type: string + example: object + runsResponseSchema: + type: object + properties: + type: + type: string + example: object + properties: + type: object + properties: + data: + type: object + properties: + type: + type: string + example: object + properties: + type: object + properties: + id: + type: object + properties: + type: + type: string + example: string + actId: + type: object + properties: + type: + type: string + example: string + userId: + type: object + properties: + type: + type: string + example: string + startedAt: + type: object + properties: + type: + type: string + example: string + format: + type: string + example: date-time + example: + type: string + example: "2025-01-08T00:00:00.000Z" + finishedAt: + type: object + properties: + type: + type: string + example: string + format: + type: string + example: date-time + example: + type: string + example: "2025-01-08T00:00:00.000Z" + status: + type: object + properties: + type: + type: string + example: string + example: + type: string + example: "READY" + meta: + type: object + properties: + type: + type: string + example: object + properties: + type: object + properties: + origin: + type: object + properties: + type: + type: string + example: string + example: + type: string + example: "API" + userAgent: + type: object + properties: + type: + type: string + example: string From c4004cea70b2f77d444a892f104d6e777920d150 Mon Sep 17 00:00:00 2001 From: Daniil Poletaev <44584010+danpoletaev@users.noreply.github.com> Date: Tue, 21 Jan 2025 16:24:49 +0100 Subject: [PATCH 2/5] feat(api): added openapi endpoints documentation --- apify-api/openapi/components/tags.yaml | 22 ++++++++++ .../openapi/components/x-tag-groups.yaml | 2 + apify-api/openapi/openapi.yaml | 4 ++ ...uilds@{buildId}@openapi-specification.yaml | 31 ++++++++++++++ ...uilds@{buildId}@openapi-specification.yaml | 41 +++++++++++++++++++ 5 files changed, 100 insertions(+) create mode 100644 apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml create mode 100644 apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index baa466a58..276ed19ea 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -251,6 +251,17 @@ ``` In order to save new items to the dataset, send HTTP POST request with JSON payload to the same URL. +- name: Actors/Build OpenAPI specification + x-displayName: Build OpenAPI Specification + x-parent-tag-name: Actors + x-trait: 'true' + description: | + To obtain the OpenAPI schema for actor builds, two similar endpoints are available: + + - [First Endpoint](/api/v2/act-openapi-specification-get): Requires both `actorId` and `buildId`. You can pass `default` instead of buildId to retrieve the OpenAPI schema for the default actor build. + - [Second Endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`. + x-legacy-doc-urls: + - '#/reference/actors/openapi-specification' - name: Actor tasks x-displayName: Actor tasks x-legacy-doc-urls: @@ -548,6 +559,17 @@ - '#tag/Actor-buildsBuild-log' x-trait: 'true' description: Check out [Logs](#/reference/logs) for full reference. +- name: Actor builds/Build OpenAPI specification + x-displayName: Build OpenAPI Specification + x-parent-tag-name: Actor builds + x-trait: 'true' + description: | + To obtain the OpenAPI schema for actor builds, two similar endpoints are available: + + - [First Endpoint](/api/v2/act-openapi-specification-get): Requires both `actorId` and `buildId`. You can pass `default` instead of buildId to retrieve the OpenAPI schema for the default actor build. + - [Second Endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`. + x-legacy-doc-urls: + - '#/reference/actor-builds/openapi-specification' - name: Key-value stores x-displayName: Key-value stores x-legacy-doc-urls: diff --git a/apify-api/openapi/components/x-tag-groups.yaml b/apify-api/openapi/components/x-tag-groups.yaml index 9a85e48d2..10a860e6f 100644 --- a/apify-api/openapi/components/x-tag-groups.yaml +++ b/apify-api/openapi/components/x-tag-groups.yaml @@ -19,6 +19,7 @@ - Actors/Metamorph run - Actors/Resurrect run - Actors/Last run object and its storages + - Actors/Build OpenAPI specification - name: Actor tasks tags: - Actor tasks @@ -50,6 +51,7 @@ - Actor builds/Delete build - Actor builds/Abort build - Actor builds/Build log + - Actor builds/Build OpenAPI specification - name: Key-value stores tags: - Key-value stores diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index a0f3b23bf..532ddfcf5 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -501,6 +501,8 @@ paths: $ref: 'paths/actors/acts@{actorId}@builds@{buildId}.yaml' '/v2/acts/{actorId}/builds/{buildId}/abort': $ref: 'paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml' + '/v2/acts/{actorId}/builds/{buildId}/openapi-specification': + $ref: 'paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml' '/v2/acts/{actorId}/runs': $ref: 'paths/actors/acts@{actorId}@runs.yaml' '/v2/acts/{actorId}/run-sync': @@ -553,6 +555,8 @@ paths: $ref: 'paths/actor-builds/actor-builds@{buildId}@abort.yaml' '/v2/actor-builds/{buildId}/log': $ref: 'paths/actor-builds/actor-builds@{buildId}@log.yaml' + '/v2/actor-builds/{buildId}/openapi-specification': + $ref: 'paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml' /v2/key-value-stores: $ref: paths/key-value-stores/key-value-stores.yaml '/v2/key-value-stores/{storeId}': diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml new file mode 100644 index 000000000..102164253 --- /dev/null +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml @@ -0,0 +1,31 @@ +get: + tags: + - Actor builds/Build OpenAPI specification + summary: Get OpenAPI specification + description: | + + > **You can also use a [similar endpoint](/api/v2/act-openapi-specification-get)** + > from the `acts` namespace to retrieve the OpenAPI specification for a build. + + This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the build. + operationId: actorBuild_openapiSpecification_get + security: + - apiKeyActorBuilds: [] + - httpBearerActorBuilds: [] + parameters: + - name: buildId + in: path + description: 'ID of the build you want to get, found in the build''s `Info` tab.' + required: true + style: simple + schema: + type: string + example: soSkq9ekdmfOslopH + responses: + '200': + description: '' + headers: {} + content: + application/json: + schema: + $ref: "../../components/schemas/actor-builds/GetOpenApiResponse.yaml" diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml new file mode 100644 index 000000000..451e61756 --- /dev/null +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml @@ -0,0 +1,41 @@ +get: + tags: + - Actors/Build OpenAPI specification + summary: Get OpenAPI specification + description: | + + > **You can also use a [similar endpoint](/api/v2/actor-build-openapi-specification-get)** + > from the `actor-builds` namespace to retrieve the OpenAPI specification for a build. + + To fetch the default actor build, simply pass `default` in place of `buildId`. + + This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the build. + operationId: act_openapiSpecification_get + security: + - apiKeyActorBuilds: [] + - httpBearerActorBuilds: [] + parameters: + - name: actorId + in: path + description: Actor ID or a tilde-separated owner's username and Actor name. + required: true + style: simple + schema: + type: string + example: janedoe~my-actor + - name: buildId + in: path + description: 'ID of the build you want to get, found in the build''s `Info` tab. Pass `default` for default actor build.' + required: true + style: simple + schema: + type: string + example: soSkq9ekdmfOslopH + responses: + '200': + description: '' + headers: {} + content: + application/json: + schema: + $ref: "../../components/schemas/actor-builds/GetOpenApiResponse.yaml" From 32d14aa2e79207f6d959a61fd276c560c85db98d Mon Sep 17 00:00:00 2001 From: Daniil Poletaev <44584010+danpoletaev@users.noreply.github.com> Date: Wed, 22 Jan 2025 10:53:13 +0100 Subject: [PATCH 3/5] refactor: clean up --- apify-api/openapi/components/tags.yaml | 12 ++++-------- apify-api/openapi/components/x-tag-groups.yaml | 4 ++-- ...actor-builds@{buildId}@openapi-specification.yaml | 2 +- ...orId}@builds@{buildId}@openapi-specification.yaml | 2 +- 4 files changed, 8 insertions(+), 12 deletions(-) diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index 276ed19ea..d8aa421d4 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -251,8 +251,8 @@ ``` In order to save new items to the dataset, send HTTP POST request with JSON payload to the same URL. -- name: Actors/Build OpenAPI specification - x-displayName: Build OpenAPI Specification +- name: Actors/Get OpenAPI specification + x-displayName: Get OpenAPI specification x-parent-tag-name: Actors x-trait: 'true' description: | @@ -260,8 +260,6 @@ - [First Endpoint](/api/v2/act-openapi-specification-get): Requires both `actorId` and `buildId`. You can pass `default` instead of buildId to retrieve the OpenAPI schema for the default actor build. - [Second Endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`. - x-legacy-doc-urls: - - '#/reference/actors/openapi-specification' - name: Actor tasks x-displayName: Actor tasks x-legacy-doc-urls: @@ -559,8 +557,8 @@ - '#tag/Actor-buildsBuild-log' x-trait: 'true' description: Check out [Logs](#/reference/logs) for full reference. -- name: Actor builds/Build OpenAPI specification - x-displayName: Build OpenAPI Specification +- name: Actor builds/Get OpenAPI specification + x-displayName: Get OpenAPI specification x-parent-tag-name: Actor builds x-trait: 'true' description: | @@ -568,8 +566,6 @@ - [First Endpoint](/api/v2/act-openapi-specification-get): Requires both `actorId` and `buildId`. You can pass `default` instead of buildId to retrieve the OpenAPI schema for the default actor build. - [Second Endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`. - x-legacy-doc-urls: - - '#/reference/actor-builds/openapi-specification' - name: Key-value stores x-displayName: Key-value stores x-legacy-doc-urls: diff --git a/apify-api/openapi/components/x-tag-groups.yaml b/apify-api/openapi/components/x-tag-groups.yaml index 10a860e6f..a9abef590 100644 --- a/apify-api/openapi/components/x-tag-groups.yaml +++ b/apify-api/openapi/components/x-tag-groups.yaml @@ -19,7 +19,7 @@ - Actors/Metamorph run - Actors/Resurrect run - Actors/Last run object and its storages - - Actors/Build OpenAPI specification + - Actors/Get OpenAPI specification - name: Actor tasks tags: - Actor tasks @@ -51,7 +51,7 @@ - Actor builds/Delete build - Actor builds/Abort build - Actor builds/Build log - - Actor builds/Build OpenAPI specification + - Actor builds/Get OpenAPI specification - name: Key-value stores tags: - Key-value stores diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml index 102164253..f0122de73 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml @@ -1,6 +1,6 @@ get: tags: - - Actor builds/Build OpenAPI specification + - Actor builds/Get OpenAPI specification summary: Get OpenAPI specification description: | diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml index 451e61756..5865068c8 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml @@ -1,6 +1,6 @@ get: tags: - - Actors/Build OpenAPI specification + - Actors/Get OpenAPI specification summary: Get OpenAPI specification description: | From e72b84f2f37a188f5ea326e9758244c152afdc7e Mon Sep 17 00:00:00 2001 From: Daniil Poletaev <44584010+danpoletaev@users.noreply.github.com> Date: Wed, 22 Jan 2025 14:59:21 +0100 Subject: [PATCH 4/5] refactor: improved documentation text --- apify-api/openapi/components/tags.yaml | 12 ++++++------ ...or-builds@{buildId}@openapi-specification.yaml | 11 +++++------ ...d}@builds@{buildId}@openapi-specification.yaml | 15 +++++++-------- 3 files changed, 18 insertions(+), 20 deletions(-) diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index d8aa421d4..317b1775b 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -256,10 +256,10 @@ x-parent-tag-name: Actors x-trait: 'true' description: | - To obtain the OpenAPI schema for actor builds, two similar endpoints are available: + Get the OpenAPI specification for Actor builds. Two similar endpoints are available: - - [First Endpoint](/api/v2/act-openapi-specification-get): Requires both `actorId` and `buildId`. You can pass `default` instead of buildId to retrieve the OpenAPI schema for the default actor build. - - [Second Endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`. + - [First endpoint](/api/v2/act-openapi-specification-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build. + - [Second endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`. - name: Actor tasks x-displayName: Actor tasks x-legacy-doc-urls: @@ -562,10 +562,10 @@ x-parent-tag-name: Actor builds x-trait: 'true' description: | - To obtain the OpenAPI schema for actor builds, two similar endpoints are available: + Get the OpenAPI specification for Actor builds. Two similar endpoints are available: - - [First Endpoint](/api/v2/act-openapi-specification-get): Requires both `actorId` and `buildId`. You can pass `default` instead of buildId to retrieve the OpenAPI schema for the default actor build. - - [Second Endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`. + - [First endpoint](/api/v2/act-openapi-specification-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build. + - [Second endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`. - name: Key-value stores x-displayName: Key-value stores x-legacy-doc-urls: diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml index f0122de73..0524c0be8 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml @@ -3,11 +3,10 @@ get: - Actor builds/Get OpenAPI specification summary: Get OpenAPI specification description: | - - > **You can also use a [similar endpoint](/api/v2/act-openapi-specification-get)** - > from the `acts` namespace to retrieve the OpenAPI specification for a build. - - This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the build. + Get the OpenAPI specification for a specific Actor build. + Authentication is based on the build's unique ID. No authentication token is required. + + **Note**: You can also use the `/api/v2/act-openapi-specification-get` endpoint to get the OpenAPI specification for a build. operationId: actorBuild_openapiSpecification_get security: - apiKeyActorBuilds: [] @@ -15,7 +14,7 @@ get: parameters: - name: buildId in: path - description: 'ID of the build you want to get, found in the build''s `Info` tab.' + description: ID of the build you want to get, found in the build's `Info` tab. required: true style: simple schema: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml index 5865068c8..f0d770b3c 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml @@ -3,13 +3,12 @@ get: - Actors/Get OpenAPI specification summary: Get OpenAPI specification description: | - - > **You can also use a [similar endpoint](/api/v2/actor-build-openapi-specification-get)** - > from the `actor-builds` namespace to retrieve the OpenAPI specification for a build. - - To fetch the default actor build, simply pass `default` in place of `buildId`. - - This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the build. + Get the OpenAPI specification for a specific Actor build. + + To fetch the default Actor build, simply pass `default` as the `buildId`. + Authentication is based on the build's unique ID. No authentication token is required. + + **Note**: You can also use the `/api/v2/actor-build-openapi-specification-get` endpoint to get the OpenAPI specification for a build. operationId: act_openapiSpecification_get security: - apiKeyActorBuilds: [] @@ -25,7 +24,7 @@ get: example: janedoe~my-actor - name: buildId in: path - description: 'ID of the build you want to get, found in the build''s `Info` tab. Pass `default` for default actor build.' + description: ID of the build you want to get, found in the build's `Info` tab. Pass `default` for default Actor build. required: true style: simple schema: From 6a436e910b28200447c235d7d9ddfa658b075979 Mon Sep 17 00:00:00 2001 From: Daniil Poletaev <44584010+danpoletaev@users.noreply.github.com> Date: Wed, 22 Jan 2025 15:20:04 +0100 Subject: [PATCH 5/5] refactor: clean up --- .../actor-builds/GetOpenApiResponse.yaml | 18 +++++++++--------- ...builds@{buildId}@openapi-specification.yaml | 2 +- ...builds@{buildId}@openapi-specification.yaml | 4 ++-- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml b/apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml index ff5a15e31..a5a159db6 100644 --- a/apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml @@ -12,10 +12,10 @@ properties: example: Your Magic Actor version: type: string - example: "1.0" + example: '1.0' x-build-id: type: string - example: "ID of build" + example: 'ID of build' servers: type: array items: @@ -46,7 +46,7 @@ properties: type: array items: type: string - example: ["Run Actor"] + example: ['Run Actor'] requestBody: type: object properties: @@ -116,7 +116,7 @@ properties: type: array items: type: string - example: ["Run Actor"] + example: ['Run Actor'] requestBody: type: object properties: @@ -194,7 +194,7 @@ properties: type: array items: type: string - example: ["Run Actor"] + example: ['Run Actor'] requestBody: type: object properties: @@ -300,7 +300,7 @@ properties: example: date-time example: type: string - example: "2025-01-08T00:00:00.000Z" + example: '2025-01-08T00:00:00.000Z' finishedAt: type: object properties: @@ -312,7 +312,7 @@ properties: example: date-time example: type: string - example: "2025-01-08T00:00:00.000Z" + example: '2025-01-08T00:00:00.000Z' status: type: object properties: @@ -321,7 +321,7 @@ properties: example: string example: type: string - example: "READY" + example: 'READY' meta: type: object properties: @@ -339,7 +339,7 @@ properties: example: string example: type: string - example: "API" + example: 'API' userAgent: type: object properties: diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml index 0524c0be8..da6fb545c 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml @@ -27,4 +27,4 @@ get: content: application/json: schema: - $ref: "../../components/schemas/actor-builds/GetOpenApiResponse.yaml" + $ref: '../../components/schemas/actor-builds/GetOpenApiResponse.yaml' diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml index f0d770b3c..6a929cfcd 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml @@ -4,7 +4,7 @@ get: summary: Get OpenAPI specification description: | Get the OpenAPI specification for a specific Actor build. - + To fetch the default Actor build, simply pass `default` as the `buildId`. Authentication is based on the build's unique ID. No authentication token is required. @@ -37,4 +37,4 @@ get: content: application/json: schema: - $ref: "../../components/schemas/actor-builds/GetOpenApiResponse.yaml" + $ref: '../../components/schemas/actor-builds/GetOpenApiResponse.yaml'