Skip to content

Latest commit

 

History

History
14 lines (12 loc) · 870 Bytes

COMPOSED.md

File metadata and controls

14 lines (12 loc) · 870 Bytes

Composed Mode

Composed mode compares two collections of OpenAPI specs instead of a pair of specs in the default mode. The collections are specified using a glob. This can be useful when your APIs are defined across multiple files, for example, when multiple services, each one with its own spec, are exposed behind an API gateway, and you want to check changes across all the specs at once.

Notes:

  1. Composed mode compares only paths and endpoints, other resources are compared only if referenced from the paths or endpoints.
  2. Composed mode doesn't support Path Prefix Modification
  3. Globs containing an asterisk (*) must be escaped or enclosed in quotes

Example:

oasdiff breaking --composed "data/composed/base/*.yaml" "data/composed/revision/*.yaml"