Finalizing MVP API Spec for IPFS WebUI integration

[lidel]

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

• @jbenet as BDFL
• IPFS Core Impl. WG implementing API client in go-ipfs and js-ipfs
• IPFS GUI Team implementing UI in WebUI / IPFS Desktop app
• Pinning Services implementing the API

Remaining Issues

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

• Clear Milestone issues: https://github.com/ipfs/pinning-services-api-spec/milestone/1
• (descoped) Additional endpoint for GUI apps that enables user onboarding without copying secrets as noted in Defining API access controls #6 (comment)

Stakeholder Sign-offs

• @jbenet 👉 review scheduled
• IPFS Cluster / Pinning Service API notes#378 (@lanzafame)
• IPFS Core Impl. WG
• IPFS GUI Team implementing UI in WebUI / IPFS Desktop app
• IPFS Pinning Services
  • PS list TBD

[lidel]

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
#33 – temperature check: should pin object include creation date?

[pooja]

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]

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

[lidel]

FYSA we will merge improved Error responses (#59) on Monday and release as v0.1.0
Client implementation in go-ipfs is wip.

[lidel]

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