[Artifacts] Document namespace routes, repo content routes, and binding read methods#31351
Draft
dinasaur404 wants to merge 3 commits into
Draft
[Artifacts] Document namespace routes, repo content routes, and binding read methods#31351dinasaur404 wants to merge 3 commits into
dinasaur404 wants to merge 3 commits into
Conversation
github-actions
Bot
assigned
dmmulroy,
elithrar,
mattzcarey,
whoiskatrin,
irvinebroque,
rita3ko and
vy-ton
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
…ad methods - Add ARTIFACTS_ACCOUNT_BASE_URL to REST API reference - Add Namespaces section (list, get) using account-level base URL - Add Repo content section (log, commit, tree, blob, file, raw) between repo management and tokens - Replace tok_123 with 16-char lowercase alphanumeric IDs per OpenAPI spec - Add Workers binding content-read methods: log(), readCommit(), readTree()
… API docs - Change intro text to state routes are shown relative to /accounts/ - Add JSON response envelope documentation with blob/file/raw exception note - Update all Route: labels to show explicit /artifacts/namespaces/:namespace/... paths
dinasaur404
force-pushed
the
artifacts-api-docs-update
branch
from
e2a3e48 to
50a94db
Compare
ask-bonk
Bot
added
documentation
Contributor
|
@dinasaur404 Bonk workflow was cancelled. View workflow run · To retry, trigger Bonk again. |
Contributor
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
8 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
Updates the Artifacts REST API and Workers binding reference docs to document new namespace routes, repo content routes, and content-read binding methods.
Changes to
rest-api.mdx:ARTIFACTS_ACCOUNT_BASE_URLfor account-level API callsGET /artifacts/namespaces,GET /artifacts/namespaces/:namespace) before Repos/artifacts/namespaces/:namespace/...)tok_123token IDs with 16-character lowercase alphanumeric IDs per OpenAPI specChanges to
workers-binding.mdx:repo.log(),repo.readCommit(), andrepo.readTree()content-read methods under Repo handle methodsDocumentation checklist