Skip to main content

A command called openapi and foo for the cloudmesh shell

Project description

Cloudmesh OpenAPI Merge

Prerequisits

$ pip install cloudmesh.openapi

Usage

The manual page for the cms openapi command is

cms openapi merge [SERVICES...] [--dir=DIR]
cms openapi list [--dir=DIR]
cms openapi description [SERVICES...] [--dir=DIR]
cms openapi md FILE [--indent=INDENT]

You need to have the yaml file in the current directory and execute this program in this directory

An example for yaml files are provided in

Please note that the spec directory is containing openapi specifications that may not yet completed or are actively worked on. You are invited to participate. You can download some examples, as well as the .header.yaml file you will need with for example curl

Once you have organization.yaml, user.yaml timestap.yaml and .header yaml in your directory you can say

Please note that this script does not yet rewrite the $ref appropriately, but if you like to help you can do so.

Example use

Here we demonstrate an example use

First we download some OpenAPI examples:

mkdir example
cd example
$ export SPEC=https://raw.githubusercontent.com/cloudmesh-community/nist/master/spec
$ curl $SPEC/organization.yaml > organization.yaml
$ curl $SPEC/user.yaml > user.yaml
$ curl $SPEC/timestamp.yaml > timestamp.yaml
$ curl $SPEC/.header.yaml > .header.yaml

Now let us look at the descriptions with

$ cms openapi description organization user timestamp

To create a merged specification you can use

$ cms openapi merge organization user timestamp

To create a markdown representation you can use

$ cms openapi md user

Note that for the markdown specification only one service is specified.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cloudmesh.openapi, version 1.4.24
Filename, size File type Python version Upload date Hashes
Filename, size cloudmesh.openapi-1.4.24-py2.py3-none-any.whl (7.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size cloudmesh.openapi-1.4.24.zip (12.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page