Git Product home page Git Product logo

openapi-validator-docker's Introduction

[ARCHIVED] Docker image for IBM OpenAPI Validator

This was a small community Docker image providing IBM's OpenAPI Validator.

⚠️ Archived ⚠️

As of Issue 599 this image is deprecated and was archived 28/09/2023.

Archive

This repository is in archived state for 1 year. It will be deleted on or after 01/09/2024.

Run

  • To validate a specification file openapi.yaml in the current directory, mount the current directory at /data in the container (this is the image's default working directory):

    $ docker run \
         --volume "$PWD":/data \
         jamescooke/openapi-validator openapi.yaml
  • The init command can be used to generate the initial .validaterc file, which will be created in the mounted directory.

    $ docker run \
         --volume "$PWD":/data \
         jamescooke/openapi-validator init

    You may need to adjust the permissions of the generated file.

  • If you prefer to rename your config file, for example to config.json, then this can be passed with the --config flag:

    $ docker run \
         --volume "$PWD":/data \
         jamescooke/openapi-validator openapi.yaml --config config.json

Container

  • This is a "small-ish" container built on the official Node Alpine base image.

  • OpenAPI validator is installed in the container using npm.

  • Image tags are kept synchronised with the version of OpenAPI validator. For example, image 0.21.0 contains OpenAPI validator version 0.21.0:

    $ docker run jamescooke/openapi-validator:0.21.0 --version
    0.21.0

Links

Thanks

  • Dustin and the IBM team for their hard work on the OpenAPI Validator tool.

  • Martins and my Lucid teammates for all their help with Docker and containers.

openapi-validator-docker's People

Contributors

github-actions[bot] avatar jamescooke avatar m-allanson avatar mohamedelhabib avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.