Skip to content
Merged
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.Buil

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"abort-post", @"Abort build
var command = new Command(commandName ?? @"abort-post", @"Abort Actor build
Aborts an Actor build and returns an object that contains all the details
about the build.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ internal static partial class ActorBuildsActorBuildDeleteCommandApiCommand

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"delete", @"Delete build
var command = new Command(commandName ?? @"delete", @"Delete Actor build
Delete the build. The build that is the current default build for the Actor
cannot be deleted.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.Buil

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"get", @"Get build
var command = new Command(commandName ?? @"get", @"Get Actor build
Gets an object that contains all the details about a specific build of an
Actor.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ private static string FormatResponse(ParseResult parseResult, string value, glob

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"log-get", @"Get build's Log
var command = new Command(commandName ?? @"log-get", @"Get Actor build's log
Retrieves Actor build's logs.

This endpoint is a shortcut for getting the build's log. Same as [Get log](/api/v2/log-get) endpoint.
This endpoint is a shortcut for getting the build's log. Same as [Get Actor build or run log](/api/v2/log-get) endpoint.
");
command.Arguments.Add(BuildId);
command.Options.Add(Stream);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ private static string FormatResponse(ParseResult parseResult, string value, glob

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"openapi-json-get", @"Get OpenAPI definition
var command = new Command(commandName ?? @"openapi-json-get", @"Get OpenAPI definition of Actor build
Get the OpenAPI definition for Actor builds. Two similar endpoints are available:

- [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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.List

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"get-2", @"Get user builds list
var command = new Command(commandName ?? @"get-2", @"Get list of user's Actor builds
Gets a list of all builds for a user. The response is a JSON array of
objects, where each object contains basic information about a single build.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.RunR

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"abort-post", @"Abort run
var command = new Command(commandName ?? @"abort-post", @"Abort Actor run
Aborts an Actor run and returns an object that contains all the details
about the run.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ internal static partial class ActorRunsActorRunDeleteCommandApiCommand

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"delete", @"Delete run
var command = new Command(commandName ?? @"delete", @"Delete Actor run
Delete the run. Only finished runs can be deleted. Only the person or
organization that initiated the run can delete it.
");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.RunR

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"get", @"Get run
var command = new Command(commandName ?? @"get", @"Get Actor run
This is not a single endpoint, but an entire group of endpoints that lets
you retrieve the run or any of its default storages.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ private static string FormatResponse(ParseResult parseResult, string value, glob

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"log-get", @"Get run's log
var command = new Command(commandName ?? @"log-get", @"Get log of an Actor run
Retrieves Actor run's logs.

This endpoint is a shortcut for getting the run's log. Same as [Get log](/api/v2/log-get) endpoint.
This endpoint is a shortcut for getting the run's log. Same as [Get Actor build or run log](/api/v2/log-get) endpoint.
");
command.Arguments.Add(RunId);
command.Options.Add(Stream);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.RunR

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"metamorph-post", @"Metamorph run
var command = new Command(commandName ?? @"metamorph-post", @"Metamorph Actor run
Transforms an Actor run into a run of another Actor with a new input.

This is useful if you want to use another Actor to finish the work
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.RunR

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"put", @"Update run
var command = new Command(commandName ?? @"put", @"Update Actor run
This endpoint can be used to update both the run's status message and to configure its general resource access level.

**Status message:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.RunR

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"reboot-post", @"Reboot run
var command = new Command(commandName ?? @"reboot-post", @"Reboot Actor run
Reboots an Actor run and returns an object that contains all the details
about the rebooted run.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.List

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"get-2", @"Get user runs list
var command = new Command(commandName ?? @"get-2", @"Get list of user's Actor runs
Gets a list of all runs for a user. The response is a list of objects, where
each object contains basic information about a single Actor run.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.Post

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"post-charge-run", @"Charge events in run
var command = new Command(commandName ?? @"post-charge-run", @"Charge events in Actor run
Charge for events in the run of your [pay per event Actor](https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event).
The event you are charging for must be one of the configured events in your Actor. If the Actor is not set up as pay per event, or if the event is not configured,
the endpoint will return an error. The endpoint must be called from the Actor run itself, with the same API token that the run was started with.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.RunR

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"post-resurrect-run", @"Resurrect run
var command = new Command(commandName ?? @"post-resurrect-run", @"Resurrect Actor run
Resurrects a finished Actor run and returns an object that contains all the details about the resurrected run.
Only finished runs, i.e. runs with status `FINISHED`, `FAILED`, `ABORTED` and `TIMED-OUT` can be resurrected.
Run status will be updated to RUNNING and its container will be restarted with the same storages
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ private static string FormatResponse(ParseResult parseResult, string value, glob

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"delete", @"Delete task
var command = new Command(commandName ?? @"delete", @"Delete Actor task
Delete the task specified through the `actorTaskId` parameter.");
command.Arguments.Add(ActorTaskId);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.Acto

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"get", @"Get task
var command = new Command(commandName ?? @"get", @"Get Actor task
Get an object that contains all the details about a task.");
command.Arguments.Add(ActorTaskId);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ private static string FormatResponse(ParseResult parseResult, string value, glob

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"input-get", @"Get task input
var command = new Command(commandName ?? @"input-get", @"Get Actor task input
Returns the input of a given task.");
command.Arguments.Add(ActorTaskId);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ private static string FormatResponse(ParseResult parseResult, string value, glob

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"input-put", @"Update task input
var command = new Command(commandName ?? @"input-put", @"Update Actor task input
Updates the input of a task using values specified by an object passed as
JSON in the PUT payload.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.Acto

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"put", @"Update task
var command = new Command(commandName ?? @"put", @"Update Actor task
Update settings of a task using values specified by an object passed as JSON
in the POST payload.

Expand All @@ -124,7 +124,7 @@ including those unrelated to publishing.
offered while the task stays published and copyable.

The response is the full task object as returned by the
[Get task](/api/v2/actor-task-get) endpoint.
[Get Actor task](/api/v2/actor-task-get) endpoint.

The request needs to specify the `Content-Type: application/json` HTTP
header!
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ private static string FormatResponse(ParseResult parseResult, string value, glob

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"run-sync-get", @"Run task synchronously
var command = new Command(commandName ?? @"run-sync-get", @"Run Actor task synchronously and get key-value store record (GET)
Runs an Actor task and synchronously returns a key-value store record.

The response contains the record stored under the `OUTPUT` key in the run's
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ private static string FormatResponse(ParseResult parseResult, string value, glob

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"run-sync-get-dataset-items-get", @"Run task synchronously and get dataset items
var command = new Command(commandName ?? @"run-sync-get-dataset-items-get", @"Run Actor task synchronously and get dataset items (GET)
Run a specific task and return its dataset items.

The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ private static string FormatResponse(ParseResult parseResult, string value, glob

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"run-sync-get-dataset-items-post", @"Run task synchronously and get dataset items
var command = new Command(commandName ?? @"run-sync-get-dataset-items-post", @"Run Actor task synchronously and get dataset items
Runs an Actor task and synchronously returns its dataset items.

The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ private static string FormatResponse(ParseResult parseResult, string value, glob

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"run-sync-post", @"Run task synchronously
var command = new Command(commandName ?? @"run-sync-post", @"Run Actor task synchronously and get key-value store record
Runs an Actor task and synchronously returns a key-value store record.

The response contains the record stored under the `OUTPUT` key in the run's
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.Acto

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"runs-get", @"Get list of task runs
var command = new Command(commandName ?? @"runs-get", @"Get list of Actor task's runs
Get a list of runs of a specific task. The response is a list of objects,
where each object contains essential information about a single task run.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.Acto

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"runs-last-get", @"Get last run
var command = new Command(commandName ?? @"runs-last-get", @"Get last run of an Actor task
This is not a single endpoint, but an entire group of endpoints that lets you to
retrieve and manage the last run of given actor task or any of its default storages.
All the endpoints require an authentication token.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.Acto

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"runs-post", @"Run task
var command = new Command(commandName ?? @"runs-post", @"Run Actor task
Runs an Actor task and immediately returns without waiting for the run to
finish.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.Acto

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"webhooks-get", @"Get list of webhooks
var command = new Command(commandName ?? @"webhooks-get", @"Get list of Actor task's webhooks
Gets the list of webhooks of a specific Actor task. The response is a JSON
with the list of objects, where each object contains basic information about a single webhook.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.List

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"get-2", @"Get list of tasks
var command = new Command(commandName ?? @"get-2", @"Get list of Actor tasks
Gets the complete list of tasks that a user has created or used.

The response is a list of objects in which each object contains essential
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,12 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.Task

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"post", @"Create task
var command = new Command(commandName ?? @"post", @"Create Actor task
Create a new task with settings specified by the object passed as JSON in
the POST payload.

The response is the full task object as returned by the
[Get task](/api/v2/actor-task-get) endpoint.
[Get Actor task](/api/v2/actor-task-get) endpoint.

The request needs to specify the `Content-Type: application/json` HTTP header!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.Buil

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"actor-build-default-get", @"Get default build
var command = new Command(commandName ?? @"actor-build-default-get", @"Get default Actor build
Get the default build for an Actor.

Use the optional `waitForFinish` parameter to synchronously wait for the build to finish.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ private static string FormatResponse(ParseResult parseResult, string value, glob

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"actor-openapi-json-get", @"Get OpenAPI definition
var command = new Command(commandName ?? @"actor-openapi-json-get", @"Get OpenAPI definition of Actor build
Get the OpenAPI definition for Actor builds. Two similar endpoints are available:

- [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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.List

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"actors-builds-get", @"Get list of builds
var command = new Command(commandName ?? @"actors-builds-get", @"Get list of Actor's builds
Gets the list of builds of a specific Actor. The response is a JSON with the
list of objects, where each object contains basic information about a single build.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ internal static partial class ActorsActorPutCommandApiCommand
private static Option<global::System.Collections.Generic.IList<global::Apify.ActorRunPricingInfo>?> PricingInfos { get; } = new(
name: @"--pricing-infos")
{
Description = @"",
Description = @"The Actor's pricing records. You can't add the `FLAT_PRICE_PER_MONTH` or `PRICE_PER_DATASET_ITEM` records, because these pricing models are no longer supported.",
};

private static Option<global::System.Collections.Generic.IList<string>?> Categories { get; } = new(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.RunR

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"actor-run-resurrect-post", @"Resurrect run
var command = new Command(commandName ?? @"actor-run-resurrect-post", @"Resurrect Actor run
**[DEPRECATED]** API endpoints related to run of the Actor were moved under
new namespace [`actor-runs`](#/reference/actor-runs).Resurrects a finished
Actor run and returns an object that contains all the details about the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ private static string FormatResponse(ParseResult parseResult, string value, glob

public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"actor-run-sync-get", @"Run Actor synchronously without input
var command = new Command(commandName ?? @"actor-run-sync-get", @"Run Actor synchronously and get key-value store record (GET)
Runs a specific Actor and returns a key-value store record. The response contains the
record stored under the `OUTPUT` key in the run's default key-value store.
This is a legacy approach that has been replaced by the Actor
Expand Down
Loading
Loading