OpenAPI - CI/CD Glossary Definition
OpenAPI is the industry-standard specification format for describing HTTP APIs in a machine-readable document.
OpenAPI is a standard, language-agnostic specification format for describing HTTP APIs, formerly called Swagger. A CI job commonly lints the OpenAPI document and validates responses against it.
OpenAPI documents drive code generation, mock servers, and validation. In CI you can lint them, diff versions for breaking changes, and assert a running service matches its spec.
In CI
Tools like Spectral lint an OpenAPI file, and schema diff tools flag breaking changes between the base branch and a pull request.
Related guides
API Schema - CI/CD Glossary DefinitionAPI Schema: An API schema is a formal, machine-readable description of an API's data structures and operation…
Schema Validation - CI/CD Glossary DefinitionSchema Validation: Schema validation checks that a payload conforms to a defined schema: correct types, requi…
Breaking Change Detection - CI/CD Glossary DefinitionBreaking Change Detection: Breaking change detection compares two versions of an API schema or contract and f…