Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A tool to convert an OpenAPI spec to an OMS spec

Project description

openapi2oms

This tool aims to convert an OpenAPI 3 spec to its corresponding OMS equivalent. Not all features are supported, and some assumptions have been made. Please read the caveats section to understand these assumptions.

Storyscript

result = openapi2oms convert spec: openApiSpec properties: {"serverIndex": 0}

Caveats

Assumptions

  1. If there are multiple content types available for a given path, the content type application/json shall be preferred if available. If application/json is not available, then an appropriate content type will be chosen arbitrarily
  2. OMS doesn't support multiple responses. As such, the following order of response codes are considered as successful operations: 200, 201, 202, 2XX, 204, default. Furthermore, since multiple content types are not supported, application/json will be used if available. If application/json is not available, then an appropriate content type will be chosen arbitrarily

todos

related:

  1. [ ] https://github.com/microservices/openmicroservices.org/issues/50
  2. [x] https://github.com/microservices/openmicroservices.org/pull/96

License

MIT License

Project details


Release history Release notifications

Download files

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

Files for openapi2oms, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size openapi2oms-0.1.0-py3.6.egg (16.5 kB) File type Egg Python version 3.6 Upload date Hashes View hashes
Filename, size openapi2oms-0.1.0-py3-none-any.whl (9.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size openapi2oms-0.1.0.tar.gz (6.0 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