aws-cloudformation / aws-cloudformation/cloudformation-cli
Export a REST API from API Gateway as OpenAPI3.0 does not support type null in models
- Lingua principale
- Python
- Stelle
- 337
- Fork
- 172
- Merge medio
- 3g 5m
- PR unite (30g)
- 3
Descrizione
from model (jsonschema):
```
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"integer"
},
{
"$ref":"https://apigateway.amazonaws.com/restapis/{RestApiId}/models/Emails"
},
{
"$ref":"https://apigateway.amazonaws.com/restapis/{RestApiId}/models/Phones"
},
{
"type":"integer"
},
{
"type":"null"
}
]
}
```
generated OpenAPI3.0:
```
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"$ref": "#/components/schemas/Emails"
},
{
"$ref": "#/components/schemas/Phones"
},
null
]
}
```
if the model includes:
```
"properties": {
"name": {
"description": "Tenant Name",
"type": ["string","null"]
}
}
```
documentation for this scheme is not generated at all
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
L’issue non indica file del repository, test o punti di ingresso. Inizia individuando il percorso di esportazione dalla REST API a OpenAPI 3.0 e confronta la gestione di JSON Schema `type: null`, delle proprietà nullable e di `oneOf`; il lavoro è completo quando un output OpenAPI valido conserva il supporto per null e viene generata la documentazione per questi modelli.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- openapi
- Ambito
- api
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100