Comments (4)
jessicaschilling
commented on June 28, 2024
1
Also an entry point from docs.ipfs.io 😊
from pinning-services-api-spec.
lidel
commented on June 28, 2024
1
@GregTheGreek turns out https://mrin9.github.io/RapiDoc/ was super easy to set up as a quick way to get docs for master branch – see #11:
If you want to add something more advanced to add preview to PRs, PR welcome, but I think its good enough.
from pinning-services-api-spec.
GregTheGreek
commented on June 28, 2024
Is there a preferred doc generator? Happy to tackle this.
from pinning-services-api-spec.
lidel
commented on June 28, 2024
@GregTheGreek afaik there is no preference, the initial draft uses OpenAPI 3.0.0 YAML format, at this stage anything that consumes ipfs-pinning-service.yaml and produces human-readable docs will do.
Are you still up for it?
Some ideas:
from pinning-services-api-spec.
Related Issues (20)
- 2022 IPFS Thing - spec discussion HOT 2
- ipfs.github.io went wrong
- Ipao
- JS server generation problems HOT 8
- Providing content with a pin request HOT 36
- Document need for /wss on delegates list HOT 1
- How to create an AccessToken? HOT 4
- Feature proposal: ability to get bulk pin statuses by request IDs
- golang client fails to deserialize metadata objects
- Proposal: IPNS pinning HOT 11
- API v2 proposal: remove PinResults.count HOT 11
- Document UCAN as one of Authorization options
- Allow nulls HOT 4
- Document self-hosting options
- API should be idempotent
- What's the difference between the status `pinning` and `queued` HOT 1
- Proposal: Spec update - replacePin should support "update" like operations HOT 8
- Document caveats around key-value pinset stores HOT 4
- Discussion: Does Pinning Services API Spec have limitations that prevent scalability? HOT 1
- List pin objects endpoint not working properly?
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pinning-services-api-spec.