Metadata-Version: 2.1
Name: deforest
Version: 0.1.0
Summary: Remove all x-amazon tags from your OAS3 specification
Home-page: https://github.com/hawry/deforester
Author: hawry
Author-email: hawry@hawry.net
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Development Status :: 3 - Alpha
Description-Content-Type: text/markdown
Requires-Dist: pyyaml (==5.1.1)
Requires-Dist: click (==6.7)

# deforest

Remove all `x-amazon`-tags from your Open API 3 or Swagger 2 specification. Useful if you are using Cloudformation to specify your API Gateways, and want to provide your consumers with the same specification but not wanting to disclose your internal Amazon integrations.

# Installation
`pip install --user deforest`

## Features

- Clean keys starting with the string `x-amazon`
- Handles JSON and YAML input
- Handles JSON and YAML output (defaults to YAML)

# Usage
```
Usage: deforest [OPTIONS] INFILE

Options:
  -o, --outfile TEXT        specify output file, default is
                            ./<title>-<version>.<format>
  -f, --format [yaml|json]  output format  [default: yaml]
  -i, --indent INTEGER      if output format is json, specify indentation
  --version                 Show the version and exit.
  --help                    Show this message and exit.
```

# Limitations
The output file looses its order of the keys in the file, which shouldn't affect you if you're using a converter to create a graphical documentation/specification - but can be confusing if you have a specific internal order you wish to keep.


