Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2022 IPFS Thing - spec discussion #101

Open
SgtPooki opened this issue Jul 14, 2022 · 2 comments
Open

2022 IPFS Thing - spec discussion #101

SgtPooki opened this issue Jul 14, 2022 · 2 comments

Comments

@SgtPooki
Copy link

SgtPooki commented Jul 14, 2022

tbd

@SgtPooki
Copy link
Author

SgtPooki commented Jul 14, 2022

Problems

  • Count is not scalable
  • Supporting multiple status filters in a single query is difficult and may force pinning providers into certain implementations

Missing

  • Paths (more info from @lidel)
  • Pinning of IPNS
  • Pinning a CAR

Required

Removing

PinResults

Updating/Editing (Without breaking changes)

  • Deprecate count
  • "hacky" count support in clients. (@SgtPooki to supply details)

Updating/Editing (With breaking changes; v2)

  • Remove count
  • Add property for "nextToken" or similar name to act as cursor
  • Count could be replaced with "hasMore" boolean flag.
  • Update before so that we support arbitrary before tokens. This means they can be:
    • Dates
    • ... anything.
      • In this case, the Pinning Provider would need to return the before tokens in response so client could continue a query when there are more results.
      • Don't necessarily need before & after.
  • Spec should only require providers to allow a single status string, but they should also support array of statuses.
  • Optional properties:
    • Mark 'match' property as optional
    • Update docs/spec to more 'forcefully' encourage properties in the 'meta' field
      • % of data/dag for a CID that has pinned or been processed.

Discrepancies/Problems

  • Cluster cannot paginate
  • Cluster cannot do count

Car file pinning (@Jorropo to add details here)

  • Does pinning car files sound reasonable?
    • Pin car file roots
    • Spec shouldn't require anything beyond the requirement

@BigLep
Copy link

BigLep commented Aug 4, 2022

2022-08-04 Implementers Sync conversation (as I understood it - please correct if this is wrong):

  1. Someone (Piñata?) take the change in this repo and Cc @lidel. The PR needs to document how we do pagination, removing the need for the count to be a numeric value, but instead being a boolean type thing (or whatever needs to happen, for clients to still work).
  2. Re-generation of clients, focusing on https://github.com/ipfs/go-pinning-service-http-client (used by Kubo)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants