Optional types in schema, ex: GET /employee returns values where id is optional
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- openapi
- Ambito
- api, backend-api-design
Direzione di ricerca
Inizia con lo schema OpenAPI/Swagger per Employee e confronta la risposta di GET /employee con il modello della richiesta POST. Verifica come i tipi condivisi contrassegnano id come opzionale, quindi usa openapi-ts per verificare i tipi generati. Il lavoro è completato quando lo schema distingue accuratamente i campi obbligatori della risposta dai campi che possono essere assenti durante la creazione di un dipendente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
We are using https://openapi-ts.pages.dev/ to generate client code and there are optional types in Tripletex's swagger schema which I believe could have been marked as required. Example Employee and it's id:
This results in generated code where id is optional:
I'm guessing this may have to do something with type being used in multiple contexts, like when you POST a new employee? But it would have been nice to have accurate types for different operations :)
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 49
- Fork
- 47
- Merge medio
- 1h 1m
- PR unite (30g)
- 1
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
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 Tripletex/tripletex-api2
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
Tripletex/tripletex-api2#133 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
Tripletex/tripletex-api2#130 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
Tripletex/tripletex-api2#127 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
Tripletex/tripletex-api2#126 · 1 reazione ·
-
faktura( 1500 konto) Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
Tripletex/tripletex-api2#114 ·
Tutte le issue di Tripletex/tripletex-api2
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
mksglu/context-mode#1200 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
clawsweeper:needs-maintainer-review clawsweeper:needs-product-decision clawsweeper:no-new-fix-pr impact:auth-provider issue-rating: 🌊 off-meta tidepool P2
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 80/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100