This repository has been archived by the owner on Sep 28, 2023. It is now read-only.

[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

OpenAPI Validator: repository, releases
Docker container: docker hub

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.