Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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:
    x-only: admin
    get:
      description: Get the admin settings

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.2.0
Filename, size File type Python version Upload date Hashes
Filename, size apiscrub-1.2.0-py3.7.egg (6.1 kB) File type Egg Python version 3.7 Upload date Hashes View hashes
Filename, size apiscrub-1.2.0.tar.gz (3.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page