docs(watch-list): document Signal Agents API and fix get-signals#94
Open
bguillou wants to merge 1 commit into
Open
docs(watch-list): document Signal Agents API and fix get-signals#94bguillou wants to merge 1 commit into
bguillou wants to merge 1 commit into
Conversation
Add the full Watch List / Signal Agents public API surface and correct the
existing (stale) get-signals reference.
New endpoints (v2.json + MDX wrappers + nav):
- GET/POST/PATCH/DELETE /watchlist list, create, update, delete Signal Agents
- GET /watchlist/history configuration history
- GET /watchlist/library available signal types
- GET /watchlist/filters allowed filters per signal type
- GET /watchlist/filter-values filter value autocomplete
Plus a Watch List object definition and 13 component schemas.
get-signals corrections (align the docs with the live API):
- response is the { data, meta.pagination } envelope, not { signals, total, offset, ... }
- remove the offset query param (the endpoint is page-based only)
- correct the SignalSchema type enum (7 -> 19) and the signalData fields
- drop the erroneous ApiKeyAuth override (the API uses Basic auth globally)
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
bguillou
requested review from
BenjMichel,
De70x,
Ynk33 and
nicolasmondain
and removed request for
Ynk33
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
1 participant
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.
What
Documents the Watch List / Signal Agents public API and fixes the existing
get-signalspage, which was out of date with the live API.Added
Endpoints under
/watchlist(OpenAPI operations inv2.json+ MDX wrappers + nav):GET/watchlistPOST/watchlistPATCH/watchlistDELETE/watchlistGET/watchlist/historyGET/watchlist/libraryGET/watchlist/filtersGET/watchlist/filter-valuesPlus a Watch List object definition (
WatchListSchema) and 13 new component schemas.Fixed (
get-signals){ data, meta: { pagination } }envelope (was{ signals, total, page, offset, limit }).offsetquery param — the endpoint is page-based only.SignalSchematypeenum (7 → 19 real signal types) and thesignalDatafields.ApiKeyAuthoverride so it inherits the global Basic auth like every other endpoint.Note on the diff size
The raw
v2.jsondiff looks large because the default (Myers) diff re-aligns the many repeated{ "type": "string", "description": ... }lines. The change is additive — 5 new paths and 13 new schemas, plus the targetedget-signalscorrections.git diff --histogramshows the true change: 54 deletions, all insideget-signals.Verification
v2.jsonanddocs.jsonare valid JSON.openapi:frontmatter resolves to an operation; everyopenapi-schema:/$refresolves — no dangling refs.mint broken-linksreports no new broken links (only pre-existing ones elsewhere).🤖 Generated with Claude Code