[GitHub] [iceberg] kbendick opened a new issue #4040: Find a Good OpenAPI Spec Validator CLI Tool and Add Github Action to Validate REST Catalog Spec in CI

[GitBox <gi...@apache.org>]

kbendick opened a new issue #4040:
URL: https://github.com/apache/iceberg/issues/4040


   Right now, we rely on a variety of tools to inspect and validate the REST Catalogs OpenAPI specification.
   
   None standout as particularly amazing, so I've personally been using a smattering of tools from https://openapi.tools/ as well as copying / importing the YAML directly into editor.swaggger.io
   
   We should find a canonical OpenAPI YAML document validator and then add a Github Action to validate the spec on changes.
   
   I have a few that are all npm modules, but I'd like to find one that can support the recently released OpenAPI 3.1. And ideally, if something didn't need to be installed via npm to use in the CI pipeline, that would be nice to avoid having the extra overhead of nodejs in our github actions CI pipeline.
   
   Currently, the best I've used is `openapi-spec-validator`, which can be installed via `npm install -g openapi-spec-validator` and then run as a CLI tool via `openapi-spec-validator rest_docs/rest-catalog-open-api.yaml`.
   
   The error output of `openapi-spec-validator` is pretty cryptic, but when things are as good as it can determine, it spits out a plain `OK` which is easy to understand.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org