Repository navigation
docs: place the Relay adaptor on the V1 route surface - #968
Merged
Merged
Conversation
The page told readers the evidence-offering route was retired. It is still served by the public lab's V1 Relay, and the real boundary is wider: every operation in the adaptor targets V1 paths that Relay V2 does not answer. Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
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.
Why
Follow-up to #967. Its
explanation/openfn-adaptorspage told readers that the V1 metadata route serving evidence offerings was retired, and that they should not build on the adaptor's offering listing. Both halves were off.The route is not retired from anything an adopter can reach: the public lab's Relay reports
0.4.0in its ownopenapi.jsonand still serves/metadata/evidence-offerings. Retirement applies to Relay V2, not to the V1 runtime the lab runs.The warning was also far too narrow.
@openfn/language-registry-relaybuilds every request against the V1 route surface (/v1/datasets,/v1/datasets/{dataset}/entities/{entity}/records,/metadata/...), whilecrates/registry-relay-v2/src/server.rsroutes only under/v2/resources/{resource}. Point the adaptor at a V2 deployment and every operation misses, not just the offering listing. What is specific to offerings is that they have no V2 successor:unsupported_familiesincrates/registry-relay-v2/src/artifacts.rsincludesevidence, and offerings are published by Registry Manifest.What changed
One page,
explanation/openfn-adaptors.mdx:Registry Relay V1@openfn/language-registry-notary, which the 0.1.0 beta leaves outside its scope alongside Relay, so readers reach for the Evidence adaptor. Written as an identifier only, percheck:notary-surfaceTODO[evidence]block repinned from a commit SHA to that repository'sv0.1.0tag, and its source list extended withCHANGELOG.mdcrates/registry-relay-v2/src/server.rsThe upstream README carried the same two errors; corrected in registrystack/openfn-language-registry-stack#3.
Checks
npm testindocs/site: 565 passed, 0 failednpm run check:productionindocs/site: pass, which coverscheck:source(evidence anchors, notary surface, style, links) and the built production checks