Skip to content

Commit e72b84f

Browse files
committed
refactor: improved documentation text
1 parent 32d14aa commit e72b84f

File tree

3 files changed

+18
-20
lines changed

3 files changed

+18
-20
lines changed

apify-api/openapi/components/tags.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -256,10 +256,10 @@
256256
x-parent-tag-name: Actors
257257
x-trait: 'true'
258258
description: |
259-
To obtain the OpenAPI schema for actor builds, two similar endpoints are available:
259+
Get the OpenAPI specification for Actor builds. Two similar endpoints are available:
260260
261-
- [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.
262-
- [Second Endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`.
261+
- [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.
262+
- [Second endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`.
263263
- name: Actor tasks
264264
x-displayName: Actor tasks
265265
x-legacy-doc-urls:
@@ -562,10 +562,10 @@
562562
x-parent-tag-name: Actor builds
563563
x-trait: 'true'
564564
description: |
565-
To obtain the OpenAPI schema for actor builds, two similar endpoints are available:
565+
Get the OpenAPI specification for Actor builds. Two similar endpoints are available:
566566
567-
- [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.
568-
- [Second Endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`.
567+
- [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.
568+
- [Second endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`.
569569
- name: Key-value stores
570570
x-displayName: Key-value stores
571571
x-legacy-doc-urls:

apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,18 @@ get:
33
- Actor builds/Get OpenAPI specification
44
summary: Get OpenAPI specification
55
description: |
6-
7-
> **You can also use a [similar endpoint](/api/v2/act-openapi-specification-get)**
8-
> from the `acts` namespace to retrieve the OpenAPI specification for a build.
9-
10-
This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the build.
6+
Get the OpenAPI specification for a specific Actor build.
7+
Authentication is based on the build's unique ID. No authentication token is required.
8+
9+
**Note**: You can also use the `/api/v2/act-openapi-specification-get` endpoint to get the OpenAPI specification for a build.
1110
operationId: actorBuild_openapiSpecification_get
1211
security:
1312
- apiKeyActorBuilds: []
1413
- httpBearerActorBuilds: []
1514
parameters:
1615
- name: buildId
1716
in: path
18-
description: 'ID of the build you want to get, found in the build''s `Info` tab.'
17+
description: ID of the build you want to get, found in the build's `Info` tab.
1918
required: true
2019
style: simple
2120
schema:

apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,12 @@ get:
33
- Actors/Get OpenAPI specification
44
summary: Get OpenAPI specification
55
description: |
6-
7-
> **You can also use a [similar endpoint](/api/v2/actor-build-openapi-specification-get)**
8-
> from the `actor-builds` namespace to retrieve the OpenAPI specification for a build.
9-
10-
To fetch the default actor build, simply pass `default` in place of `buildId`.
11-
12-
This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the build.
6+
Get the OpenAPI specification for a specific Actor build.
7+
8+
To fetch the default Actor build, simply pass `default` as the `buildId`.
9+
Authentication is based on the build's unique ID. No authentication token is required.
10+
11+
**Note**: You can also use the `/api/v2/actor-build-openapi-specification-get` endpoint to get the OpenAPI specification for a build.
1312
operationId: act_openapiSpecification_get
1413
security:
1514
- apiKeyActorBuilds: []
@@ -25,7 +24,7 @@ get:
2524
example: janedoe~my-actor
2625
- name: buildId
2726
in: path
28-
description: 'ID of the build you want to get, found in the build''s `Info` tab. Pass `default` for default actor build.'
27+
description: ID of the build you want to get, found in the build's `Info` tab. Pass `default` for default Actor build.
2928
required: true
3029
style: simple
3130
schema:

0 commit comments

Comments
 (0)