Skip to content

Commit 25158b8

Browse files
HavenDVgithub-actions[bot]
andauthored
feat: Updated OpenAPI spec (#183)
Co-authored-by: github-actions[bot] <dependabot@bot.com>
1 parent 803b886 commit 25158b8

204 files changed

Lines changed: 2269 additions & 1282 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/cli/Apify.CLI/Commands/ActorBuildsActorBuildOpenapiJsonGetCommandApiCommand.g.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ public static Command Create(string? commandName = null)
4242
var command = new Command(commandName ?? @"openapi-json-get", @"Get OpenAPI definition of Actor build
4343
Get the OpenAPI definition for Actor builds. Two similar endpoints are available:
4444
45-
- [First endpoint](/api/v2/actor-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
46-
- [Second endpoint](/api/v2/actor-build-openapi-json-get): Requires only `buildId`.
45+
- [Get OpenAPI definition of Actor build](/api/v2/actor-openapi-json-get) (`/v2/actors/{actorId}/builds/{buildId}/openapi.json`): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
46+
- [Get OpenAPI definition of Actor build](/api/v2/actor-build-openapi-json-get) (`/v2/actor-builds/{buildId}/openapi.json`): Requires only `buildId`.
4747
4848
Get the OpenAPI definition for a specific Actor build.
4949
Authentication is based on the build's unique ID. No authentication token is required.
5050
5151
:::note
5252
53-
You can also use the [`/api/v2/actor-openapi-json-get`](/api/v2/actor-openapi-json-get) endpoint to get the OpenAPI definition for a build.
53+
You can also use the [Get OpenAPI definition of Actor build](/api/v2/actor-openapi-json-get) endpoint (`/v2/actors/{actorId}/builds/{buildId}/openapi.json`) to get the OpenAPI definition for a build.
5454
5555
:::
5656
");

‎src/cli/Apify.CLI/Commands/ActorRunsActorRunGetCommandApiCommand.g.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,11 @@ public static Command Create(string? commandName = null)
5353
5454
##### Convenience endpoints for Actor run default storages
5555
56-
* [Dataset](/api/v2/default-dataset)
56+
* [Default dataset](/api/v2/default-dataset)
5757
58-
* [Key-value store](/api/v2/default-key-value-store)
58+
* [Default key-value store](/api/v2/default-key-value-store)
5959
60-
* [Request queue](/api/v2/default-request-queue)
60+
* [Default request queue](/api/v2/default-request-queue)
6161
6262
Gets an object that contains all the details about a
6363
specific run of an Actor.

‎src/cli/Apify.CLI/Commands/ActorTasksActorTaskInputPutCommandApiCommand.g.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,14 @@ JSON in the PUT payload.
6060
If the object does not define a specific property, its value is not updated.
6161
6262
The response is the full task input as returned by the
63-
[Get task input](#/reference/tasks/task-input-object/get-task-input) endpoint.
63+
[Get Actor task input](/api/v2/actor-task-input-get) endpoint.
6464
6565
The request needs to specify the `Content-Type: application/json` HTTP
6666
header!
6767
6868
When providing your API authentication token, we recommend using the
69-
request's `Authorization` header, rather than the URL. ([More
70-
info](#/introduction/authentication)).
69+
request's `Authorization` header, rather than the URL.
70+
For details, see [Authentication](/api/v2/getting-started#authentication).
7171
");
7272
command.Arguments.Add(ActorTaskId);
7373
command.Options.Add(Input);

‎src/cli/Apify.CLI/Commands/ActorTasksActorTaskRunSyncGetCommandApiCommand.g.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ configured to have a long enough connection timeout.
123123
and its status.
124124
125125
To run the Task asynchronously, use the
126-
[Run task asynchronously](#/reference/actor-tasks/run-collection/run-task)
126+
[Run Actor task](/api/v2/actor-task-runs-post)
127127
endpoint instead.
128128
");
129129
command.Arguments.Add(ActorTaskId);

‎src/cli/Apify.CLI/Commands/ActorTasksActorTaskRunSyncGetDatasetItemsGetCommandApiCommand.g.cs‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -272,8 +272,7 @@ public static Command Create(string? commandName = null)
272272
otherwise the HTTP request fails with a timeout error (this won't abort
273273
the run itself).
274274
275-
You can send all the same options in parameters as the [Get Dataset
276-
Items](#/reference/datasets/item-collection/get-items) API endpoint.
275+
You can send all the same options in parameters as the [Get dataset items](/api/v2/dataset-items-get) API endpoint.
277276
278277
Beware that it might be impossible to maintain an idle HTTP connection for
279278
an extended period, due to client timeout or network conditions. Make sure your HTTP client is
@@ -282,8 +281,7 @@ configured to have a long enough connection timeout.
282281
If the connection breaks, you will not receive any information about the run
283282
and its status.
284283
285-
To run the Task asynchronously, use the [Run task
286-
asynchronously](#/reference/actor-tasks/run-collection/run-task) endpoint
284+
To run the Task asynchronously, use the [Run Actor task](/api/v2/actor-task-runs-post) endpoint
287285
instead.
288286
");
289287
command.Arguments.Add(ActorTaskId);

‎src/cli/Apify.CLI/Commands/ActorTasksActorTaskRunSyncGetDatasetItemsPostCommandApiCommand.g.cs‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -300,8 +300,7 @@ otherwise the HTTP request fails with a timeout error (this won't abort
300300
input property, the Actor run uses the default value defined by the task (or the Actor's
301301
input schema if not defined by the task).
302302
303-
You can send all the same options in parameters as the [Get Dataset
304-
Items](#/reference/datasets/item-collection/get-items) API endpoint.
303+
You can send all the same options in parameters as the [Get dataset items](/api/v2/dataset-items-get) API endpoint.
305304
306305
Beware that it might be impossible to maintain an idle HTTP connection for
307306
an extended period, due to client timeout or network conditions. Make sure your HTTP client is
@@ -316,8 +315,7 @@ passed as the POST payload.
316315
Just make sure to specify the `Content-Type` header as `application/json`
317316
and that the input is an object.
318317
319-
To run the task asynchronously, use the [Run
320-
task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead.
318+
To run the task asynchronously, use the [Run Actor task](/api/v2/actor-task-runs-post) API endpoint instead.
321319
");
322320
command.Arguments.Add(ActorTaskId);
323321
command.Options.Add(Timeout);

‎src/cli/Apify.CLI/Commands/ActorTasksActorTaskRunSyncPostCommandApiCommand.g.cs‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,7 @@ passed as the POST payload.
156156
Just make sure to specify `Content-Type` header to be `application/json` and
157157
input to be an object.
158158
159-
To run the task asynchronously, use the [Run
160-
task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead.
159+
To run the task asynchronously, use the [Run Actor task](/api/v2/actor-task-runs-post) API endpoint instead.
161160
");
162161
command.Arguments.Add(ActorTaskId);
163162
command.Options.Add(Timeout);

‎src/cli/Apify.CLI/Commands/ActorTasksActorTaskRunsLastGetCommandApiCommand.g.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,17 @@ All the endpoints require an authentication token.
7171
Using the `status` query parameter you can ensure to only get a run with a certain status
7272
(e.g. `status=SUCCEEDED`). Similarly, the `origin` query parameter filters runs by the means
7373
by which they were started (e.g. `origin=API`). The output of this endpoint and other query
74-
parameters are the same as in the [Run object](/api/v2/actor-run-get) endpoint.
74+
parameters are the same as in the [Get Actor run](/api/v2/actor-run-get) endpoint.
7575
7676
##### Convenience endpoints for last Actor task run
7777
78-
* [Dataset](/api/v2/last-actor-task-runs-default-dataset)
78+
* [Last Actor task run's default dataset](/api/v2/last-actor-task-runs-default-dataset)
7979
80-
* [Key-value store](/api/v2/last-actor-task-runs-default-key-value-store)
80+
* [Last Actor task run's default key-value store](/api/v2/last-actor-task-runs-default-key-value-store)
8181
82-
* [Request queue](/api/v2/last-actor-task-runs-default-request-queue)
82+
* [Last Actor task run's default request queue](/api/v2/last-actor-task-runs-default-request-queue)
8383
84-
* [Log](/api/v2/last-actor-task-runs-log)
84+
* [Last Actor task run's log](/api/v2/last-actor-task-runs-log)
8585
");
8686
command.Arguments.Add(ActorTaskId);
8787
command.Options.Add(Status);

‎src/cli/Apify.CLI/Commands/ActorTasksActorTaskRunsPostCommandApiCommand.g.cs‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -134,18 +134,17 @@ public static Command Create(string? commandName = null)
134134
input property, the Actor run uses the default value defined by the task (or Actor's input
135135
schema if not defined by the task).
136136
137-
The response is the Actor Run object as returned by the [Get
138-
run](#/reference/actor-runs/run-object-and-its-storages/get-run) endpoint.
137+
The response is the Actor Run object as returned by the [Get Actor run](/api/v2/actor-run-get) endpoint.
139138
140139
If you want to wait for the run to finish and receive the actual output of
141-
the Actor run as the response, use one of the [Run task
142-
synchronously](#/reference/actor-tasks/run-task-synchronously) API endpoints
143-
instead.
140+
the Actor run as the response, use the [Run Actor task synchronously and get key-value store record](/api/v2/actor-task-run-sync-post)
141+
or [Run Actor task synchronously and get dataset items](/api/v2/actor-task-run-sync-get-dataset-items-post)
142+
endpoint instead.
144143
145144
To fetch the Actor run results that are typically stored in the default
146145
dataset, you'll need to pass the ID received in the `defaultDatasetId` field
147146
received in the response JSON to the
148-
[Get dataset items](#/reference/datasets/item-collection/get-items) API endpoint.
147+
[Get dataset items](/api/v2/dataset-items-get) API endpoint.
149148
");
150149
command.Arguments.Add(ActorTaskId);
151150
command.Options.Add(Timeout);

‎src/cli/Apify.CLI/Commands/ActorsActorBuildsActorOpenapiJsonGetCommandApiCommand.g.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ public static Command Create(string? commandName = null)
4848
var command = new Command(commandName ?? @"actor-openapi-json-get", @"Get OpenAPI definition of Actor build
4949
Get the OpenAPI definition for Actor builds. Two similar endpoints are available:
5050
51-
- [First endpoint](/api/v2/actor-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
51+
- [Get OpenAPI definition of Actor build](/api/v2/actor-openapi-json-get) (`/v2/actors/{actorId}/builds/{buildId}/openapi.json`): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
5252
53-
- [Second endpoint](/api/v2/actor-build-openapi-json-get): Requires only `buildId`.
53+
- [Get OpenAPI definition of Actor build](/api/v2/actor-build-openapi-json-get) (`/v2/actor-builds/{buildId}/openapi.json`): Requires only `buildId`.
5454
5555
Get the OpenAPI definition for a specific Actor build.
5656
@@ -59,7 +59,7 @@ Authentication is based on the build's unique ID. No authentication token is req
5959
6060
:::note
6161
62-
You can also use the [`/api/v2/actor-build-openapi-json-get`](/api/v2/actor-build-openapi-json-get) endpoint to get the OpenAPI definition for a build.
62+
You can also use the [Get OpenAPI definition of Actor build](/api/v2/actor-build-openapi-json-get) endpoint (`/v2/actor-builds/{buildId}/openapi.json`) to get the OpenAPI definition for a build.
6363
6464
:::
6565
");

0 commit comments

Comments
 (0)