0xironclad / 0xironclad/Task-Scheduler-API
Add OpenAPI spec
Aperta
api
docs
- Lingua principale
- TypeScript
- Stelle
- 0
- Fork
- 2
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Document endpoints, payloads, and error shapes in a `openapi.yaml`. Optional Swagger UI.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Direzione di ricerca
Esamina le route Express esistenti nella codebase per comprendere gli endpoint, i payload di richiesta/risposta e i formati di errore. Crea un file openapi.yaml che li documenti. Opzionalmente, integra un pacchetto Swagger UI per servire la specifica. Verifica che la specifica corrisponda al comportamento effettivo dell'API testando gli endpoint.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- express, node.js, openapi, typescript
- Ambito
- api, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 55/100