Document the advertisement status endpoint in the OpenAPI schema - #41
Open
nymd wants to merge 1 commit into
Open
Document the advertisement status endpoint in the OpenAPI schema#41nymd wants to merge 1 commit into
nymd wants to merge 1 commit into
Conversation
Add GET /sync/status/ad/{cid} alongside the existing publisher sync
status endpoints, with an AdStatus schema and a worked example.
The endpoint is live on cid.contact and in use by publishers, but was
the one sync status route missing from the schema. It returns only the
requested CID and an Indexed boolean; no phase data, timestamps, or
provider identity are stored per advertisement.
Indexed is true only when the advertisement was fully processed while
the indexer was configured to store its entries. Advertisements that
were skipped, are still in progress, failed, or have never been seen
report false, so a false result is not on its own evidence that the
advertisement was rejected.
byo
approved these changes
Aug 7, 2026
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.
Add GET /sync/status/ad/{cid} alongside the existing publisher sync status endpoints, with an AdStatus schema and a worked example.
Indexed is true only when the advertisement was fully processed while the indexer was configured to store its entries. Advertisements that were skipped, are still in progress, failed, or have never been seen report false, so a false result is not on its own evidence that the advertisement was rejected.