Skip to content

Commit a2b018f

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

46 files changed

Lines changed: 1323 additions & 892 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/ActorRunsPostResurrectRunCommandApiCommand.g.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ that is being resurrected.
5555
private static Option<double?> MaxTotalChargeUsd { get; } = new(
5656
name: @"--max-total-charge-usd")
5757
{
58-
Description = @"Specifies the maximum cost of the run. This parameter is
59-
useful for pay-per-event Actors, as it allows you to limit the amount
60-
charged to your subscription. You can access the maximum cost in your Actor
58+
Description = @"Specifies the maximum total cost of the run.
59+
Use it to cap the total amount charged for all pricing models.
60+
You can access the maximum cost in your Actor
6161
by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable.
6262
",
6363
};

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,16 @@ internal static partial class ActorTasksActorTaskRunSyncGetCommandApiCommand
3939
",
4040
};
4141

42+
private static Option<double?> MaxTotalChargeUsd { get; } = new(
43+
name: @"--max-total-charge-usd")
44+
{
45+
Description = @"Specifies the maximum total cost of the run.
46+
Use it to cap the total amount charged for all pricing models.
47+
You can access the maximum cost in your Actor
48+
by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable.
49+
",
50+
};
51+
4252
private static Option<string?> Build { get; } = new(
4353
name: @"--build")
4454
{
@@ -117,6 +127,7 @@ endpoint instead.
117127
command.Options.Add(Timeout);
118128
command.Options.Add(Memory);
119129
command.Options.Add(MaxItems);
130+
command.Options.Add(MaxTotalChargeUsd);
120131
command.Options.Add(Build);
121132
command.Options.Add(OutputRecordKey);
122133
command.Options.Add(Webhooks);
@@ -129,6 +140,7 @@ await CliRuntime.RunAsync(async () =>
129140
var timeout = parseResult.GetValue(Timeout);
130141
var memory = parseResult.GetValue(Memory);
131142
var maxItems = parseResult.GetValue(MaxItems);
143+
var maxTotalChargeUsd = parseResult.GetValue(MaxTotalChargeUsd);
132144
var build = parseResult.GetValue(Build);
133145
var outputRecordKey = parseResult.GetValue(OutputRecordKey);
134146
var webhooks = parseResult.GetValue(Webhooks);
@@ -140,6 +152,7 @@ await CliRuntime.RunAsync(async () =>
140152
timeout: timeout,
141153
memory: memory,
142154
maxItems: maxItems,
155+
maxTotalChargeUsd: maxTotalChargeUsd,
143156
build: build,
144157
outputRecordKey: outputRecordKey,
145158
webhooks: webhooks,

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,16 @@ internal static partial class ActorTasksActorTaskRunSyncGetDatasetItemsGetComman
3939
",
4040
};
4141

42+
private static Option<double?> MaxTotalChargeUsd { get; } = new(
43+
name: @"--max-total-charge-usd")
44+
{
45+
Description = @"Specifies the maximum total cost of the run.
46+
Use it to cap the total amount charged for all pricing models.
47+
You can access the maximum cost in your Actor
48+
by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable.
49+
",
50+
};
51+
4252
private static Option<string?> Build { get; } = new(
4353
name: @"--build")
4454
{
@@ -277,6 +287,7 @@ and its status.
277287
command.Options.Add(Timeout);
278288
command.Options.Add(Memory);
279289
command.Options.Add(MaxItems);
290+
command.Options.Add(MaxTotalChargeUsd);
280291
command.Options.Add(Build);
281292
command.Options.Add(Webhooks);
282293
command.Options.Add(Format);
@@ -311,6 +322,7 @@ await CliRuntime.RunAsync(async () =>
311322
var timeout = parseResult.GetValue(Timeout);
312323
var memory = parseResult.GetValue(Memory);
313324
var maxItems = parseResult.GetValue(MaxItems);
325+
var maxTotalChargeUsd = parseResult.GetValue(MaxTotalChargeUsd);
314326
var build = parseResult.GetValue(Build);
315327
var webhooks = parseResult.GetValue(Webhooks);
316328
var format = parseResult.GetValue(Format);
@@ -344,6 +356,7 @@ await CliRuntime.RunAsync(async () =>
344356
timeout: timeout,
345357
memory: memory,
346358
maxItems: maxItems,
359+
maxTotalChargeUsd: maxTotalChargeUsd,
347360
build: build,
348361
webhooks: webhooks,
349362
format: format,

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ internal static partial class ActorTasksActorTaskRunSyncGetDatasetItemsPostComma
4242
private static Option<double?> MaxTotalChargeUsd { get; } = new(
4343
name: @"--max-total-charge-usd")
4444
{
45-
Description = @"Specifies the maximum cost of the run. This parameter is
46-
useful for pay-per-event Actors, as it allows you to limit the amount
47-
charged to your subscription. You can access the maximum cost in your Actor
45+
Description = @"Specifies the maximum total cost of the run.
46+
Use it to cap the total amount charged for all pricing models.
47+
You can access the maximum cost in your Actor
4848
by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable.
4949
",
5050
};

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ internal static partial class ActorTasksActorTaskRunSyncPostCommandApiCommand
4242
private static Option<double?> MaxTotalChargeUsd { get; } = new(
4343
name: @"--max-total-charge-usd")
4444
{
45-
Description = @"Specifies the maximum cost of the run. This parameter is
46-
useful for pay-per-event Actors, as it allows you to limit the amount
47-
charged to your subscription. You can access the maximum cost in your Actor
45+
Description = @"Specifies the maximum total cost of the run.
46+
Use it to cap the total amount charged for all pricing models.
47+
You can access the maximum cost in your Actor
4848
by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable.
4949
",
5050
};

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ internal static partial class ActorTasksActorTaskRunsPostCommandApiCommand
4242
private static Option<double?> MaxTotalChargeUsd { get; } = new(
4343
name: @"--max-total-charge-usd")
4444
{
45-
Description = @"Specifies the maximum cost of the run. This parameter is
46-
useful for pay-per-event Actors, as it allows you to limit the amount
47-
charged to your subscription. You can access the maximum cost in your Actor
45+
Description = @"Specifies the maximum total cost of the run.
46+
Use it to cap the total amount charged for all pricing models.
47+
You can access the maximum cost in your Actor
4848
by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable.
4949
",
5050
};

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ private static string FormatResponse(ParseResult parseResult, string value, glob
3636
public static Command Create()
3737
{
3838
var command = new Command(@"act-delete", @"Delete Actor
39-
Deletes an Actor.");
39+
Deletes an Actor with the specified ID.");
4040
command.Arguments.Add(ActorId);
4141

4242

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

Lines changed: 68 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,18 @@ internal static partial class ActorsActPutCommandApiCommand
1616
private static Option<string?> NameOption { get; } = new(
1717
name: @"--name")
1818
{
19-
Description = @"",
19+
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.",
2020
};
2121

2222
private static Option<string?> DescriptionOption { get; } = new(
2323
name: @"--description")
2424
{
25-
Description = @"",
25+
Description = @"Short description of the Actor, displayed in Apify Store and Console.",
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<global::Apify.ActorPermissionLevel?> ActorPermissionLevel { get; } = new(
3333
name: @"--actor-permission-level")
@@ -38,25 +38,25 @@ internal static partial class ActorsActPutCommandApiCommand
3838
private static Option<string?> SeoTitle { get; } = new(
3939
name: @"--seo-title")
4040
{
41-
Description = @"",
41+
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.",
4242
};
4343

4444
private static Option<string?> SeoDescription { get; } = new(
4545
name: @"--seo-description")
4646
{
47-
Description = @"",
47+
Description = @"Description of the Actor to display by search engines such as Google. Recommended length is 140-156 characters.",
4848
};
4949

5050
private static Option<string?> Title { get; } = new(
5151
name: @"--title")
5252
{
53-
Description = @"",
53+
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.",
5454
};
5555

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

6262
private static Option<global::System.Collections.Generic.IList<global::Apify.ActorRunPricingInfo>?> PricingInfos { get; } = new(
@@ -68,56 +68,18 @@ internal static partial class ActorsActPutCommandApiCommand
6868
private static Option<global::System.Collections.Generic.IList<string>?> Categories { get; } = new(
6969
name: @"--categories")
7070
{
71-
Description = @"",
71+
Description = @"A list of categories that best define the Actor. Reflected in Apify Store's search and filtering options.",
7272
};
7373

7474
private static Option<global::System.Collections.Generic.Dictionary<string, global::Apify.BuildTag?>?> TaggedBuilds { get; } = new(
7575
name: @"--tagged-builds")
7676
{
77-
Description = @"An object to modify tags on the Actor's builds. The key is the tag name (e.g., _latest_), and the value is either an object with a `buildId` or `null`.
78-
79-
This operation is a patch; any existing tags that you omit from this object will be preserved.
80-
81-
- **To create or reassign a tag**, provide the tag name with a `buildId`. e.g., to assign the _latest_ tag:
82-
83-
&nbsp;
84-
85-
```json
86-
{
87-
""latest"": {
88-
""buildId"": ""z2EryhbfhgSyqj6Hn""
89-
}
90-
}
91-
```
92-
93-
- **To remove a tag**, provide the tag name with a `null` value. e.g., to remove the _beta_ tag:
94-
95-
&nbsp;
96-
97-
```json
98-
{
99-
""beta"": null
100-
}
101-
```
102-
103-
- **To perform multiple operations**, combine them. The following reassigns _latest_ and removes _beta_, while preserving any other existing tags.
104-
105-
&nbsp;
106-
107-
```json
108-
{
109-
""latest"": {
110-
""buildId"": ""z2EryhbfhgSyqj6Hn""
111-
},
112-
""beta"": null
113-
}
114-
```
115-
",
77+
Description = @"A dictionary that maps tag names to specific builds. For details, see [Update build tags](#update-build-tags).",
11678
};
11779

11880
private static Option<bool?> IsDeprecated { get; } = CliRuntime.CreateNullableBoolOption(
11981
name: @"--is-deprecated",
120-
description: @"");
82+
description: @"Whether the Actor is deprecated.");
12183
private static readonly DefaultRunOptionsOptionSet DefaultRunOptionsOptions = DefaultRunOptionsOptionSet.Create(@"default-run");
12284

12385
private static readonly ActorStandbyOptionSet ActorStandbyOptions = ActorStandbyOptionSet.Create(@"actor-standby");
@@ -163,26 +125,64 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.Acto
163125
public static Command Create()
164126
{
165127
var command = new Command(@"act-put", @"Update Actor
166-
Updates settings of an Actor using values specified by an Actor object
167-
passed as JSON in the POST payload.
168-
If the object does not define a specific property, its value will not be
169-
updated.
170-
171-
The response is the full Actor object as returned by the
172-
[Get Actor](#/reference/actors/actor-object/get-actor) endpoint.
173-
174-
The request needs to specify the `Content-Type: application/json` HTTP header!
175-
176-
When providing your API authentication token, we recommend using the
177-
request's `Authorization` header, rather than the URL. ([More
178-
info](#/introduction/authentication)).
179-
180-
If you want to make your Actor
181-
[public](https://docs.apify.com/platform/actors/publishing) using `isPublic:
182-
true`, you will need to provide the Actor's `title` and the `categories`
183-
under which that Actor will be classified in Apify Store. For this, it's
184-
best to use the [constants from our `apify-shared-js`
185-
package](https://github.com/apify/apify-shared-js/blob/2d43ebc41ece9ad31cd6525bd523fb86939bf860/packages/consts/src/consts.ts#L452-L471).
128+
Updates an Actor's settings with the values specified in an `Actor` object
129+
passed as JSON in the POST payload. Only the fields specified in the request body are updated.
130+
131+
Returns the full `Actor` object, the same as the
132+
[Get Actor](/api/v2/act-get) endpoint.
133+
134+
In the HTTP request, set the `Content-Type` header to `application/json`.
135+
136+
### Authentication
137+
138+
To provide the authentication token, we recommend using the request's
139+
`Authorization` header, rather than the URL. For details,
140+
see [Authentication](/api/v2/getting-started#authentication).
141+
142+
### Make an Actor public
143+
144+
To make your Actor [public](https://docs.apify.com/platform/actors/publishing):
145+
- Set `isPublic` to `true`.
146+
- Provide `title` and `categories`. For reference, see [constants from the `apify-shared-js`
147+
package](https://github.com/apify/apify-shared-js/blob/2d43ebc41ece9ad31cd6525bd523fb86939bf860/packages/consts/src/consts.ts#L452-L471)
148+
149+
### Update build tags
150+
151+
To change tags assigned to Actor builds, use the `taggedBuilds` object. It's a dictionary that maps tag names
152+
to specific builds, where:
153+
- the key is the tag name, for example `latest` or `beta`
154+
- the value is either `null` or an object with a build ID
155+
156+
Changing tags is a patch operation. Only the tags that you provide in this object are updated.
157+
158+
Note that you can assign multiple tags to a single build, but you can't assign the same tag to multiple builds.
159+
160+
- To create or reassign a tag, provide the tag name with a build ID. For example, to assign
161+
the `latest` tag to a build, use:
162+
163+
```json
164+
{
165+
""latest"": { ""buildId"": ""z2EryhbfhgSyqj6Hn"" }
166+
}
167+
```
168+
169+
- To remove a tag from a build, provide the tag name with a `null` value. For example, to remove the `beta` tag, use:
170+
171+
```json
172+
{
173+
""beta"": null
174+
}
175+
```
176+
177+
- You can perform multiple actions at once. The following example reassigns `latest`
178+
and removes `beta`, while preserving other existing tags:
179+
180+
```json
181+
{
182+
""latest"": { ""buildId"": ""z2EryhbfhgSyqj6Hn"" },
183+
""beta"": null
184+
}
185+
```
186186
");
187187
command.Arguments.Add(ActorId);
188188
command.Options.Add(NameOption);

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ response. Defaults to `OUTPUT`. Actors aren't required to store a record
5151
private static Option<double?> MaxTotalChargeUsd { get; } = new(
5252
name: @"--max-total-charge-usd")
5353
{
54-
Description = @"Specifies the maximum cost of the run. This parameter is
55-
useful for pay-per-event Actors, as it allows you to limit the amount
56-
charged to your subscription. You can access the maximum cost in your Actor
54+
Description = @"Specifies the maximum total cost of the run.
55+
Use it to cap the total amount charged for all pricing models.
56+
You can access the maximum cost in your Actor
5757
by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable.
5858
",
5959
};

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ internal static partial class ActorsActorRunsActRunSyncGetDatasetItemsGetCommand
4242
private static Option<double?> MaxTotalChargeUsd { get; } = new(
4343
name: @"--max-total-charge-usd")
4444
{
45-
Description = @"Specifies the maximum cost of the run. This parameter is
46-
useful for pay-per-event Actors, as it allows you to limit the amount
47-
charged to your subscription. You can access the maximum cost in your Actor
45+
Description = @"Specifies the maximum total cost of the run.
46+
Use it to cap the total amount charged for all pricing models.
47+
You can access the maximum cost in your Actor
4848
by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable.
4949
",
5050
};

0 commit comments

Comments
 (0)