Gitcoin is GDPR complaint. Learn more in
Gitcoin's Terms & Conditions.
Check out the Issue Explorer
Looking to fund some work? You can submit a new Funded Issue here.
This is a Gitcoin bounty to write documentation for the Infura IPFS API.
This documentation will provide a detailed description of each supported IPFS method on Infura's IPFS endpoint, format for calling the methods, and format of the method's response. The description should include common use cases for each method.
An example of API documentation that we really like is Stripe's API documentation here, https://stripe.com/docs/api#intro
Prospective bounty claimer will provide examples of previously written documentation and present familiarity with Infura and its IPFS API.
Once approved for the bounty, the person will have a scheduled meeting with one of the maintainers of the IPFS API system. The maintainer will provide a detailed breakdown of the required documentation and answer any questions around the API and its use cases.
The person will then write the documentation per the details in this ticket and the provided information from the maintainer.
The person will submit the documentation within the agreed time frame and will address 2 rounds of feedback in the event that it is needed.
Once the feedback rounds are complete, the bounty reward will be distributed if the acceptance criteria are met.
The documentation has clear information for the following:
API call format for each method
API response examples for each method
Example use cases for all API methods including written description of the example
Any other criteria outlined by the maintainer during the scheduled meeting will be recorded here.
The expected time to complete the bounty is 9 hours. The timeline will start after the scheduled meeting with the maintainer. We will discuss an agreed upon timeline during the meeting with the maintainer.