docs(pinning): recursive DAG pinning + standard REST API + CAR import#174
Merged
Conversation
…AR import
The IPFS Pinning Service API page only showed the `ipfs pin remote`
CLI. Added, aligned with the IPFS Pinning Services API spec:
- "Pinning a DAG (recursive pinning)": clarifies that in the standard,
pinning a CID IS recursive DAG pinning (the CID is a DAG root pinned
recursively) — there is no separate DAG-pin op or recursive flag.
Quotes the spec and explains the network-fetch / queued->pinning
lifecycle.
- "Standard REST API": the five standard operations (POST/GET /pins,
GET/POST/DELETE /pins/{requestid}) with bearer auth, a POST /pins
example, the Pin/PinStatus object fields, the paginated PinResults
shape, and the queued->pinning->pinned/failed lifecycle.
- "Importing a DAG by uploading a CAR file": the Functionland CAR
import extension (POST /pins/import/car), CLEARLY labeled as NOT part
of the IPFS Pinning Service API standard (the standard is pin-by-CID
with no upload endpoint), with ipfs dag export usage, limits, and
error codes.
Content fact-checked against the spec (independently reviewed).
actions/setup-node@v2 with cache:yarn calls GitHub's legacy Actions cache service, which GitHub has shut down — every PR build now fails at the setup step with "Cache service responded with 400", before yarn install or the docusaurus build run (hence ~10s failures). The change is purely environmental: this same workflow passed until GitHub disabled the old backend. deploy.yml was already modernized (checkout@v4, setup-node@v4, node 18) and still succeeds on main; pull-request.yml was just never updated to match. Bring it in line: checkout@v2 -> v4, setup-node@v2 -> v4, node 14.x -> 18.x. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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.
Expands the IPFS Pinning Service API page (
docs/pinning-service/ipfs-pinning-service-api.md), which previously only showed theipfs pin remoteCLI, to document DAG pinning aligned with the IPFS Pinning Services API spec.What's added
Pinning a DAG (recursive pinning) — The key clarification: in the Pinning Service API, pinning a CID is recursive DAG pinning. There is no separate "DAG pin" operation and no recursive flag; a pin always pins the entire DAG rooted at the CID. Quotes the spec ("CID points at the root of a DAG that is pinned recursively") and explains how the service fetches the DAG from the network (origins/Bitswap), which is why pins go
queued → pinning → pinned.Standard REST API — The five standard operations (
POST /pins,GET /pins,GET /pins/{requestid},POST /pins/{requestid},DELETE /pins/{requestid}) with bearer auth, aPOST /pinsexample, the Pin/PinStatus object fields, the paginatedPinResultslist shape, and the status lifecycle. The page now documents the actual standard API surface, not just the CLI wrapper.Importing a DAG by uploading a CAR file — Documents the Functionland
POST /pins/import/carextension, clearly labeled as NOT part of the IPFS Pinning Service API standard (the standard is pin-by-CID only and has no upload endpoint). Coversipfs dag exportto produce the CAR, single-root/complete-DAG/CARv1+v2 requirements, the 800 MB cap, and the error codes.Alignment
Standard behavior is presented as standard; the CAR-upload capability is explicitly delineated as a vendor extension, so the page stays a faithful representation of the IPFS Pinning Service API. Content was fact-checked against the spec and independently reviewed for accuracy — no inaccuracies found.
Pure content addition (+111 lines), matches the page's existing
<Note>/ Markdown style.Note: docs live in this repo (functionland/docs), separate from the pinning-service implementation repo, so this is necessarily its own PR.
🤖 Generated with Claude Code