sceptre-openapi-substitution-hook 0.0.1

A Sceptre hook for resolving variables in openapi definitions.

README

Overview

Performs simple string substitution in openapi specifications.

Should be used until CloudFormation natively supports this feature.

Installation

Installation instructions

To install directly from PyPI

python3 -m pip install sceptre-openapi-substitution-hook

To install from the git repo

python3 -m pip install git+https://github.com/nicholasphair/sceptre-openapi-substitution-hook

Usage/Examples

Use the hook with a hook point

hooks:
  <hook_point>:
    - !openapi_substituter
      openapi:
        input: <input_path>
        output: <output_path>
        substitutions:
          <key>: <val>

The substituer will look for strings in the form of ${<key>} and replace them with <val>.

Example

hooks:
  before_validate:
    - !openapi_substituter
      openapi:
        input: ../templates/openapi.yaml
        output: ../templates/openapi.yaml
        substitutions:
          foo: bar
          baz: qux