Document API for external apps
Open
Nobody has claimed this yet.
1. to develop
developer experience
enhancement
technical debt
- Dominant language
- PHP
- Stars
- 36.9k
- Forks
- 5.2k
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 713
Description
We should settle on a documentation what external endpoints are available and how they can be used.
Best would be a approach where it is documented inline - @mathiasconradt proposed Swagger - there is also a PHP extractor: https://github.com/zircote/swagger-php
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 names no files, tests, or entry points. Start by inventorying the external endpoints and comparing inline Swagger documentation with the proposed PHP extractor; done means the available endpoints and their usage are documented consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100