docs(registry): three-endpoint overview table — catalog vs operator vs publisher#3559
Merged
Merged
Conversation
…s publisher Refs #3538 Problem 4 P1. Three overlapping lookup endpoints on the Registry API have no top-level prose tying them together. They live under two different tag groups in the docs, so a reader has to know which tag to start in. Adds an overview table to docs/registry/index.mdx covering: - /api/registry/agents — "give me the catalog" - /api/registry/operator?domain=X — "what does this entity operate?" - /api/registry/publisher?domain=X — "what does this entity publish?" Each row includes the question it answers, when to use it, auth-aware response-shape note where relevant. Auth-aware note on /operator added in #3542; /publisher parity tracked in #3546. Pure docs change. No schema or behavior change.
2 tasks
- Tag-group label is "Authorization Lookups" (renamed in #3542), not "Lookups & Authorization". - Reference deep links retarget to the Mintlify auto-generated per-endpoint pages (`/docs/registry/api-reference/authorization-lookups/{operator,publisher}-lookup`) — same pattern #3543 already uses on `registering-an-agent.mdx`. - Cited file:line on `registry-api.ts` updated to current main: `/operator` 5165→5486, `/publisher` 5229→5550 (drifted in the post-#3542 main merge). No prose-shape change beyond stale-reference fixes.
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
2 participants
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.
Refs #3538 Problem 4 P1.
Three overlapping Registry API lookup endpoints have no top-level prose tying them together. They live under two different tag groups in the docs, so a reader has to know which tag to start in.
What ships
docs/registry/index.mdxgets an overview table:/api/registry/agents/api/registry/operator?domain=X/api/registry/publisher?domain=XEach row has one short paragraph: when to use it, the source-of-truth field (
source,members,publisher_domain), and the auth-aware response-shape note where it applies.The auth-aware note on
/operatorwas added in #3542./publisherparity is tracked in #3546.Out of scope
/publisherauth-aware investigation — docs(registry): /publisher auth-aware response note (parity with /operator) #3546.?source=query param + UI segmentation — Problem 3 P1, separate PR.Test plan
node -e "JSON.parse(require('fs').readFileSync('docs.json','utf8'))"valid (if docs.json touched).