LizardByte / LizardByte/roadmap
Sunshine: Document the API using OpenAPI
Nessuno ha ancora preso questa issue.
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 2
- Fork
- 0
- Merge medio
- 25m
- PR unite (30g)
- 5
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando il lavoro esistente in PR #3540 per la Sunshine API e la preoccupazione sollevata nell'issue riguardo alla generazione della documentazione OpenAPI per C++. Determina l'ambito della documentazione e come dovrebbe essere rappresentata l'API senza un generatore automatico. Il lavoro è considerato completato quando l'API è documentata usando OpenAPI e la documentazione risultante è sufficientemente completa da sostituire l'approccio attuale.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- cpp, openapi
- Ambito
- api, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100