rstudio/plumber

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

Open

#817 opened on Aug 9, 2021

View on GitHub
 (0 comments) (1 reaction) (0 assignees)R (1,437 stars) (257 forks)batch import
difficulty: intermediateeffort: lowhelp wantedpriority: mediumtheme: OpenAPI

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.

Contributor guide

Tech stack
nodejs
Domain
apibackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with R package structureUnderstanding of OpenAPI spec validationKnowledge of plumber's validate api spec function
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the current use of swagger validator in plumber's codebase, likely in the validation module. Review the openapi schema validator package documentation and API. Implement the replacement in the validate api spec function. Ensure OAS v3 support is added. Test with both OAS v2 and v3 specifications.