Update from code changes: expanded response fields for takedowns, detections, reports, and assets - #98
Open
mintlify[bot] wants to merge 3 commits into
Open
Update from code changes: expanded response fields for takedowns, detections, reports, and assets#98mintlify[bot] wants to merge 3 commits into
mintlify[bot] wants to merge 3 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Update from code changes updated this PR. Clarified when to use organization reports list versus reports search, noting the new organization slug parameter. Source PRs
|
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
Document the additive response fields that ChainPatrol's public REST API and SDK now expose across takedowns, detections, detection configs, reports, and assets, and clarify when to use
GET /organization/reportsversusPOST /reports/search.Changes
external-api/takedowns-list.mdx— new "Response fields" section coveringexternalId,hasFilingDelay,hasLivenessCheckDelay,domainRegistrar,hostingProvider,tldRegistrar, andasset.livenessStatus/asset.blockedAt.external-api/detection-list.mdx— expanded Detection Result table withscore,reason,configId,reportedAt, andbrands[]; example JSON updated to match.external-api/organization-reports-list.mdx— Response Fields table and example extended withslaDueAt,externalSubmissionLink,duplicateOfId,imageDisplay,favoritedAt,attachments[], and a note onproposals.asset.scans[]. Overview prose now explains that the organization can be disambiguated with aslugand cross-referencesPOST /reports/searchfor asset-content lookups.external-api/threats-list.mdx— addedlivenessStatusto the response table, TypeScript interface, and example.external-api/asset-list.mdx— new "Response fields" section highlightingid(now included),livenessStatus, andblockedAt.external-api/asset-search.mdx— overview prose extended to mentionlivenessStatusandblockedAton the nested asset object; switched a relative link to a root-relative one.sdk/chainpatrol-client/instance-methods/asset-list.mdx— addedid,watchStatus,livenessStatus, andblockedAtto the SDK ResponseField list and example response; expanded the SEO description.Context
Follows chainpatrol/chainpatrol-web#7087 and chainpatrol/chainpatrol-web#7091, which added the response fields to the public API and SDK types, and chainpatrol/chainpatrol-web#7369, which rewrote the OpenAPI descriptions for
GET /organization/reportsandPOST /reports/searchto explain when to use each. All changes are additive; existing integrations continue to work unchanged.Update history
sdk/chainpatrol-client/instance-methods/asset-list.mdxfrontmatter description to meet length guidelines.external-api/organization-reports-list.mdxoverview to cover the newslugdisambiguator and cross-referencePOST /reports/search(chainpatrol/chainpatrol-web#7369).Note
Low Risk
Documentation-only updates describing additive API fields; no application or API behavior changes in this repo.
Overview
Updates external API and SDK docs to match newly exposed, additive response fields across assets, threats, detections, takedowns, and organization reports.
Assets & threats — Documents
id,livenessStatus, andblockedAton asset list/search, threats list, and takedown nested assets, including SDKasset.listresponse fields and examples.Detections — Expands the detection result schema with
score,reason,configId,reportedAt, andbrands[], with updated sample JSON.Takedowns & reports — Adds takedown-level
externalId, delay flags, registrar/hosting objects, and richer organization report fields (slaDueAt,duplicateOfId,attachments, etc.), plus guidance to usePOST /reports/searchfor deduping before filing.Also fixes a root-relative link in asset-search docs. No runtime code changes.
Reviewed by Cursor Bugbot for commit 1e643b7. Bugbot is set up for automated code reviews on this repo. Configure here.