morpheus-openapi

OpenAPI documentation for the Morpheus API

Building

First, download the repository and cd to the working directory:

git clone git@github.com:HewlettPackard/morpheus-openapi.git
cd morpheus-openapi

Build with docker:

docker run --rm -v $PWD:/spec redocly/cli bundle --dereferenced openapi.yaml > bundled.yaml

Build with rake:

rake build

This generates the complete openapi spec file named bundled.yaml in the current directory. You can use this file in any openapi 3.1.0 renderer.

Testing

Test with docker:

docker run --rm -v $PWD:/spec redocly/cli lint openapi.yaml --skip-rule no-invalid-media-type-examples
docker run --rm -v $PWD:/spec redocly/cli bundle --dereferenced openapi.yaml > bundled.yaml
docker run --rm -v $PWD:/tmp -it stoplight/spectral lint -v -F error \"/tmp/bundled.yaml\" --ruleset \"/tmp/.spectral.json\"

Test with rake:

rake test

NOTE: The OpenAPI spec is case senstive. This has caused problems when developing on Windows and Mac. You may get a good lint with the above commands, but when pushed, it will show any errors in the Actions log.

Publishing

Pushing to a branch which matches a defined version number with valid secret entry will bundle openapi.yaml using redocly-cli and upload to the destination given a good lint.

Branch name must match version name on destination at https://apidocs.morpheusdata.com

NOTE

Do not put any documentation into docs/ where the filename matches a tag in openapi.yaml. Bad things will happen, and we'll have to delete and resync.