LizardByte / LizardByte/roadmap
Sunshine: Document the API using OpenAPI
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 2
- Forks
- 0
- Avg merge
- 25m
- Merged PRs (30d)
- 5
Description
Is there an existing issue for this item?
- I have searched the existing issues
Repositories
LizardByte/Sunshine
Languages/Skills/Technologies
Documentation, C++
Description
OpenAPI is the standard way to document APIs, let's try to move to that.
A PR has been started for this work although it is quite overwhelming as there is no auto generator for C++ (at least when using Simple-Web-Server). https://github.com/LizardByte/Sunshine/pull/3540
Estimated Effort
effort:Large
Priority
priority:Medium
Target Milestone
3-6 months
Dependencies
No response
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
Start by reviewing the existing work in PR #3540 for the Sunshine API and the issue's concern about generating OpenAPI documentation for C++. Determine the documentation scope and how the API should be represented without an automatic generator. Done means the API is documented using OpenAPI and the resulting documentation is complete enough to replace the current approach.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100