GitHub Actions and GitLab CI get a ready-made action and template from us. Azure DevOps, Bitbucket Pipelines and Jenkins get a snippet you paste into the pipeline, so here are those three, copy-paste ready.
We build Graphwake , which tells the teams that consume an API when a change in its OpenAPI spec is about to break them. Here's how to send it your spec from these three CI systems.
The idea: add one step to the pipeline that builds your API. It runs our open-source CI agent, which sends the service's OpenAPI spec to Graphwake with the build's context. On a pull request build the spec is stored as a draft, so the teams subscribed to a changed endpoint can hear about a breaking change before the merge. On a build of the live branch it becomes the live spec.
You need three things: the service's ingest key stored as a CI secret named GRAPHWAKE_KEY , the snippet for your platform, and the right live branch.
Before you start
You need a service in Graphwake that takes its spec from CI.…