Update from code changes: expanded response fields for takedowns, detections, reports, and assets#98
Open
mintlify[bot] wants to merge 2 commits into
Open
Update from code changes: expanded response fields for takedowns, detections, reports, and assets#98mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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.
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[].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.Context
Follows chainpatrol/chainpatrol-web#7087 and chainpatrol/chainpatrol-web#7091, which added these fields to the public API and SDK types. All changes are additive; existing integrations continue to work unchanged.
Note
Low Risk
Changes are documentation only with no runtime or API behavior in this repo; risk is limited to doc accuracy for integrators.
Overview
Docs-only update that describes new additive REST and SDK response fields shipped in chainpatrol-web, so integrators can use them without extra calls.
Assets & threats:
asset-list,asset-search,threats-list, and SDKasset.listnow documentid,livenessStatus, andblockedAt(pluswatchStatuson the SDK), with guidance on filtering dead assets and whenblockedAtdiffers fromupdatedAt.Detections:
detection-listexpands each hit withscore,reason,configId,reportedAt, andbrands[], and clarifies howconfidencerelates toscore.Reports & takedowns:
organization-reports-listaddsslaDueAt,externalSubmissionLink,duplicateOfId,imageDisplay,favoritedAt,attachments[], and notes onproposals.asset.scans[].takedowns-listaddsexternalId, delay flags, registrar/provider objects, and nested asset liveness/block time.Minor:
asset-searchfixes a takedown-tasks doc link to a root-relative path.Reviewed by Cursor Bugbot for commit e609a11. Bugbot is set up for automated code reviews on this repo. Configure here.