Update API documentation to reflect /summary endpoint and remove deprecated Beta tags#35
Merged
PhilSchroeder merged 8 commits intoEmergingThreats:masterfrom Jan 23, 2026
Merged
Conversation
…ry with expanded metadata fields This change renames the signature documentation endpoint and significantly expands the response structure to include comprehensive metadata. The new /summary endpoint returns detailed signature information including AI-generated descriptions, MITRE ATT&CK mappings, affected products, CVE references, performance impact, and deployment recommendations. Added two examples showing both AI-generated an
…cumentation sections
PhilSchroeder
approved these changes
Jan 23, 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.
Updated signature documentation endpoint from /v1/sids/{sid}/documentation to /v1/sids/{sid}/summary to match UI implementation
Added two real-world JSON examples showing AI-generated vs standard signature descriptions (SID 2032904 and 2029740)
Documented complete metadata object with 23 fields including MITRE ATT&CK mappings, CVE references, and AI-generation indicators
Removed Beta tags from CVE Information, Malware Information, Threat Actor Information, and Trends Information sections
Fixed typo in URL patterns summary: /v1/malare/{malware_family} → /v1/malware/{malware_family}
Added missing SID endpoints to URL patterns: /v1/sids/{sid}/text, /v1/sids/{sid}/summary, /v1/sids/{sid}/references
Added API version (v1) and last updated date (January 2026) to Introduction section