Include dev API in docs
Open
Nobody has claimed this yet.
cloud/server
- Dominant language
- Vue
- Stars
- 15
- Forks
- 22
- Avg merge
- 5d 11h
- Merged PRs (30d)
- 9
Description
if we have swagger definition of the public REST API it should be possible to easily create nice documentation for anyone who would like to use it for custom integrations
Contributor guide
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
The issue identifies the public REST API and a Swagger definition but names no files or entry points. Start by locating the API specification and the documentation site's integration points; done means the public API is documented in a form that is easy for custom integrators to use.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100