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 details)

Uploaded Source

Built Distributions

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

Uploaded Source

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

Uploaded Python 3

File details

Details for the file openapi2oms-0.1.0.tar.gz.

File metadata

  • Download URL: openapi2oms-0.1.0.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.4

File hashes

Hashes for openapi2oms-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f392cda5e9ab7d8da544e4f7708c3da2fd6d6597e9849d8110f8c8260001391f
MD5 977eb7c6977b6988110a8f612ca546d0
BLAKE2b-256 f81ca6b6ed8d5da8263fde361b6ff687bb118f8c86cc0dea4c5c353946e32b5b

See more details on using hashes here.

File details

Details for the file openapi2oms-0.1.0-py3.6.egg.

File metadata

  • Download URL: openapi2oms-0.1.0-py3.6.egg
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.4

File hashes

Hashes for openapi2oms-0.1.0-py3.6.egg
Algorithm Hash digest
SHA256 c41be698c094e05c0e75bbe97554e07669061ab34b813718fa96e8fd66d8fd30
MD5 129ebc544296595d01e10e42629084b7
BLAKE2b-256 5d4c26bed4224519cb5aee4fce23ac054c5f5dfa2cb05998a3d7edf04cf1f06f

See more details on using hashes here.

File details

Details for the file openapi2oms-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: openapi2oms-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.4

File hashes

Hashes for openapi2oms-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4372eabc2dc1b152d09506c2ffc9093ccfe2ea5583285d37885a177b05002a52
MD5 d412a6fc06c74d1da0e366a26d53a8e2
BLAKE2b-256 af78f0d0c468ee1682a795a53758ccf274355a96d61037adb6fc6cf4e3b306d5

See more details on using hashes here.

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