Redocly/redoc

OpenAPIParser's merge allOf doesn't merge examples

Open

#1.200 aberto em 9 de mar. de 2020

Ver no GitHub
 (1 comment) (1 reaction) (0 assignees)TypeScript (2.272 forks)batch import
Type: Enhancementhelp wantedopenapi

Métricas do repositório

Stars
 (21.877 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

I have the following response:

          "200" : {
            "description" : "The request has succeeded.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "statistics" : {
                      "allOf" : [ {
                        "$ref" : "#/components/schemas/pageStatistics"
                      }, {
                        "example" : {
                          "currentPage" : 1,
                          "pageSize" : 1
                        }
                      } ]
                    }
                  }
                }
              }
            }
         }

statistics uses a schema which contains a sample response, but it gets overwritten by example and it shall contain only two properties. It renders correctly in SwaggerUI, but not with Redoc as seen in the attached image.

Screen Shot 2020-03-09 at 14 49 23

Guia do colaborador

Direção de pesquisa
Examine a função mergeAllOf do OpenAPIParser para entender como os exemplos são tratados durante a composição do schema. O problema é que os exemplos de schemas allOf não são mesclados, fazendo com que o último exemplo sobrescreva os anteriores. Veja como o SwaggerUI lida com isso e compare com a implementação do Redoc.
Pilha de tecnologia
typescript
Domain
apidocumentation
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitTypeScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
20