Skip to content

Commit ea6a187

Browse files
HavenDVgithub-actions[bot]
andauthored
feat: Updated OpenAPI spec (#79)
Co-authored-by: github-actions[bot] <dependabot@bot.com>
1 parent 4aadc48 commit ea6a187

25 files changed

Lines changed: 790 additions & 292 deletions

src/cli/Apify.CLI/Commands/ActorStandbyOptionSet.g.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,29 +20,29 @@ public static ActorStandbyOptionSet Create(string? prefix = null)
2020
? string.Empty
2121
: prefix.Trim().Trim('-') + "-";
2222
return new ActorStandbyOptionSet(
23-
IsEnabled: CliRuntime.CreateNullableBoolOption(name: $"--{normalizedPrefix}is-enabled", description: @""),
23+
IsEnabled: CliRuntime.CreateNullableBoolOption(name: $"--{normalizedPrefix}is-enabled", description: @"Whether standby mode is enabled for the Actor."),
2424
DesiredRequestsPerActorRun: new Option<int?>($"--{normalizedPrefix}desired-requests-per-actor-run")
2525
{
26-
Description = @"",
26+
Description = @"Target number of concurrent HTTP requests a single run is configured to handle.",
2727
},
2828
MaxRequestsPerActorRun: new Option<int?>($"--{normalizedPrefix}max-requests-per-actor-run")
2929
{
30-
Description = @"",
30+
Description = @"Maximum number of concurrent HTTP requests that can be routed to a single run.",
3131
},
3232
IdleTimeoutSecs: new Option<int?>($"--{normalizedPrefix}idle-timeout-secs")
3333
{
34-
Description = @"",
34+
Description = @"In seconds, how long a run can stay idle without incoming requests before it's terminated.",
3535
},
3636
Build: new Option<string?>($"--{normalizedPrefix}build")
3737
{
38-
Description = @"",
38+
Description = @"Which build to run in standby mode. Either a build tag or a version number.",
3939
},
4040
MemoryMbytes: new Option<long?>($"--{normalizedPrefix}memory-mbytes")
4141
{
42-
Description = @"",
42+
Description = @"In MB, the amount of memory allocated to the run.",
4343
},
44-
DisableStandbyFieldsOverride: CliRuntime.CreateNullableBoolOption(name: $"--{normalizedPrefix}disable-standby-fields-override", description: @""),
45-
ShouldPassActorInput: CliRuntime.CreateNullableBoolOption(name: $"--{normalizedPrefix}should-pass-actor-input", description: @"")
44+
DisableStandbyFieldsOverride: CliRuntime.CreateNullableBoolOption(name: $"--{normalizedPrefix}disable-standby-fields-override", description: @"If `true`, prevents the standby mode configuration from being overridden elsewhere."),
45+
ShouldPassActorInput: CliRuntime.CreateNullableBoolOption(name: $"--{normalizedPrefix}should-pass-actor-input", description: @"Whether to pass the Actor's input to the standby run. If `false`, the standby runs start with no input.")
4646
);
4747
}
4848
}

src/cli/Apify.CLI/Commands/ActorsActsPostCommandApiCommand.g.cs

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,41 +10,41 @@ internal static partial class ActorsActsPostCommandApiCommand
1010
private static Option<string?> NameOption { get; } = new(
1111
name: @"--name")
1212
{
13-
Description = @"",
13+
Description = @"The identifier of the Actor. Use lowercase letters, numbers, and hyphens. Spaces or special characters aren't allowed. Must be unique across your account.",
1414
};
1515

1616
private static Option<string?> DescriptionOption { get; } = new(
1717
name: @"--description")
1818
{
19-
Description = @"",
19+
Description = @"Short description of the Actor, displayed in Apify Store and Console.",
2020
};
2121

2222
private static Option<string?> Title { get; } = new(
2323
name: @"--title")
2424
{
25-
Description = @"",
25+
Description = @"Human-readable name of the Actor, displayed in Apify Store and Console. Can contain spaces and capital letters. Recommended length is 40-50 characters. You can change this title without affecting the Actor's URL or SEO.",
2626
};
2727

2828
private static Option<bool?> IsPublic { get; } = CliRuntime.CreateNullableBoolOption(
2929
name: @"--is-public",
30-
description: @"");
30+
description: @"Whether the Actor is available to users in Apify Store. If `false`, the Actor is private and only visible to you.");
3131

3232
private static Option<string?> SeoTitle { get; } = new(
3333
name: @"--seo-title")
3434
{
35-
Description = @"",
35+
Description = @"Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Apify Store and Console. Recommended length is 40-50 characters.",
3636
};
3737

3838
private static Option<string?> SeoDescription { get; } = new(
3939
name: @"--seo-description")
4040
{
41-
Description = @"",
41+
Description = @"Description of the Actor to display by search engines such as Google. Recommended length is 140-156 characters.",
4242
};
4343

4444
private static Option<global::System.Collections.Generic.IList<global::Apify.Version>?> Versions { get; } = new(
4545
name: @"--versions")
4646
{
47-
Description = @"",
47+
Description = @"An array of `Version` objects. Each object represents a specific version of the Actor's source code: its location, builds, and environment configuration.",
4848
};
4949

