OpenAPI Analyser

Overview

Detects changes in OpenAPI specification files.

Dependencies

PyYAML

Parse YAML-formatted OpenAPI documents

Enable/Disable

Console

bumpwright --enable-analyser openapi
bumpwright --disable-analyser openapi

Config

[analysers]
openapi = true

[openapi]
paths = ["openapi.yaml"]

See also

For configuration options, see concepts/configuration#analysers.

Severity Rules

Change	Bump
Added endpoint	minor
Removed endpoint	major
Added schema	minor
Removed schema	major
Changed schema definition	major

Example

Diff

@@
paths:
  /pets:
-    get: {}
+    post: {}

Output

- [MAJOR] GET /pets: Removed endpoint
- [MINOR] POST /pets: Added endpoint