rstudio/plumber

Use `openapi-schema-validator` for `validate_api_spec()`

Open

#817 aberto em 9 de ago. de 2021

Ver no GitHub
 (0 comments) (1 reaction) (0 assignees)R (257 forks)batch import
difficulty: intermediateeffort: lowhelp wantedpriority: mediumtheme: OpenAPI

Métricas do repositório

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

Description

Found while resolving #796

npmjs.com/package/openapi-schema-validator has added support for OAS v3. (Live) Example: runkit.com/embed/fitj6h1o17e8

Describe the problem in detail

swagger-parser does not validate OAS v3. https://github.com/APIDevTools/swagger-parser/issues/164#issuecomment-895261437 This is 😢 .

openapi-schema-validator does validate OAS v3 and has a quarter million downloads a week. Should work fine.

Plan, remove swagger-validator and use openapi-schema-validator instead.

Guia do colaborador

Direção de pesquisa
Investigue o uso atual do swagger validator na base de código do plumber, provavelmente no módulo de validação. Revise a documentação e a API do pacote openapi schema validator. Implemente a substituição na função validate api spec. Certifique se de adicionar suporte a OAS v3. Teste com as especificações OAS v2 e v3.
Pilha de tecnologia
javascriptnodejs
Domain
api
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Gitnpm
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70