Review our use of the `default` OpenAPI spec feature
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- openapi
- Ambito
- api, documentation
Direzione di ricerca
Iniziate individuando la specifica TAMS OpenAPI e cercando ogni utilizzo della funzionalità default. Esaminate come questi valori predefiniti possano influire sulla convalida delle richieste e sulle implementazioni, quindi documentate le raccomandazioni in una Application Note e applicate le modifiche concordate all'intera specifica.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Context
The TAMS spec has avoided the use of OpenAPI spec's default feature as it can lead to unexpected behaviour in some cases. For example, libraries that validate requests against the spec sometimes automatically set the defaults. We should review how widely we use the default feature and provide clear guidance on its use.
Actions
- Review our use of the OpenAPI spec
defaultfeature in TAMS, including where it may result in unexpected behaviour - Review the impact the change will have on implementations
- Write up recommendations for its use in TAMS
- Roll out these recommendations across its spec
Outcome
- Application Note on use of the OpenAPI spec
defaultfeature - Spec changes as appropriate
- Lingua principale
- Makefile
- Stelle
- 117
- Fork
- 13
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi 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.
Altre issue di bbc/tams
-
Allow UUID versions 6-8 for idsForse già presa Una pull request collegata a questa issue è aperta o già unita. Apertaenhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
App Note 14 clarification for full API pathForse già presa Una pull request collegata a questa issue è aperta o già unita. Apertatsc-discuss
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
appnote
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
[BUG] Flow Profiles can't be deletedForse già presa Una pull request collegata a questa issue è aperta o già unita. Apertatsc-discuss
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
-
enhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 30/100
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
G-nn-r/lg_heatpump#52 ·
-
area: core bug priority: high
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
griffinwork40/agent-afk#4872 ·
I maintainer di solito rispondono entro 1 giorno
-
fleet size/m
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
sipyourdrink-ltd/bernstein#7517 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
I maintainer di solito rispondono entro 1 giorno
-
BUG-MERGE-TO-HDR-RESULT-NAMEForse già presa Una pull request collegata a questa issue è aperta o già unita. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
storytold/photocraft#14025 ·
I maintainer di solito rispondono entro 1 giorno