liveBook · Manning

Pull request

As explained in Automating API Delivery

A pull request is a proposed change submitted for review and integration into a version-controlled codebase.

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

How Automating API Delivery covers it

How deep it goes
Explains workflow states, automated gates, logs, and human review, but does not specify provider-specific commands or configuration.
Examples
Uses OpenAPI definition changes, PR discussion interfaces, build statuses and logs, warning reports, labels, and review status boards.
What it assumes
Assumes Git-based version control, API definition files, and familiarity with automated CI/CD checks.
What you can do after
Operate/configure a review workflow that exposes proposed API changes, validates them automatically, and routes them for human approval.
How it connects
Connects Git, version control, OpenAPI, CI/CD pipelines, API linting, breaking-change checks, and API design review.

Also explained in

Compare how 7 books explain pull request →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Automating API Delivery. The section links point to the parts of the book it draws on.