docs: sync Task publish/unpublish docs with apify-docs #2840 - #10
Merged
Conversation
…sion apify-docs PR #2840 officially documents the Task.isPublic/publicConfig fields this client already implemented ahead of the spec (0.2.0) for JS parity. Bumps ApiSpecVersion to v2-2026-08-14T072928Z and corrects the publish/unpublish permission wording (task's Actor only, not "both the task and its Actor") in code comments, docs/tasks.md, and the integration test comment to match the now-authoritative spec text. Also documents PublishAsync's concrete preconditions and notes that TaskPublicConfig.Categorization isn't part of the documented schema.
The deployed spec at v2-2026-08-05T133145Z already carries the Task.isPublic/publicConfig fields and TaskPublicConfig schema, so the 0.3.1 CHANGELOG's claim that the v2-2026-08-14T072928Z bump is what "officially documents" fields "implemented ahead of the spec (0.2.0)" was inaccurate. Reworded to a plain factual bullet.
github-actions
Bot
added
the
t-tooling
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
apify-docs PR #2840 added
Task.isPublic/publicConfigand theTaskPublicConfigschema to the OpenAPI spec source (components/version.yamlnowv2-2026-08-14T072928Z), formalizing the publish/unpublish support this client already carries (0.2.0) for reference-client parity.What changed
ApiSpecVersiontov2-2026-08-14T072928Z(ClientVersion0.3.0 → 0.3.1, patch — no interface change).TaskClient.PublishAsync/UnpublishAsync,docs/tasks.md, and theTaskPublishUnpublishintegration test comment: the spec'sPUT /actor-tasks/{actorTaskId}description says publishing/unpublishing requires write permission to the task's Actor only, not (as previously stated, copied from the reference JS client) "both the task and its Actor."PublishAsync's doc comment anddocs/tasks.mdwith the concrete publish preconditions from the spec (Actor public,publicConfig.inputSchemaFieldsandpublicConfig.datasetViewset, Actor has fewer than 50 published tasks).TaskPublicConfig.Categorization's doc comment anddocs/models.mdthat the field isn't part of the documented schema (kept only for parity with the reference JS client, which carries the same undocumented field).Compatibility
Verified locally:
dotnet format --verify-no-changes,dotnet build -c Release(0 warnings/errors), anddotnet testfor Unit/Integration/Examples — 159/159 passing against the live API.