Skip to content

Releases: ipfs/pinning-services-api-spec

v1.0.0

19 Feb 23:55
d3ecd73
Compare
Choose a tag to compare

This release includes only documentation improvements.
There is no functional change, nor need to re-generate any code.

  • chore: v1.0.0
    • this is a formal version bump to signify that a client for this API shipped with go-ipfs 0.8.0
    • going forward this API spec will follow https://semver.org
    • we don't expect to make any breaking changes, as the stability of pin remote commands in go-ipfs is our priority
  • docs: readme (d3ecd73)
  • docs: clarify use of provider hints (#72)
  • docs: code generation (#67)

v0.1.2

27 Oct 19:47
7f912b2
Compare
Choose a tag to compare
  • fast exact name search by default (#66)

v0.1.1

23 Sep 15:56
3847396
Compare
Choose a tag to compare
  • style: rename object returned with error (#65)
    • this does not change structures sent over the wire, only renames Error response scheme to Failure, which means that code generated with openapi-generator have better ergonomics
  • chore: updated version to v0.1.1

v0.1.0

18 Sep 12:02
46f23fd
Compare
Choose a tag to compare

This release includes improved documentation, new error responses and one field name change.
The 📣 indicates BREAKING CHANGES which require client/server regeneration for interop to work.

Changes since last release:

  • 📣 feat: improved error responses (#59)
  • 📣 refactor: rename PinStatus id → requestid (#63)
  • fix: adjust cid filter limits (#62)
  • improved documentation
    • clarified replace operation (#61)
    • case-insensitive Pin.name filter (#58)
    • updated adoption section (#60)
    • added query params examples (#55)

👉 FYSA v1.0.0 will be tagged when go-ipfs 0.8.x ships with a built-in client for this API.
We are committed to no breaking changes from that point.

Latest docs: https://ipfs.github.io/pinning-services-api-spec/

v0.0.5

14 Aug 17:43
2af7f77
Compare
Choose a tag to compare
  • feat: Pin.name (#49)
  • fix: single pin I/O in POST operations (#48)
  • docs: clarify use of PinStatus.id (#47)
  • fix: disambiguating *.meta fields (#51)
  • fix: disambiguating *.providers fields (#50)
  • chore: cleanup and updated diagrams (#52)

Docs: https://ipfs.github.io/pinning-services-api-spec/

v0.0.4

30 Jul 17:38
899bfc4
Compare
Choose a tag to compare
  • Add PinStatus.created and time-based pagination (#39)
  • Simplify access token spec (#40)
  • Improved descriptions, copy edits (#44), added diagrams

Docs: https://ipfs.github.io/pinning-services-api-spec/

v0.0.3

30 Jul 12:12
fb92000
Compare
Choose a tag to compare

Changes to status field and filter: #31