Improve OpenAPI response schemas by marking guaranteed properties as required
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- openapi
- Ambito
- api, backend-api-design
Direzione di ricerca
Start by locating the OpenAPI response schemas and comparing their properties with the actual API responses to identify values that are guaranteed to be present. Review the securitySchemes definitions and the separate secure.soundcloud.com host question as part of the scope. Done means guaranteed response properties have accurate required arrays and the OAuth path decision is documented.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
The OpenAPI specification appears to be missing required declarations for many response properties.
For example, properties that appear to be consistently returned by the API are not included in the schema's required arrays. This causes OpenAPI-generated clients and TypeScript types to treat these properties as optional, even though they appear to be guaranteed in actual API responses.
Could the response schemas be reviewed and have properties marked as required where they are guaranteed to be present?
This would make the OpenAPI specification more accurately reflect the actual API contract and would improve the quality of generated clients.
One related question: OAuth is currently represented through the securitySchemes definitions, with the authorization and token URLs hosted at https://secure.soundcloud.com rather than the API host. Is the intention that the OAuth endpoints themselves are intentionally excluded from the OpenAPI paths, since they belong to the separate secure.soundcloud.com service?
- Lingua principale
- JavaScript
- Stelle
- 253
- Fork
- 53
- Merge medio
- 1m
- PR unite (30g)
- 1
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
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.
Altre issue di soundcloud/api
-
widget
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
soundcloud/api#557 · 1 commento ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 38/100
soundcloud/api#548 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
soundcloud/api#547 · 2 reazioni ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
soundcloud/api#545 · 2 commenti · 1 reazione ·
-
bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
soundcloud/api#537 · 7 commenti · 1 reazione ·
Tutte le issue di soundcloud/api
Issue simili
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
openlibhums/janeway#5604 ·
I maintainer di solito rispondono entro 1 giorno
-
[BUG] Generic OSC does not initialize OSC client on startup when "Listen for Feedback" is disabledAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
-
area/statement-execution TS conversion
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
scylladb/nodejs-rs-driver#584 ·
I maintainer di solito rispondono entro 2 giorni
-
新讀者走讀回報，照著一篇文章實際操作Apertadocumentation good first issue help wanted
Difficoltà 1/5 1-3 ore Idoneità per principianti 92/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 69/100
I maintainer di solito rispondono entro 3 giorni