A pull request proposes changes to version-controlled API definitions for discussion, review, automated validation, and eventual integration into a branch. Storing OpenAPI files in Git preserves history, supports collaboration, and enables CI/CD automation. section 1.5.2 section 8.7
Treat the pull request as a review boundary rather than merely a merge request. Reviewers can discuss proposed changes and track follow-up revisions, while automated checks establish minimum criteria before human API governance review begins. section 8.7
An API-definition pull request commonly supports this workflow:
- Raise a change against the Git repository that stores the API definitions. section 1.5.2
- Trigger a PR build that runs API linting, breaking-change checks, documentation linting, or other custom checks. section 8.7
- Inspect build status and logs; configure the build to fail for ERROR-level linting problems or breaking changes. section 8.7
- Review warnings and design choices manually, because a passing build does not replace API governance judgment. section 8.7
Visible review states
A review PR may move through Backlog, Assigned or Scheduled, In Review, Changes Requested, Approved, and Rejected. Labels or a status board make ownership, prioritization, decisions, and outstanding actions visible to stakeholders. section 5.5.12






