Skip to content
This repository has been archived by the owner on Mar 10, 2020. It is now read-only.

First iteration of interface-ipfs-core #18

Closed
39 of 41 tasks
hackergrrl opened this issue May 18, 2016 · 6 comments
Closed
39 of 41 tasks

First iteration of interface-ipfs-core #18

hackergrrl opened this issue May 18, 2016 · 6 comments

Comments

@hackergrrl
Copy link
Contributor

hackergrrl commented May 18, 2016

Here are some thoughts on the herculean task of building this out. For each section of the API (objects, blocks, etc) we

  1. write up a draft api for them as a PR in this repo
  2. get approval on that PR from the core js-ipfs devs
  3. write PRs on js-ipfs and js-ipfs-api to match said api
  4. write tests here on interface-ipfs-core for that api
  5. run both js-ipfs and js-ipfs-api against the interface-ipfs-core tests from (4)

We'll need this done for the whole core api:

high priority:

  • objects
    • draft api
    • api approval
    • js-ipfs support
    • js-ipfs-api support
    • interface-ipfs-core tests
    • tests passing against js-ipfs and js-ipfs-api
  • blocks
    • draft api
    • api approval
    • js-ipfs support
    • js-ipfs-api support
    • interface-ipfs-core tests
    • tests passing against js-ipfs and js-ipfs-api
  • add
    • draft api
    • api approval
    • js-ipfs support
    • js-ipfs-api support
    • interface-ipfs-core tests
    • tests passing against js-ipfs and js-ipfs-api
  • cat
    • draft api
    • api approval
    • js-ipfs support
    • js-ipfs-api support
    • interface-ipfs-core tests
    • tests passing against js-ipfs and js-ipfs-api
  • get
    • draft api
    • api approval
    • js-ipfs support
    • js-ipfs-api support
    • interface-ipfs-core tests
    • tests passing against js-ipfs and js-ipfs-api

lower priority:

  • version
  • id
  • refs
  • pin
  • log
@hackergrrl hackergrrl changed the title version 1.0.0 version 1.0.0 roadmap May 18, 2016
@daviddias
Copy link
Contributor

daviddias commented May 18, 2016

Thank you, I love things that look like Roadmaps! :)

In terms of process, let's go more for:

    1. Write up the API spec in a PR
    • 1.1 Write up the tests for that API
    • 1.2 Write up PR for js-ipfs and js-ipfs-api that apply the tests and necessary changes
    • 1.3 Tweak the API spec as needed (feeding back what is learned from writting and applying the tests)
    1. Once happy, merge them all

@daviddias daviddias changed the title version 1.0.0 roadmap First iteration of interface-ipfs-core Aug 20, 2016
@daviddias
Copy link
Contributor

daviddias commented Aug 20, 2016

Remaining (up for grabs :)):

@daviddias
Copy link
Contributor

@victorbjelkholm is handling files and DHT, name will be ms6. Closing this issue as clean up, tracking happens on the PR referenced in #18 (comment)

1 similar comment
@daviddias
Copy link
Contributor

@victorbjelkholm is handling files and DHT, name will be ms6. Closing this issue as clean up, tracking happens on the PR referenced in #18 (comment)

@Stebalien
Copy link
Contributor

@diasdavid I think the refs API is still missing.

@ntninja
Copy link

ntninja commented Dec 18, 2018

Any information on the refs API? Is there any difference between object.links(multihash) & refs(multihash)?

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

No branches or pull requests

4 participants