Skip to main content

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. https://github.com/microservices/openmicroservices.org/pull/96

License

MIT License

Project details


Download files

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

Source Distribution

openapi2oms-0.1.0.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distributions

openapi2oms-0.1.0-py3.6.egg (16.5 kB view hashes)

Uploaded Source

openapi2oms-0.1.0-py3-none-any.whl (9.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page