docs: document schemas, switch to redoc - Githubissues

ipfs / pinning-services-api-spec

Standalone, vendor-agnostic Pinning Service API for IPFS ecosystem

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

Creative Commons Zero v1.0 Universal

100 stars 27 forks source link

docs: document schemas, switch to redoc #35

Closed lidel closed 3 years ago

lidel commented 3 years ago

This PR improves API docs:

adds Schemas section and improves the order of sections to make onboarding easier
switches to ReDoc
- old doc renderer was too limited and had bugs which made it painful to create presentable docs we need
- used by big projects such as https://docs.discourse.org or https://docs.docker.com/engine/api/v1.25/
- enables us to pass custom YAML via #specUrl= for previews like below one

PREVIEW: https://bafybeih5udiukicsgnq65ufkkmdcsel5ojp25axfws7ifmdy52b5hfgkpi.ipfs.dweb.link/#specUrl=https://raw.githubusercontent.com/ipfs/pinning-services-api-spec/docs/switch-to-redoc/ipfs-pinning-service.yaml