Skip to content

feat: Updated OpenAPI spec #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HavenDV merged 1 commit into from
Nov 2, 2026
Merged

feat: Updated OpenAPI spec #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/cli/Apify.CLI/Commands/ActorsActorVersionsActorVersionsPostCommandApiCommand.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ internal static partial class ActorsActorVersionsActorVersionsPostCommandApiComm
private static Option<string?> TarballUrl { get; } = new(
name: @"--tarball-url")
{
Description = @"URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.",
Description = @"URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`.",
};

private static Option<string?> GitHubGistUrl { get; } = new(
Expand Down
2 changes: 1 addition & 1 deletion src/cli/Apify.CLI/Commands/UpdateVersionRequestOptionSet.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public static UpdateVersionRequestOptionSet Create(string? prefix = null)
},
TarballUrl: new Option<string?>($"--{normalizedPrefix}tarball-url")
{
Description = @"URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.",
Description = @"URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`.",
},
GitHubGistUrl: new Option<string?>($"--{normalizedPrefix}git-hub-gist-url")
{
Expand Down
2 changes: 1 addition & 1 deletion src/libs/Apify/Generated/Apify.ActorsActorVersionsClient.ActorVersionPost.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -790,7 +790,7 @@ partial void ProcessActorVersionPostResponseContent(
/// URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`.
/// </param>
/// <param name="tarballUrl">
/// URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// </param>
/// <param name="gitHubGistUrl">
/// URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`.
Expand Down
2 changes: 1 addition & 1 deletion src/libs/Apify/Generated/Apify.ActorsActorVersionsClient.ActorVersionPut.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -814,7 +814,7 @@ partial void ProcessActorVersionPutResponseContent(
/// URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`.
/// </param>
/// <param name="tarballUrl">
/// URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// </param>
/// <param name="gitHubGistUrl">
/// URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`.
Expand Down
2 changes: 1 addition & 1 deletion src/libs/Apify/Generated/Apify.ActorsActorVersionsClient.ActorVersionsPost.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -840,7 +840,7 @@ partial void ProcessActorVersionsPostResponseContent(
/// URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`.
/// </param>
/// <param name="tarballUrl">
/// URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// </param>
/// <param name="gitHubGistUrl">
/// URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`.
Expand Down
2 changes: 1 addition & 1 deletion src/libs/Apify/Generated/Apify.ApifyClient.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ public sealed partial class ApifyClient : global::Apify.IApifyClient, global::Sy
/// |---|---|<br/>
/// | `"SOURCE_FILES"` | Source code is comprised of multiple files specified in the `sourceFiles` array. Each item of the array is an object with the following fields:&lt;br/&gt; - `name`: File path and name&lt;br/&gt; - `format`: Format of the content, can be either `"TEXT"` or `"BASE64"`&lt;br/&gt; - `content`: File content&lt;br/&gt;&lt;br/&gt;Source files can be shown and edited in the Apify Console's Web IDE. |<br/>
/// | `"GIT_REPO"` | Source code is cloned from a Git repository, whose URL is specified in the `gitRepoUrl` field. |<br/>
/// | `"TARBALL"` | Source code is downloaded using a tarball or Zip file from a URL specified in the `tarballUrl` field. |<br/>
/// | `"TARBALL"` | Source code is downloaded as a zip archive from a URL specified in the `tarballUrl` field. |<br/>
/// |`"GITHUB_GIST"`| Source code is taken from a GitHub Gist, whose URL is specified in the `gitHubGistUrl` field. |<br/>
/// For more information about source code and Actor versions, check out [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code)<br/>
/// in Actors documentation.
Expand Down
2 changes: 1 addition & 1 deletion src/libs/Apify/Generated/Apify.IActorsActorVersionsClient.ActorVersionPost.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public partial interface IActorsActorVersionsClient
/// URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`.
/// </param>
/// <param name="tarballUrl">
/// URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// </param>
/// <param name="gitHubGistUrl">
/// URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`.
Expand Down
2 changes: 1 addition & 1 deletion src/libs/Apify/Generated/Apify.IActorsActorVersionsClient.ActorVersionPut.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ public partial interface IActorsActorVersionsClient
/// URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`.
/// </param>
/// <param name="tarballUrl">
/// URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// </param>
/// <param name="gitHubGistUrl">
/// URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`.
Expand Down
2 changes: 1 addition & 1 deletion src/libs/Apify/Generated/Apify.IActorsActorVersionsClient.ActorVersionsPost.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ public partial interface IActorsActorVersionsClient
/// URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`.
/// </param>
/// <param name="tarballUrl">
/// URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// </param>
/// <param name="gitHubGistUrl">
/// URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`.
Expand Down
2 changes: 1 addition & 1 deletion src/libs/Apify/Generated/Apify.IApifyClient.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ public partial interface IApifyClient : global::System.IDisposable
/// |---|---|<br/>
/// | `"SOURCE_FILES"` | Source code is comprised of multiple files specified in the `sourceFiles` array. Each item of the array is an object with the following fields:&lt;br/&gt; - `name`: File path and name&lt;br/&gt; - `format`: Format of the content, can be either `"TEXT"` or `"BASE64"`&lt;br/&gt; - `content`: File content&lt;br/&gt;&lt;br/&gt;Source files can be shown and edited in the Apify Console's Web IDE. |<br/>
/// | `"GIT_REPO"` | Source code is cloned from a Git repository, whose URL is specified in the `gitRepoUrl` field. |<br/>
/// | `"TARBALL"` | Source code is downloaded using a tarball or Zip file from a URL specified in the `tarballUrl` field. |<br/>
/// | `"TARBALL"` | Source code is downloaded as a zip archive from a URL specified in the `tarballUrl` field. |<br/>
/// |`"GITHUB_GIST"`| Source code is taken from a GitHub Gist, whose URL is specified in the `gitHubGistUrl` field. |<br/>
/// For more information about source code and Actor versions, check out [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code)<br/>
/// in Actors documentation.
Expand Down
16 changes: 8 additions & 8 deletions src/libs/Apify/Generated/Apify.Models.ActorDefinition.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,19 +57,19 @@ public sealed partial class ActorDefinition
public global::System.Collections.Generic.Dictionary<string, string>? EnvironmentVariables { get; set; }

/// <summary>
/// The path to the Dockerfile used for building the Actor on the platform.
/// The path to the Dockerfile used for building the Actor on the platform, relative to the `.actor/` directory.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("dockerfile")]
public string? Dockerfile { get; set; }

/// <summary>
/// The path to the directory used as the Docker context when building the Actor.
/// The path to the directory used as the Docker context when building the Actor, relative to the `.actor/` directory.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("dockerContextDir")]
public string? DockerContextDir { get; set; }

/// <summary>
/// The path to the README file for the Actor.
/// The path to the README file for the Actor, relative to the `.actor/` directory.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("readme")]
public string? Readme { get; set; }
Expand All @@ -87,7 +87,7 @@ public sealed partial class ActorDefinition
public object? Output { get; set; }

/// <summary>
/// The path to the CHANGELOG file displayed in the Actor's information tab.
/// The path to the CHANGELOG file displayed in the Actor's information tab, relative to the `.actor/` directory.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("changelog")]
public string? Changelog { get; set; }
Expand Down Expand Up @@ -169,13 +169,13 @@ public sealed partial class ActorDefinition
/// A map of environment variables to be used during local development and deployment.
/// </param>
/// <param name="dockerfile">
/// The path to the Dockerfile used for building the Actor on the platform.
/// The path to the Dockerfile used for building the Actor on the platform, relative to the `.actor/` directory.
/// </param>
/// <param name="dockerContextDir">
/// The path to the directory used as the Docker context when building the Actor.
/// The path to the directory used as the Docker context when building the Actor, relative to the `.actor/` directory.
/// </param>
/// <param name="readme">
/// The path to the README file for the Actor.
/// The path to the README file for the Actor, relative to the `.actor/` directory.
/// </param>
/// <param name="input">
/// The input schema object, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/input-schema)
Expand All @@ -184,7 +184,7 @@ public sealed partial class ActorDefinition
/// The output schema object, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/output-schema)
/// </param>
/// <param name="changelog">
/// The path to the CHANGELOG file displayed in the Actor's information tab.
/// The path to the CHANGELOG file displayed in the Actor's information tab, relative to the `.actor/` directory.
/// </param>
/// <param name="storages"></param>
/// <param name="defaultMemoryMbytes">
Expand Down
4 changes: 2 additions & 2 deletions src/libs/Apify/Generated/Apify.Models.CreateVersionRequest.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public sealed partial class CreateVersionRequest
public string? GitRepoUrl { get; set; }

/// <summary>
/// URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("tarballUrl")]
public string? TarballUrl { get; set; }
Expand Down Expand Up @@ -96,7 +96,7 @@ public sealed partial class CreateVersionRequest
/// URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`.
/// </param>
/// <param name="tarballUrl">
/// URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// </param>
/// <param name="gitHubGistUrl">
/// URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`.
Expand Down
4 changes: 2 additions & 2 deletions src/libs/Apify/Generated/Apify.Models.UpdateVersionRequest.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public sealed partial class UpdateVersionRequest
public string? GitRepoUrl { get; set; }

/// <summary>
/// URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("tarballUrl")]
public string? TarballUrl { get; set; }
Expand Down Expand Up @@ -94,7 +94,7 @@ public sealed partial class UpdateVersionRequest
/// URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`.
/// </param>
/// <param name="tarballUrl">
/// URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`.
/// </param>
/// <param name="gitHubGistUrl">
/// URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`.
Expand Down
4 changes: 2 additions & 2 deletions src/libs/Apify/Generated/Apify.Models.Version.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public sealed partial class Version
public string? GitRepoUrl { get; set; }

/// <summary>
/// URL to download the source code from as a tarball or ZIP file. Applies when the `sourceType` is `TARBALL`.
/// URL to download the source code from as a zip archive. Applies when the `sourceType` is `TARBALL`.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("tarballUrl")]
public string? TarballUrl { get; set; }
Expand Down Expand Up @@ -112,7 +112,7 @@ public sealed partial class Version
/// URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`.
/// </param>
/// <param name="tarballUrl">
/// URL to download the source code from as a tarball or ZIP file. Applies when the `sourceType` is `TARBALL`.
/// URL to download the source code from as a zip archive. Applies when the `sourceType` is `TARBALL`.
/// </param>
/// <param name="gitHubGistUrl">
/// URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`.
Expand Down
16 changes: 8 additions & 8 deletions src/libs/Apify/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"#tag/ActorsEnvironment-variable-object"
],
"x-trait": "true",
"description": "The API endpoints in this section allow you to manage your Apify Actors versions.\n\n- The version object contains the source code of a specific version of an Actor.\n- The `sourceType` property indicates where the source code is hosted, and based\non its value the `Version` object has the following additional property:\n\n| **Value** | **Description** |\n|---|---|\n| `\"SOURCE_FILES\"` | Source code is comprised of multiple files specified in the `sourceFiles` array. Each item of the array is an object with the following fields:<br/> - `name`: File path and name<br/> - `format`: Format of the content, can be either `\"TEXT\"` or `\"BASE64\"`<br/> - `content`: File content<br/><br/>Source files can be shown and edited in the Apify Console's Web IDE. |\n| `\"GIT_REPO\"` | Source code is cloned from a Git repository, whose URL is specified in the `gitRepoUrl` field. |\n| `\"TARBALL\"` | Source code is downloaded using a tarball or Zip file from a URL specified in the `tarballUrl` field. |\n|`\"GITHUB_GIST\"`| Source code is taken from a GitHub Gist, whose URL is specified in the `gitHubGistUrl` field. |\n\nFor more information about source code and Actor versions, check out [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code)\nin Actors documentation.\n"
"description": "The API endpoints in this section allow you to manage your Apify Actors versions.\n\n- The version object contains the source code of a specific version of an Actor.\n- The `sourceType` property indicates where the source code is hosted, and based\non its value the `Version` object has the following additional property:\n\n| **Value** | **Description** |\n|---|---|\n| `\"SOURCE_FILES\"` | Source code is comprised of multiple files specified in the `sourceFiles` array. Each item of the array is an object with the following fields:<br/> - `name`: File path and name<br/> - `format`: Format of the content, can be either `\"TEXT\"` or `\"BASE64\"`<br/> - `content`: File content<br/><br/>Source files can be shown and edited in the Apify Console's Web IDE. |\n| `\"GIT_REPO\"` | Source code is cloned from a Git repository, whose URL is specified in the `gitRepoUrl` field. |\n| `\"TARBALL\"` | Source code is downloaded as a zip archive from a URL specified in the `tarballUrl` field. |\n|`\"GITHUB_GIST\"`| Source code is taken from a GitHub Gist, whose URL is specified in the `gitHubGistUrl` field. |\n\nFor more information about source code and Actor versions, check out [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code)\nin Actors documentation.\n"
},
{
"name": "Actors/Actor builds",
Expand Down Expand Up @@ -21770,7 +21770,7 @@
},
"tarballUrl": {
"type": "string",
"description": "URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`."
"description": "URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`."
},
"gitHubGistUrl": {
"type": "string",
Expand Down Expand Up @@ -22210,7 +22210,7 @@
"string",
"null"
],
"description": "URL to download the source code from as a tarball or ZIP file. Applies when the `sourceType` is `TARBALL`."
"description": "URL to download the source code from as a zip archive. Applies when the `sourceType` is `TARBALL`."
},
"gitHubGistUrl": {
"type": [
Expand Down Expand Up @@ -23179,7 +23179,7 @@
},
"tarballUrl": {
"type": "string",
"description": "URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`."
"description": "URL of the zip archive to download the source code from. Applies when the `sourceType` is `TARBALL`."
},
"gitHubGistUrl": {
"type": "string",
Expand Down Expand Up @@ -24221,18 +24221,18 @@
},
"dockerfile": {
"type": "string",
"description": "The path to the Dockerfile used for building the Actor on the platform."
"description": "The path to the Dockerfile used for building the Actor on the platform, relative to the `.actor/` directory."
},
"dockerContextDir": {
"type": "string",
"description": "The path to the directory used as the Docker context when building the Actor."
"description": "The path to the directory used as the Docker context when building the Actor, relative to the `.actor/` directory."
},
"readme": {
"type": [
"string",
"null"
],
"description": "The path to the README file for the Actor."
"description": "The path to the README file for the Actor, relative to the `.actor/` directory."
},
"input": {
"type": [
Expand All @@ -24253,7 +24253,7 @@
"string",
"null"
],
"description": "The path to the CHANGELOG file displayed in the Actor's information tab."
"description": "The path to the CHANGELOG file displayed in the Actor's information tab, relative to the `.actor/` directory."
},
"storages": {
"type": "object",
Expand Down
Loading