Skip to main content

openapi2jsonschema2

A utility to extract JSON Schema from a valid OpenAPI specification.

Forked and updated from openapi2jsonschema. The original project does not appear to be maintained. All credit to the original authors.

Why

OpenAPI contains a list of type definitions using a superset of JSON Schema. These are used internally by various OpenAPI compatible tools. I found myself however wanting to use those schemas separately, outside existing OpenAPI tooling. Generating separate schemas for types defined in OpenAPI allows for all sorts of indepent tooling to be build which can be easily maintained, because the canonical definition is shared.

Installation

openapi2jsonschema2 is implemented in Python. Assuming you have a Python intepreter and pip installed you should be able to install with:

pip install openapi2jsonschema2

This has not yet been widely tested and is currently in a works on my machine state.

Usage

The simplest usage is to point the openapi2jsonschema2 tool at a URL containing a JSON (or YAML) OpenAPI definition like so:

openapi2jsonschema2 https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/openapi-spec/swagger.json

This will generate a set of schemas in a schemas directory. The tool provides a number of options to modify the output:

$ openapi2jsonschema2 --help
Usage: openapi2jsonschema2 [OPTIONS] SCHEMA

  Converts a valid OpenAPI specification into a set of JSON Schema files

Options:
  -o, --output PATH  Directory to store schema files
  -p, --prefix TEXT  Prefix for JSON references (only for OpenAPI versions
                     before 3.0)
  --stand-alone      Whether or not to de-reference JSON schemas
  --kubernetes       Enable Kubernetes specific processors
  --strict           Prohibits properties not in the schema
                     (additionalProperties: false)
  --help             Show this message and exit.

Example

My specific use-case was being able to validate a Kubernetes configuration file without a Kubernetes client like kubectl and without the server. For that I have a bash script, available here.

The output from running this script can be seen in the accompanying instrumenta/kubernetes-json-schema.

Metadata

Release files for openapi2jsonschema2 1.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openapi2jsonschema2 1.1.4
File Size Uploaded Provenance Actions
openapi2jsonschema2-1.1.4.tar.gz 6.3 kB Without provenance Details for openapi2jsonschema2-1.1.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for openapi2jsonschema2 1.1.4
File Interpreter ABI Platform Actions
openapi2jsonschema2-1.1.4-py3-none-any.whl Python 3 none any Details for openapi2jsonschema2-1.1.4-py3-none-any.whl

Total release size: 14.7 kB

Release files / openapi2jsonschema2-1.1.4.tar.gz

Download URL openapi2jsonschema2-1.1.4.tar.gz
Size 6.3 kB
Tags Source
SHA-256 checksum
How to use checksums
a35395132bc20ff0b027f480ec690b2899df8800f145154e5893ad14c804d8b7
BLAKE2b-256 checksum
How to use checksums
321dfea50fccd3ed6c81c8b801035d8be662e09dfa32460da11621a209b0b359
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.5 CPython/3.13.1 Linux/5.15.0-1074-azure

Release files / openapi2jsonschema2-1.1.4-py3-none-any.whl

Download URL openapi2jsonschema2-1.1.4-py3-none-any.whl
Size 8.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
627c5765520c938c0ab76ad1a3ee95401216a095476e48ef919a78da09a7560b
BLAKE2b-256 checksum
How to use checksums
42146a9218dac3af2dec8ff74c596c217ed4635d8e93ed0ad0da775dc5f1b89a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.5 CPython/3.13.1 Linux/5.15.0-1074-azure

Security for openapi2jsonschema2 1.1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.1.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page