Repository navigation
docs(api): fix the Actor, version, and schedule request schemas #3087
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.
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
+99
−41
Merged
Changes from all commits
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
bf0439e
docs(api): add missing fields to the Actor and schedule request schemas
vdusek 1441f0e
docs(api): define EnvVarRequest as a standalone schema
vdusek 0d16c88
docs(api): drop null from actorPermissionLevel and notifications in c…
vdusek 81998fe
docs(api): drop null from isPublic and versions in CreateActorRequest
vdusek 0ef0363
docs(api): use EnvVarRequest for envVars in CreateOrUpdateVersionRequest
vdusek e78ea9f
docs(api): use CreateOrUpdateVersionRequest for versions in CreateAct…
vdusek 4afac3d
docs(api): require versionNumber and sourceType on versions in Create…
vdusek 301276f
docs(api): split CreateOrUpdateVersionRequest into create and update …
vdusek f7f64a3
docs(api): reject SOURCE_CODE in version request schemas
vdusek 401d52a
docs(api): rename VersionSourceTypeRequest to WritableVersionSourceType
vdusek c1c6c65
docs(api): require at least one version in the Actor request schemas
vdusek 4d0e682
docs(api): drop null from actorPermissionLevel in UpdateActorRequest
vdusek 43e9f1f
docs(api): require the source field matching sourceType in CreateVers…
vdusek 540de31
docs(api): cap versions at 10 in the Actor request schemas
vdusek 2d5dec4
docs(api): drop null from source URLs in UpdateVersionRequest
vdusek a6b8c72
docs(api): drop null from envVars in the version request schemas
vdusek 5e45e79
docs(api): require the matching source field when UpdateVersionReques…
vdusek df888c0
docs(api): allow only false for isPublic in CreateActorRequest
vdusek 08f48bc
docs(api): add the API's length and character limits to EnvVarRequest
vdusek 0f1773a
docs(api): add URL patterns to the version source fields
vdusek 2466f0b
docs(api): add the API's buildTag limits to the version request schemas
vdusek e111935
docs(api): make the tarball and Gist URL patterns case-insensitive
vdusek f6ca46e
docs(api): allow any boolean for isPublic in CreateActorRequest
vdusek 0cbfe15
docs(api): drop value patterns and length limits from the version and…
vdusek c1589ee
docs(api): drop the sourceType conditional rules from the version req…
vdusek 395c5f9
docs(api): drop the version count cap from the Actor request schemas
vdusek File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 17 additions & 4 deletions
21
apify-api/openapi/components/schemas/actors/EnvVarRequest.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,18 @@ | ||
| title: EnvVarRequest | ||
| allOf: | ||
| - $ref: ./EnvVar.yaml | ||
| - required: | ||
| - value | ||
| required: | ||
| - name | ||
| - value | ||
| type: object | ||
| properties: | ||
| name: | ||
| type: string | ||
| examples: [MY_ENV_VAR] | ||
| description: The name of the environment variable. Can't contain `=`. | ||
| value: | ||
| type: string | ||
| examples: [my-value] | ||
| description: The value of the environment variable. | ||
| isSecret: | ||
| type: [boolean, "null"] | ||
| examples: [false] | ||
| description: Whether the environment variable is encrypted. Secret values aren't returned by the API. |
|
apify-service-account marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 38 additions & 0 deletions
38
apify-api/openapi/components/schemas/actors/UpdateVersionRequest.yaml
|
vdusek marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| title: UpdateVersionRequest | ||
| type: object | ||
| properties: | ||
| versionNumber: | ||
| type: string | ||
| pattern: ^([0-9]|[1-9][0-9])\.([0-9]|[1-9][0-9])$ | ||
| examples: ["1.6"] | ||
| description: The version number of the Actor. Two numbers separated by a dot, | ||
| that represent the `MAJOR.MINOR` part of the semantic versioning. | ||
| sourceType: | ||
| $ref: ./WritableVersionSourceType.yaml | ||
|
vdusek marked this conversation as resolved.
|
||
| description: Where the source code of the version lives. | ||
| envVars: | ||
| type: array | ||
| items: | ||
| $ref: ./EnvVarRequest.yaml | ||
| description: Environment variables for the version. | ||
|
vdusek marked this conversation as resolved.
|
||
| applyEnvVarsToBuild: | ||
| type: [boolean, "null"] | ||
| examples: [false] | ||
| description: Whether to inject the environment variables at build time. | ||
| buildTag: | ||
| type: [string, "null"] | ||
| examples: [latest] | ||
| description: The tag name to apply to a successful build of this version. Can be `null` when the version has no build tag. | ||
|
vdusek marked this conversation as resolved.
|
||
| sourceFiles: | ||
| $ref: ./VersionSourceFiles.yaml | ||
| description: Applies when the `sourceType` is `SOURCE_FILES`. Represents the Actor's | ||
| file structure as an array of files and folders. | ||
| gitRepoUrl: | ||
| type: string | ||
|
vdusek marked this conversation as resolved.
|
||
| description: URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`. | ||
| tarballUrl: | ||
| type: string | ||
| description: URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`. | ||
| gitHubGistUrl: | ||
| type: string | ||
| description: URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`. | ||
8 changes: 8 additions & 0 deletions
8
apify-api/openapi/components/schemas/actors/WritableVersionSourceType.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| title: WritableVersionSourceType | ||
| description: The version source types accepted in request bodies. Same as `VersionSourceType`, without `SOURCE_CODE`. | ||
| enum: | ||
| - SOURCE_FILES | ||
| - GIT_REPO | ||
| - TARBALL | ||
| - GITHUB_GIST | ||
| type: string |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 7 additions & 0 deletions
7
apify-api/openapi/components/schemas/schedules/ScheduleNotifications.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| title: ScheduleNotifications | ||
| type: object | ||
| description: Notification settings for this schedule. | ||
| properties: | ||
| email: | ||
| type: boolean | ||
| examples: [true] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.