-
Notifications
You must be signed in to change notification settings - Fork 221
feat: add Actor task publication endpoints #2840
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
+88
−0
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
cbd3d59
feat: add Actor task publication endpoints
Janjiran f0609b9
feat: allow publicConfig on task create, tighten it on update
Janjiran 41a4dbe
feat: publish tasks via isPublic on the task update
Janjiran f80890b
Merge branch 'master' into feat/public-tasks-api
Janjiran e39a168
chore: docs copy update
Janjiran f0ac4da
chore: remove categorization field from publicConfig
Janjiran ecce30a
feat: update copy based on review
Janjiran 184bc26
chore: fix update doc
Janjiran 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
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
45 changes: 45 additions & 0 deletions
45
apify-api/openapi/components/schemas/actor-tasks/TaskPublicConfig.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,45 @@ | ||
| title: TaskPublicConfig | ||
| type: object | ||
| description: | | ||
| Public-facing configuration of a published task, used by the task's public landing page. | ||
| The task's publication state is determined by `publishedAt` - a task is published when | ||
| `publishedAt` is set and unpublished when it is `null`. | ||
| properties: | ||
| publishedAt: | ||
| type: [string, "null"] | ||
| format: date-time | ||
| readOnly: true | ||
| description: | | ||
| Time when the task was published, or `null` if the task isn't published. | ||
| This field is server-controlled. To publish or unpublish a task, use the | ||
| [Update task](/api/v2/actor-task-put) endpoint and set `isPublic`. | ||
| examples: ["2025-06-16T09:20:45.777Z"] | ||
| seoTitle: | ||
| type: [string, "null"] | ||
| maxLength: 60 | ||
| description: | | ||
| Name of the Actor task to display by search engines such as Google. Defaults to the task | ||
| title. At most 60 characters. | ||
| examples: [Scrape data from a website] | ||
| seoDescription: | ||
| type: [string, "null"] | ||
| maxLength: 160 | ||
| description: | | ||
| Description of the Actor task to display by search engines such as Google. Defaults to the | ||
| task description. At most 160 characters. | ||
| inputSchemaFields: | ||
| type: [array, "null"] | ||
| description: Names of the task input fields displayed on the public task page. | ||
| items: | ||
| type: string | ||
| datasetName: | ||
| type: [string, "null"] | ||
| description: | | ||
| Name of the dataset from the Actor's dataset schema whose results are displayed. When | ||
| `null`, the Actor's default dataset is used. That is, the only dataset the Actor declares, | ||
| or the one named `default` when it declares several. | ||
| datasetView: | ||
| type: [string, "null"] | ||
| description: | | ||
| Key of the dataset view from the Actor's dataset schema used to display results. Must be | ||
| one of the views declared on the resolved dataset. You can't publish a task without it. |
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.