Skip to content

A modern platform for visual, flexible, and extensible graph-based investigations. For cybersecurity analysts and investigators.

feat(types): primary_key

dextmorgn1e71db1e2dd0
diff --git a/flowsint-types/src/flowsint_types/address.py b/flowsint-types/src/flowsint_types/address.py
index 864f4f2e..ec108b68 100644
--- a/flowsint-types/src/flowsint_types/address.py
+++ b/flowsint-types/src/flowsint_types/address.py
@@ -6,7 +6,7 @@ from .flowsint_base import FlowsintType
class Location(FlowsintType):
"""Represents a physical address with geographical coordinates."""
- address: str = Field(..., description="Street address", title="Street Address")
+ address: str = Field(..., description="Street address", title="Street Address", json_schema_extra={"primary": True})
city: str = Field(..., description="City name", title="City")
country: str = Field(..., description="Country name", title="Country")
zip: str = Field(..., description="ZIP or postal code", title="ZIP/Postal Code")
diff --git a/flowsint-types/src/flowsint_types/affiliation.py b/flowsint-types/src/flowsint_types/affiliation.py
index f11d8317..f2332bb3 100644
--- a/flowsint-types/src/flowsint_types/affiliation.py
+++ b/flowsint-types/src/flowsint_types/affiliation.py
@@ -8,7 +8,7 @@ class Affiliation(FlowsintType):
"""Represents an organizational affiliation or employment relationship."""
organization: str = Field(
- ..., description="Organization or group name", title="Organization"
+ ..., description="Organization or group name", title="Organization", json_schema_extra={"primary": True}
)
role: Optional[str] = Field(
None, description="Role or position within organization", title="Role"
diff --git a/flowsint-types/src/flowsint_types/alias.py b/flowsint-types/src/flowsint_types/alias.py
index 274fb507..0572bfb6 100644
--- a/flowsint-types/src/flowsint_types/alias.py
+++ b/flowsint-types/src/flowsint_types/alias.py
@@ -7,7 +7,7 @@ from .flowsint_base import FlowsintType
class Alias(FlowsintType):
"""Represents an alias or alternative name used by an entity."""
- alias: str = Field(..., description="Alias or alternative name", title="Alias")
+ alias: str = Field(..., description="Alias or alternative name", title="Alias", json_schema_extra={"primary": True})
type: Optional[str] = Field(
None,
description="Type of alias (nickname, code name, etc.)",
diff --git a/flowsint-types/src/flowsint_types/asn.py b/flowsint-types/src/flowsint_types/asn.py
index e4334bc4..188f5b0e 100644
--- a/flowsint-types/src/flowsint_types/asn.py
+++ b/flowsint-types/src/flowsint_types/asn.py
@@ -11,7 +11,7 @@ class ASN(FlowsintType):
..., description="Autonomous System Number (e.g., 15169)", title="ASN Number"
)
asn_str: Optional[str] = Field(
- None, description="ASN in string format (e.g., 'AS15169')", title="ASN String"
+ None, description="ASN in string format (e.g., 'AS15169')", title="ASN String", json_schema_extra={"primary": True}
)
name: Optional[str] = Field(
None,
diff --git a/flowsint-types/src/flowsint_types/bank_account.py b/flowsint-types/src/flowsint_types/bank_account.py
index 3ef88642..dcac4173 100644
--- a/flowsint-types/src/flowsint_types/bank_account.py
+++ b/flowsint-types/src/flowsint_types/bank_account.py
@@ -8,7 +8,7 @@ class BankAccount(FlowsintType):
"""Represents a bank account with financial and security information."""
account_number: str = Field(
- ..., description="Bank account number", title="Account Number"
+ ..., description="Bank account number", title="Account Number", json_schema_extra={"primary": True}
)
bank_name: Optional[str] = Field(None, description="Bank name", title="Bank Name")
account_type: Optional[str] = Field(
diff --git a/flowsint-types/src/flowsint_types/breach.py b/flowsint-types/src/flowsint_types/breach.py
index 784619fb..f5ff9a4d 100644
--- a/flowsint-types/src/flowsint_types/breach.py
+++ b/flowsint-types/src/flowsint_types/breach.py
@@ -7,7 +7,7 @@ class Breach(FlowsintType):
"""Represents a data breach incident with affected accounts and details."""
name: str = Field(
- ..., description="The name of the breach or service", title="Breach Name"
+ ..., description="The name of the breach or service", title="Breach Name", json_schema_extra={"primary": True}
)
title: Optional[str] = Field(
None, description="Title of the breach", title="Breach Title"
diff --git a/flowsint-types/src/flowsint_types/cidr.py b/flowsint-types/src/flowsint_types/cidr.py
index ed414c43..48ea3247 100644
--- a/flowsint-types/src/flowsint_types/cidr.py
+++ b/flowsint-types/src/flowsint_types/cidr.py
@@ -7,7 +7,7 @@ class CIDR(FlowsintType):
"""Represents a CIDR (Classless Inter-Domain Routing) network block."""
network: IPvAnyNetwork = Field(
- ..., description="CIDR block (e.g., 8.8.8.0/24)", title="Network Block"
+ ..., description="CIDR block (e.g., 8.8.8.0/24)", title="Network Block", json_schema_extra={"primary": True}
)
@model_validator(mode='after')
diff --git a/flowsint-types/src/flowsint_types/credential.py b/flowsint-types/src/flowsint_types/credential.py
index 93a2d9b6..8f4c613b 100644
--- a/flowsint-types/src/flowsint_types/credential.py
+++ b/flowsint-types/src/flowsint_types/credential.py
@@ -7,7 +7,7 @@ from .flowsint_base import FlowsintType
class Credential(FlowsintType):
"""Represents user credentials with compromise and usage information."""
- username: str = Field(..., description="Username or identifier", title="Username")
+ username: str = Field(..., description="Username or identifier", title="Username", json_schema_extra={"primary": True})
service: Optional[str] = Field(
None,
description="Service or platform where credential is used",
diff --git a/flowsint-types/src/flowsint_types/credit_card.py b/flowsint-types/src/flowsint_types/credit_card.py
index 17d901e5..4c83d7db 100644
--- a/flowsint-types/src/flowsint_types/credit_card.py
+++ b/flowsint-types/src/flowsint_types/credit_card.py
@@ -7,7 +7,7 @@ from .flowsint_base import FlowsintType
class CreditCard(FlowsintType):
"""Represents a credit card with financial details and security status."""
- card_number: str = Field(..., description="Credit card number", title="Card Number")
+ card_number: str = Field(..., description="Credit card number", title="Card Number", json_schema_extra={"primary": True})
card_type: Optional[str] = Field(
None, description="Type of card (Visa, Mastercard, etc.)", title="Card Type"
)
diff --git a/flowsint-types/src/flowsint_types/device.py b/flowsint-types/src/flowsint_types/device.py
index 6f8995f2..2cf82f86 100644
--- a/flowsint-types/src/flowsint_types/device.py
+++ b/flowsint-types/src/flowsint_types/device.py
@@ -8,7 +8,7 @@ class Device(FlowsintType):
"""Represents a device with hardware, software, and network information."""
device_id: str = Field(
- ..., description="Unique device identifier", title="Device ID"
+ ..., description="Unique device identifier", title="Device ID", json_schema_extra={"primary": True}
)
type: Optional[str] = Field(
None,
diff --git a/flowsint-types/src/flowsint_types/dns_record.py b/flowsint-types/src/flowsint_types/dns_record.py
index 35b5e62f..2927c966 100644
--- a/flowsint-types/src/flowsint_types/dns_record.py
+++ b/flowsint-types/src/flowsint_types/dns_record.py
@@ -7,12 +7,17 @@ from .flowsint_base import FlowsintType
class DNSRecord(FlowsintType):
"""Represents a DNS record with type, value, and security information."""
+ value: str = Field(
+ ...,
+ description="Record value",
+ title="Record Value",
+ json_schema_extra={"primary": True},
+ )
record_type: str = Field(
...,
description="Type of DNS record (A, AAAA, CNAME, MX, etc.)",
title="Record Type",
)
- value: str = Field(..., description="Record value", title="Record Value")
ttl: Optional[int] = Field(None, description="Time to live in seconds", title="TTL")
priority: Optional[int] = Field(
None, description="Priority for MX records", title="Priority"
@@ -50,7 +55,7 @@ class DNSRecord(FlowsintType):
None, description="Threat level assessment", title="Threat Level"
)
- @model_validator(mode='after')
+ @model_validator(mode="after")
def compute_label(self) -> Self:
self.label = self.value
return self
diff --git a/flowsint-types/src/flowsint_types/document.py b/flowsint-types/src/flowsint_types/document.py
index 2c6f09c7..e7bac541 100644
--- a/flowsint-types/src/flowsint_types/document.py
+++ b/flowsint-types/src/flowsint_types/document.py
@@ -7,7 +7,7 @@ from .flowsint_base import FlowsintType
class Document(FlowsintType):
"""Represents a document with metadata, security, and content information."""
- title: str = Field(..., description="Document title", title="Title")
+ title: str = Field(..., description="Document title", title="Title", json_schema_extra={"primary": True})
doc_type: Optional[str] = Field(
None, description="Type of document (PDF, DOC, etc.)", title="Document Type"
)
diff --git a/flowsint-types/src/flowsint_types/email.py b/flowsint-types/src/flowsint_types/email.py
index 3630460d..5ace24a0 100644
--- a/flowsint-types/src/flowsint_types/email.py
+++ b/flowsint-types/src/flowsint_types/email.py
@@ -6,7 +6,7 @@ from .flowsint_base import FlowsintType
class Email(FlowsintType):
"""Represents an email address."""
- email: EmailStr = Field(..., description="Email address", title="Email Address")
+ email: EmailStr = Field(..., description="Email address", title="Email Address", json_schema_extra={"primary": True})
@model_validator(mode='after')
def compute_label(self) -> Self:
diff --git a/flowsint-types/src/flowsint_types/file.py b/flowsint-types/src/flowsint_types/file.py
index fea549b9..9640b20b 100644
--- a/flowsint-types/src/flowsint_types/file.py
+++ b/flowsint-types/src/flowsint_types/file.py
@@ -7,7 +7,7 @@ from .flowsint_base import FlowsintType
class File(FlowsintType):
"""Represents a file with metadata, type information, and security assessment."""
- filename: str = Field(..., description="File name", title="Filename")
+ filename: str = Field(..., description="File name", title="Filename", json_schema_extra={"primary": True})
file_type: Optional[str] = Field(
None, description="File type or extension", title="File Type"
)
diff --git a/flowsint-types/src/flowsint_types/gravatar.py b/flowsint-types/src/flowsint_types/gravatar.py
index cf1c5554..8590f1cc 100644
--- a/flowsint-types/src/flowsint_types/gravatar.py
+++ b/flowsint-types/src/flowsint_types/gravatar.py
@@ -7,7 +7,7 @@ class Gravatar(FlowsintType):
"""Represents a Gravatar profile with image and user information."""
src: HttpUrl = Field(..., description="Gravatar image URL", title="Image URL")
- hash: str = Field(..., description="Gravatar hash", title="Hash")
+ hash: str = Field(..., description="Gravatar hash", title="Hash", json_schema_extra={"primary": True})
size: Optional[int] = Field(
None, description="Image size in pixels", title="Image Size"
)
diff --git a/flowsint-types/src/flowsint_types/individual.py b/flowsint-types/src/flowsint_types/individual.py
index 4fcdb8c6..02087f10 100644
--- a/flowsint-types/src/flowsint_types/individual.py
+++ b/flowsint-types/src/flowsint_types/individual.py
@@ -18,7 +18,7 @@ class Individual(FlowsintType):
..., description="Last name of the individual", title="Last Name"
)
full_name: Optional[str] = Field(
- None, description="Full name of the individual", title="Full Name"
+ None, description="Full name of the individual", title="Full Name", json_schema_extra={"primary": True}
)
middle_name: Optional[str] = Field(
None, description="Middle name or initial", title="Middle Name"
diff --git a/flowsint-types/src/flowsint_types/leak.py b/flowsint-types/src/flowsint_types/leak.py
index b8cd252d..770ef2cd 100644
--- a/flowsint-types/src/flowsint_types/leak.py
+++ b/flowsint-types/src/flowsint_types/leak.py
@@ -8,7 +8,7 @@ class Leak(FlowsintType):
"""Represents a data leak or breach with associated data."""
name: str = Field(
- ..., description="The name of the leak or service brea", title="Leak Name"
+ ..., description="The name of the leak or service brea", title="Leak Name", json_schema_extra={"primary": True}
)
leak: Optional[List[Dict]] = Field(
None, description="List of data leaks found", title="Leak Data"
diff --git a/flowsint-types/src/flowsint_types/malware.py b/flowsint-types/src/flowsint_types/malware.py
index cacfab37..fb8aeaf7 100644
--- a/flowsint-types/src/flowsint_types/malware.py
+++ b/flowsint-types/src/flowsint_types/malware.py
@@ -7,7 +7,7 @@ from .flowsint_base import FlowsintType
class Malware(FlowsintType):
"""Represents malware with family, capabilities, and threat intelligence."""
- name: str = Field(..., description="Malware name or identifier", title="Name")
+ name: str = Field(..., description="Malware name or identifier", title="Name", json_schema_extra={"primary": True})
family: Optional[str] = Field(None, description="Malware family", title="Family")
type: Optional[str] = Field(
None, description="Type of malware (trojan, ransomware, etc.)", title="Type"
diff --git a/flowsint-types/src/flowsint_types/message.py b/flowsint-types/src/flowsint_types/message.py
index 16ac231b..8f15cab4 100644
--- a/flowsint-types/src/flowsint_types/message.py
+++ b/flowsint-types/src/flowsint_types/message.py
@@ -8,7 +8,7 @@ class Message(FlowsintType):
"""Represents a message with content, metadata, and security analysis."""
message_id: str = Field(
- ..., description="Unique message identifier", title="Message ID"
+ ..., description="Unique message identifier", title="Message ID", json_schema_extra={"primary": True}
)
content: str = Field(..., description="Message content", title="Content")
sender: Optional[str] = Field(None, description="Message sender", title="Sender")
diff --git a/flowsint-types/src/flowsint_types/organization.py b/flowsint-types/src/flowsint_types/organization.py
index e1b538ba..49cab9dc 100644
--- a/flowsint-types/src/flowsint_types/organization.py
+++ b/flowsint-types/src/flowsint_types/organization.py
@@ -9,7 +9,7 @@ class Organization(FlowsintType):
"""Represents an organization with detailed business and administrative information."""
# Basic information
- name: Any = Field(..., description="Organization name", title="Organization Name")
+ name: Any = Field(..., description="Organization name", title="Organization Name", json_schema_extra={"primary": True})
@model_validator(mode='before')
@classmethod
diff --git a/flowsint-types/src/flowsint_types/phone.py b/flowsint-types/src/flowsint_types/phone.py
index 3b3aaef9..ffb032df 100644
--- a/flowsint-types/src/flowsint_types/phone.py
+++ b/flowsint-types/src/flowsint_types/phone.py
@@ -8,7 +8,7 @@ from .flowsint_base import FlowsintType
class Phone(FlowsintType):
"""Represents a phone number with country and carrier information."""
- number: str = Field(..., description="Phone number", title="Phone Number")
+ number: str = Field(..., description="Phone number", title="Phone Number", json_schema_extra={"primary": True})
country: Optional[str] = Field(
None, description="Country code (ISO 3166-1 alpha-2)", title="Country Code"
)
diff --git a/flowsint-types/src/flowsint_types/phrase.py b/flowsint-types/src/flowsint_types/phrase.py
index d9b4dd54..601a43cc 100644
--- a/flowsint-types/src/flowsint_types/phrase.py
+++ b/flowsint-types/src/flowsint_types/phrase.py
@@ -8,7 +8,7 @@ class Phrase(FlowsintType):
"""Represents a phrase or text content."""
text: Any = Field(
- ..., description="The content of the phrase.", title="Phrase text value."
+ ..., description="The content of the phrase.", title="Phrase text value.", json_schema_extra={"primary": True}
)
@model_validator(mode='after')
diff --git a/flowsint-types/src/flowsint_types/port.py b/flowsint-types/src/flowsint_types/port.py
index aec16091..b77da7b6 100644
--- a/flowsint-types/src/flowsint_types/port.py
+++ b/flowsint-types/src/flowsint_types/port.py
@@ -6,7 +6,7 @@ from .flowsint_base import FlowsintType
class Port(FlowsintType):
"""Represents an open network port related to an IP address."""
- number: int = Field(..., description="Port number", title="Port Number")
+ number: int = Field(..., description="Port number", title="Port Number", json_schema_extra={"primary": True})
protocol: Optional[str] = Field(
None, description="Protocol (TCP, UDP, etc.)", title="Protocol"
)
diff --git a/flowsint-types/src/flowsint_types/reputation_score.py b/flowsint-types/src/flowsint_types/reputation_score.py
index 93a2e6fa..54424f8a 100644
--- a/flowsint-types/src/flowsint_types/reputation_score.py
+++ b/flowsint-types/src/flowsint_types/reputation_score.py
@@ -7,7 +7,7 @@ from .flowsint_base import FlowsintType
class ReputationScore(FlowsintType):
"""Represents a reputation score for an entity with historical data and trends."""
- entity_id: str = Field(..., description="Entity identifier", title="Entity ID")
+ entity_id: str = Field(..., description="Entity identifier", title="Entity ID", json_schema_extra={"primary": True})
entity_type: Optional[str] = Field(
None,
description="Type of entity (domain, IP, email, etc.)",
diff --git a/flowsint-types/src/flowsint_types/risk_profile.py b/flowsint-types/src/flowsint_types/risk_profile.py
index ac227cdb..05f57edd 100644
--- a/flowsint-types/src/flowsint_types/risk_profile.py
+++ b/flowsint-types/src/flowsint_types/risk_profile.py
@@ -7,7 +7,7 @@ from .flowsint_base import FlowsintType
class RiskProfile(FlowsintType):
"""Represents a comprehensive risk assessment profile for an entity."""
- entity_id: str = Field(..., description="Entity identifier", title="Entity ID")
+ entity_id: str = Field(..., description="Entity identifier", title="Entity ID", json_schema_extra={"primary": True})
entity_type: Optional[str] = Field(
None, description="Type of entity", title="Entity Type"
)
diff --git a/flowsint-types/src/flowsint_types/script.py b/flowsint-types/src/flowsint_types/script.py
index c7bed277..1e28642e 100644
--- a/flowsint-types/src/flowsint_types/script.py
+++ b/flowsint-types/src/flowsint_types/script.py
@@ -8,7 +8,7 @@ class Script(FlowsintType):
"""Represents a script or code file with analysis and security information."""
script_id: str = Field(
- ..., description="Unique script identifier", title="Script ID"
+ ..., description="Unique script identifier", title="Script ID", json_schema_extra={"primary": True}
)
name: Optional[str] = Field(None, description="Script name", title="Name")
language: Optional[str] = Field(
diff --git a/flowsint-types/src/flowsint_types/session.py b/flowsint-types/src/flowsint_types/session.py
index bd3692f8..cdc1c09b 100644
--- a/flowsint-types/src/flowsint_types/session.py
+++ b/flowsint-types/src/flowsint_types/session.py
@@ -8,7 +8,7 @@ class Session(FlowsintType):
"""Represents a user session with device and activity information."""
session_id: str = Field(
- ..., description="Unique session identifier", title="Session ID"
+ ..., description="Unique session identifier", title="Session ID", json_schema_extra={"primary": True}
)
user_id: Optional[str] = Field(None, description="User identifier", title="User ID")
service: Optional[str] = Field(
diff --git a/flowsint-types/src/flowsint_types/ssl_certificate.py b/flowsint-types/src/flowsint_types/ssl_certificate.py
index 8abc92f4..4812daf3 100644
--- a/flowsint-types/src/flowsint_types/ssl_certificate.py
+++ b/flowsint-types/src/flowsint_types/ssl_certificate.py
@@ -8,7 +8,7 @@ class SSLCertificate(FlowsintType):
"""Represents an SSL/TLS certificate with validation and security details."""
subject: str = Field(
- ..., description="Certificate subject (domain name)", title="Subject"
+ ..., description="Certificate subject (domain name)", title="Subject", json_schema_extra={"primary": True}
)
issuer: Optional[str] = Field(
None,
diff --git a/flowsint-types/src/flowsint_types/wallet.py b/flowsint-types/src/flowsint_types/wallet.py
index 95f04a40..7ad33596 100644
--- a/flowsint-types/src/flowsint_types/wallet.py
+++ b/flowsint-types/src/flowsint_types/wallet.py
@@ -7,7 +7,7 @@ from .flowsint_base import FlowsintType
class CryptoWallet(FlowsintType):
"""Represents a cryptocurrency wallet."""
- address: str = Field(..., description="Wallet address", title="Wallet Address")
+ address: str = Field(..., description="Wallet address", title="Wallet Address", json_schema_extra={"primary": True})
node_id: Optional[str] = Field(
None, description="Wallet Explorer node ID", title="Node ID"
)
@@ -56,7 +56,7 @@ class CryptoWalletTransaction(FlowsintType):
None, description="Target wallet", title="Target Wallet"
)
hash: Optional[str] = Field(
- None, description="Transaction hash", title="Transaction Hash"
+ None, description="Transaction hash", title="Transaction Hash", json_schema_extra={"primary": True}
)
value: Optional[float] = Field(
None, description="Transaction value in cryptocurrency", title="Value"
@@ -158,6 +158,7 @@ class CryptoNFT(FlowsintType):
...,
description="Unique token ID of the NFT within the contract",
title="Token ID",
+ json_schema_extra={"primary": True}
)
collection_name: Optional[str] = Field(
None, description="Name of the NFT collection", title="Collection Name"
diff --git a/flowsint-types/src/flowsint_types/weapon.py b/flowsint-types/src/flowsint_types/weapon.py
index e418ef29..57aa444f 100644
--- a/flowsint-types/src/flowsint_types/weapon.py
+++ b/flowsint-types/src/flowsint_types/weapon.py
@@ -7,7 +7,7 @@ from .flowsint_base import FlowsintType
class Weapon(FlowsintType):
"""Represents a weapon with detailed specifications and forensic information."""
- name: str = Field(..., description="Weapon name or identifier", title="Name")
+ name: str = Field(..., description="Weapon name or identifier", title="Name", json_schema_extra={"primary": True})
type: Optional[
Literal[
"firearm",
diff --git a/flowsint-types/src/flowsint_types/web_tracker.py b/flowsint-types/src/flowsint_types/web_tracker.py
index c9eb5e83..7434c927 100644
--- a/flowsint-types/src/flowsint_types/web_tracker.py
+++ b/flowsint-types/src/flowsint_types/web_tracker.py
@@ -8,7 +8,7 @@ class WebTracker(FlowsintType):
"""Represents a web tracking technology with privacy and compliance information."""
tracker_id: str = Field(
- ..., description="Unique tracker identifier", title="Tracker ID"
+ ..., description="Unique tracker identifier", title="Tracker ID", json_schema_extra={"primary": True}
)
name: Optional[str] = Field(None, description="Tracker name", title="Name")
type: Optional[str] = Field(
diff --git a/flowsint-types/src/flowsint_types/website.py b/flowsint-types/src/flowsint_types/website.py
index bf3d9ef0..6160eaef 100644
--- a/flowsint-types/src/flowsint_types/website.py
+++ b/flowsint-types/src/flowsint_types/website.py
@@ -8,7 +8,7 @@ class Website(FlowsintType):
"""Represents a website with its URL, domain, and redirect information."""
url: HttpUrl = Field(
- ..., description="Full URL of the website", title="Website URL"
+ ..., description="Full URL of the website", title="Website URL", json_schema_extra={"primary": True}
)
redirects: Optional[List[HttpUrl]] = Field(
[], description="List of redirects from the website", title="Redirects"
diff --git a/flowsint-types/src/flowsint_types/whois.py b/flowsint-types/src/flowsint_types/whois.py
index 7d2516d6..659200f9 100644
--- a/flowsint-types/src/flowsint_types/whois.py
+++ b/flowsint-types/src/flowsint_types/whois.py
@@ -9,7 +9,7 @@ from .flowsint_base import FlowsintType
class Whois(FlowsintType):
"""Represents WHOIS domain registration information."""
- domain: Domain = Field(..., description="Domain information", title="Domain")
+ domain: Domain = Field(..., description="Domain information", title="Domain", json_schema_extra={"primary": True})
registry_domain_id: Optional[str] = Field(
None, description="Registry Domain ID (unique identifier)", title="Registry Domain ID"
)