Repository navigation
docs: correct the API guide so its steps run end to end [PYSDK-158] - #741
Merged
Merged
Conversation
Found by running the guide on production against test-app: - step 4 used input name "input_slide" and metadata key "media-type"; the API expects "whole_slide_image" and "media_type" (422 otherwise) - step 3 upload failed with SignatureDoesNotMatch on AWS CLI 2.23+; set the checksum env vars GCS needs - step 6 /file is a redirect: follow it with -L, create step folders, and lead with /file instead of the deprecated download_url - bump Atlas H&E-TME to 2.0.1 and list its three required fields - show where the checksum comes from (x-goog-hash after upload) - load bucket credentials from /me; say own storage works too - hello-world: fail with the real error, save the refresh token, document chmod +x; explain expired-token 401 and jq parse errors Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…zation Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
omid-aignostics
added
documentation
|
OX Security reviewed this pull request — nothing to fix.
Branch |
Codecov Report✅ All modified and coverable lines are covered by tests. ❌ Your project check has failed because the head coverage (65.10%) is below the target coverage (70.00%). You can increase the head coverage or adjust the target coverage.
|
olivermeyer
approved these changes
Oct 21, 2026
|
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
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.
Change request: PYSDK-158
Corrects the "Get started with the API" guide (
docs/partials/get_started_api.md). A full run of the guide on production on 2026-10-20 found three errors that stop anyone who follows it word for word, plus missing information about per-slide metadata. Documentation only — no code, requirements, specifications, or tests change.Blocking errors fixed
SignatureDoesNotMatchagainst GCSAWS_REQUEST_CHECKSUM_CALCULATION/AWS_RESPONSE_CHECKSUM_VALIDATION=when_requiredinput_slideand metadata keymedia-type→ HTTP 422whole_slide_image; only the three required fields in the example/fileanswers with a redirect;curlwithout-Ldownloads nothingcurl -L, plus a loop that downloads all resultsOther changes
chmod +x; expired-token401/jqparse error explained.2.0.1; table of the three required metadata fields.GET /v1/me; checksum read fromx-goog-hashafter upload, with a local fallback.jq; one run can hold all slides./fileas primary route instead of the deprecateddownload_url; results saved into step folders (artifact names contain:and have no extension).Verification
783e3428-5efb-41d8-b08f-6529e0aa3ab2ontest-app1.3.0, 1/1 item succeeded, 12 artifacts downloaded. Login through a new per-org device client verified on 2026-10-21.bash -n; checksum, request-body, and download-loop parsing tested against sample data.make -C docs htmlpasses; no new warnings.🤖 Generated with Claude Code