5050
private static Option<global::System.Collections.Generic.IList<global::Apify.ActorRunPricingInfo>?> PricingInfos { get; } = new(
@@ -56,12 +56,12 @@ internal static partial class ActorsActsPostCommandApiCommand
5656
private static Option<global::System.Collections.Generic.IList<string>?> Categories { get; } = new(
5757
name: @"--categories")
5858
{
59-
Description = @"",
59+
Description = @"A list of categories that best define the Actor. Reflected in Apify Store's search and filtering options.",
6060
};
6161

6262
private static Option<bool?> IsDeprecated { get; } = CliRuntime.CreateNullableBoolOption(
6363
name: @"--is-deprecated",
64-
description: @"");
64+
description: @"Whether the Actor is deprecated.");
6565
private static readonly DefaultRunOptionsOptionSet DefaultRunOptionsOptions = DefaultRunOptionsOptionSet.Create(@"default-run");
6666

6767
private static readonly ActorStandbyOptionSet ActorStandbyOptions = ActorStandbyOptionSet.Create(@"actor-standby");
@@ -107,22 +107,25 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.Acto
107107
public static Command Create()
108108
{
109109
var command = new Command(@"acts-post", @"Create Actor
110-
Creates a new Actor with settings specified in an Actor object passed as
110+
Creates an Actor with the settings specified in an `Actor` object passed as
111111
JSON in the POST payload.
112-
The response is the full Actor object as returned by the
113-
[Get Actor](#/reference/actors/actor-object/get-actor) endpoint.
114112
115-
The HTTP request must have the `Content-Type: application/json` HTTP header!
113+
Returns the full `Actor` object, the same as the
114+
[Get Actor](/api/v2/act-get) endpoint.
115+
116+
In the HTTP request, set the `Content-Type` header to `application/json`.
117+
118+
### Define a source code version
119+
120+
An Actor must specify at least one version of the source code.
121+
For details, see [Actor versions](/api/v2/actors-actor-versions).
116122
117-
The Actor needs to define at least one version of the source code.
118-
For more information, see [Version object](#/reference/actors/version-object).
123+
### Create a public Actor
119124
120-
If you want to make your Actor
121-
[public](https://docs.apify.com/platform/actors/publishing) using `isPublic:
122-
true`, you will need to provide the Actor's `title` and the `categories`
123-
under which that Actor will be classified in Apify Store. For this, it's
124-
best to use the [constants from our `apify-shared-js`
125-
package](https://github.com/apify/apify-shared-js/blob/2d43ebc41ece9ad31cd6525bd523fb86939bf860/packages/consts/src/consts.ts#L452-L471).
125+
To make your Actor [public](https://docs.apify.com/platform/actors/publishing):
126+
- Set `isPublic` to `true`.
127+
- Provide `title` and `categories`. For reference, see [constants from the `apify-shared-js`
128+
package](https://github.com/apify/apify-shared-js/blob/2d43ebc41ece9ad31cd6525bd523fb86939bf860/packages/consts/src/consts.ts#L452-L471)
126129
");
127130
command.Options.Add(NameOption);
128131
command.Options.Add(DescriptionOption);

src/cli/Apify.CLI/Commands/DefaultRunOptionsOptionSet.g.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,20 @@ public static DefaultRunOptionsOptionSet Create(string? prefix = null)
1919
return new DefaultRunOptionsOptionSet(
2020
Build: new Option<string?>($"--{normalizedPrefix}build")
2121
{
22-
Description = @"",
22+
Description = @"Which build to run. Either a build tag or a version number.",
2323
},
2424
TimeoutSecs: new Option<int?>($"--{normalizedPrefix}timeout-secs")
2525
{
26-
Description = @"",
26+
Description = @"Timeout in seconds. 0 if no timeout.",
2727
},
2828
MemoryMbytes: new Option<long?>($"--{normalizedPrefix}memory-mbytes")
2929
{
30-
Description = @"",
30+
Description = @"In MB, the amount of memory allocated to the run.",
3131
},
32-
RestartOnError: CliRuntime.CreateNullableBoolOption(name: $"--{normalizedPrefix}restart-on-error", description: @""),
32+
RestartOnError: CliRuntime.CreateNullableBoolOption(name: $"--{normalizedPrefix}restart-on-error", description: @"Whether to automatically restart the run if it fails."),
3333
MaxItems: new Option<int?>($"--{normalizedPrefix}max-items")
3434
{
35-
Description = @"",
35+
Description = @"Maximum number of items the run might produce.",
3636
}
3737
);
3838
}

src/cli/Apify.CLI/Commands/ExampleRunInputOptionSet.g.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ public static ExampleRunInputOptionSet Create(string? prefix = null)
1616
return new ExampleRunInputOptionSet(
1717
Body: new Option<string?>($"--{normalizedPrefix}body")
1818
{
19-
Description = @"",
19+
Description = @"Sample input, serialized as a string.",
2020
},
2121
ContentType: new Option<string?>($"--{normalizedPrefix}content-type")
2222
{
23-
Description = @"",
23+
Description = @"MIME type of `body`.",
2424
}
2525
);
2626
}

0 commit comments

Comments
 (0)