ipfs / pinning-services-api-spec

Standalone, vendor-agnostic Pinning Service API for IPFS ecosystem
https://ipfs.github.io/pinning-services-api-spec/
Creative Commons Zero v1.0 Universal
99 stars 26 forks source link

Finalizing MVP API Spec for IPFS WebUI integration #21

Closed lidel closed 3 years ago

lidel commented 4 years ago

About

This issue tracks overall finalization status of this spec from the perspective of being ready for stakeholders to start implementation of basic functionality.

cc @jacobheun @pooja @jessicaschilling

Stakeholders

Remaining Issues

While mostly ready, we need to resolve these issues before API can be fully implemented:

Stakeholder Sign-offs

lidel commented 4 years ago

Got approval for general direction from the first batch of stakeholders:

πŸ“£ It is ok to start implementing the API, and provide feedback / questions as you go (create issue in this repo)

FYSA we dont expect groundbreaking changes, but there are some field-specific tweaks/clarifications suggested during internal review, pending community review: /pulls – PRs with filtering by metadata, queued status, removal of unpinned state https://github.com/ipfs/pinning-services-api-spec/issues/33 – temperature check: should pin object include creation date?

pooja commented 4 years ago

I think the pulls link is auto-linking to something broken for some reason. Here is the fresh link: https://github.com/ipfs/pinning-services-api-spec/pulls

lidel commented 4 years ago

v0.0.5 was just tagged, addressing feedback from early implementers

lidel commented 4 years ago

FYSA we will merge improved Error responses (https://github.com/ipfs/pinning-services-api-spec/pull/59) on Monday and release as v0.1.0 Client implementation in go-ipfs is wip.

lidel commented 3 years ago

Basic integration shipped with ipfs-webui v2.12.0. It supports remote pining services compatible with a subset of v1.0.0 of this spec implemented in pin remote client that shipped with go-ipfs v0.8.0