Skip to main content

OpenAPI Scrubber

Project description

API Scrubber

An OpenAPI scrubber to process and remove certain information depending on the target audience. For example, given something like:

paths:
  /hello:
    get:
      description: Returns a hello world string.
  /admin:
    get:
      description: Get the admin settings
      x-only: admin

Then running apiscrub input.yaml - would result in:

paths:
  /hello:
    get:
      description: Returns a hello world string.

While running apiscrub --keep=admin input.yaml - would result in:

paths:
  /hello:
    get:
      description: Returns a hello world string.
  /admin:
    get:
      description: Get the admin settings

Note that the x-only metadata extension tag gets removed in both cases.

Installation

Install via Python:

$ pip install apiscrub

License

Copyright © 2018 Daniel G. Taylor

http://dgt.mit-license.org/

Project details


Download files

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

Files for apiscrub, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size apiscrub-1.0.1-py3-none-any.whl (3.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size apiscrub-1.0.1.tar.gz (3.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page