chore: comply with updated client requirements (v0.4.1) - #8
Merged
Conversation
Documentation-compliance pass against the updated orchestration client requirements (no OpenAPI spec change; still v2-2026-06-25T142310Z). No public API surface change, so this is a SemVer patch (0.4.0 -> 0.4.1). - Documentation: disclaimer now states the client is "official, but experimental" and AI-generated/maintained (replacing "not (yet) an officially supported Apify product") in README.md, docs/README.md, and the client.go package doc comment. - Publishing: documented in README that Go has no central registry and thus no Trusted Publisher mechanism (releases via git tag + module proxy, GITHUB_TOKEN only); go-publish.yml already complied. - Documentation completeness: added field tables for APIError and RunChargeOptions, enumerated webhook Create input keys, documented the request-queue locking method signatures, fixed the DownloadItems format list (added JSONL), and noted the plain-value option structs. - Fixed a stale API_SPEC_VERSION reference in README; bumped CLIENT_VERSION to 0.4.1 with a CHANGELOG entry.
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.
Summary
Compliance pass against the updated orchestration client requirements. No OpenAPI spec change — the client remains based on
v2-2026-06-25T142310Z. The requirements were updated after the previous Go client PR; this brings the client back into full compliance. No public API surface change, so this is a patch release (0.4.0→0.4.1).Changes
README.md,docs/README.md, and theclient.gopackage doc comment.GITHUB_TOKEN.go-publish.ymlalready reflected this; the README "Releasing" section now documents it explicitly.*APIError(and documentedAsAPIError) andRunChargeOptions; enumerated the webhookCreateinput keys; documented the request-queue locking method signatures (ListAndLockHead,ProlongRequestLock,DeleteRequestLock,UnlockRequests); fixed theDownloadItemsformat list (addedJSONLto match the constants table); and noted the plain-value (non-pointer) option structs.API_SPEC_VERSIONreference in the README; bumpedCLIENT_VERSION0.4.0→0.4.1with aCHANGELOG.mdentry.Verification
gofmt -l .,go vet ./...,go build ./...,golangci-lintconfig, unit tests, and the doc-snippet format/compile tests — all clean.review-clientprocess (endpoint/JS-parity coverage confirmed full; all documentation review items resolved).Generated by Claude Code