Skip to content

OverridesExample

Mike Ralphson edited this page Apr 21, 2020 · 2 revisions

Overrides Example

-o --overrides allows for flags like: x-override-description, which will override siblings with the name after the override defined.

For example ( using -o x-override- ) :

openapi: 3.0.0
info:
  title: API
  version: 1.0.0
  description: This is our API
  x-override-description: This is our secret API

Turns into:

openapi: 3.0.0
info:
  title: API
  version: 1.0.0
  description: This is our secret API
  x-override-description: This is our secret API

Justification: Sometimes we have private things like enum options. This lets us do things like:

name: options
type: string
enum:
  - A
  - B
x-internal-enum:
  - A
  - B
  - C
Clone this wiki locally