marigold-dev / marigold-dev/tztools
Create an API documetation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 4
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Create a page that describes all endpoints. It would be nice to use some tool that does this automatically.
It would be nice to be able to request the API using this page too.
Probably here: https://tztools.gcp-npr.marigold.dev/api
Example: https://api.marigold.dev/
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the API at https://tztools.gcp-npr.marigold.dev/api and compare its intended presentation with https://api.marigold.dev/. Inspect the repository entry points that expose the endpoints and determine how an automatically generated, interactive page could cover all of them. Done means the page documents every endpoint and lets users request the API from the page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100