Skip to content

ci: breaking-change gate on api-description.yaml (oasdiff) #249

Description

@rubenhensen

pg-pkg/api-description.yaml is the pinned v2 contract (#242). Add a CI job that diffs the PR's spec against main with oasdiff and fails on any breaking change (removed route/field, type change, new required field). Additive changes pass; a genuinely breaking change requires a new versioned route with the old one left running, or an explicit override label.

This is the API-seam half of protecting external consumers (see the external-compatibility umbrella). Part of #247 (workstream C).

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestwayfinder:taskWayfinder ticket: manual work unblocking a decision, or execution under this map

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions