Repository navigation
Conversation
…spec A code host lists the operations and parameters it sends in vars.yaml under api:. validate reads the published spec (cached in .cache/openapi.json for when the network is down, or the file in ZENROWS_OPENAPI) and checks that each operation exists, each parameter is one it takes, and the host's files send each name.
On a repository_dispatch from the docs repo (or by hand), wait for www.zenrows.com/openapi.json to carry the new spec, run validate, and on a host being out of date open or update one issue and post to #proj-integrations. A clean run closes the issue.
This was referenced Nov 12, 2026
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
When the API renames or drops a parameter, nothing tells us a host still sends it. This makes the published spec the reference and CI the verdict.
api:in a code host'svars.yamllists the operations and parameters it sends:npm run validatereads the published spec (https://www.zenrows.com/openapi.json, cached in.cache/for when the network is down, or the file inZENROWS_OPENAPI) and checks that each operation exists, each parameter is one it takes, and the host's rendered files send each name, so the list can't go stale and a mistyped name in the code shows up as not sent.api-changed.ymlruns on a ping from the docs repo (the spec's home) or by hand: waits for the published file to match the sha the ping carries, runs validate, and on a host being out of date opens or updates one issue and posts to #proj-integrations. A clean run closes the issue. A download failure fails the run without blaming a host.No host declares
api:yet; #5 adds it for Activepieces. The docs-side workflow that sends the ping comes separately, once the PR bot app is installed on this repo.How to check it
npm run render -- --check,npm run validateandnpm testpass (33 cases, 6 new, on a spec stub).js_instructionsis removed from a copy; warns and uses the cache with the network down.ghfor all three outcomes.