Skip to content

SubmissionRequirement

Source code in docs_src/capo_abuse_signal/types/submission_requirement.py
class SubmissionRequirement(TypedDict, closed=True):
    code: NotRequired["str"]
    """<p>A stable, dot-namespaced identifier for the submission requirement that the report did not meet (for example, <code>rule.timestamp.too_old</code>). The set of codes is append-only, so treat an unrecognized value as opaque. This value is absent when the requirement that the report did not meet does not publish an identifier.</p> <p>The service checks the following submission requirements:</p> <ul> <li> <p> <code>rule.source_identifier.too_long</code> (<code>source_identifier</code>) – The value exceeds the maximum accepted length of 253 characters (the DNS hostname limit).</p> </li> <li> <p> <code>rule.source_identifier.forbidden_characters</code> (<code>source_identifier</code>) – The value contains characters that are never valid in an address (<code>{</code>, <code>}</code>, <code>*</code>, or <code>`</code>). These are common template-injection and command-injection markers.</p> </li> <li> <p> <code>rule.source_identifier.malformed</code> (<code>source_identifier</code>) – The value is not a valid IPv4 address, IPv6 address, URL, or domain name.</p> </li> <li> <p> <code>rule.timestamp.unparseable</code> (<code>timestamp</code>) – The value could not be parsed as an RFC 3339 date-time.</p> </li> <li> <p> <code>rule.timestamp.in_future</code> (<code>timestamp</code>) – The value is dated further into the future than the accepted clock-skew tolerance (a default of 1 hour).</p> </li> <li> <p> <code>rule.timestamp.too_old</code> (<code>timestamp</code>) – The value predates the submission lookback window (a default of 90 days). For content that is still accessible, set <code>timestamp</code> to the time you most recently observed it.</p> </li> <li> <p> <code>rule.evidence.content_type_mismatch</code> (<code>evidence</code>) – The decoded payload of an evidence item does not match its declared <code>content_type</code>. The <code>path</code> identifies the item, for example <code>/evidence/0</code>.</p> </li> </ul> <p>Submission requirement thresholds are configuration-driven and can change over time. The set of codes is append-only, so treat an unrecognized code as opaque.</p>"""
    path: "str"
    """<p>A JSON Pointer expression to the report member that did not meet the requirement. An empty string refers to the report as a whole.</p>"""
    message: "str"
    """<p>A detailed, human-readable description of the unmet submission requirement.</p>"""

code instance-attribute

code: NotRequired[str]

A stable, dot-namespaced identifier for the submission requirement that the report did not meet (for example, rule.timestamp.too_old). The set of codes is append-only, so treat an unrecognized value as opaque. This value is absent when the requirement that the report did not meet does not publish an identifier.

The service checks the following submission requirements:

  • rule.source_identifier.too_long (source_identifier) – The value exceeds the maximum accepted length of 253 characters (the DNS hostname limit).

  • rule.source_identifier.forbidden_characters (source_identifier) – The value contains characters that are never valid in an address ({, }, *, or `). These are common template-injection and command-injection markers.

  • rule.source_identifier.malformed (source_identifier) – The value is not a valid IPv4 address, IPv6 address, URL, or domain name.

  • rule.timestamp.unparseable (timestamp) – The value could not be parsed as an RFC 3339 date-time.

  • rule.timestamp.in_future (timestamp) – The value is dated further into the future than the accepted clock-skew tolerance (a default of 1 hour).

  • rule.timestamp.too_old (timestamp) – The value predates the submission lookback window (a default of 90 days). For content that is still accessible, set timestamp to the time you most recently observed it.

  • rule.evidence.content_type_mismatch (evidence) – The decoded payload of an evidence item does not match its declared content_type. The path identifies the item, for example /evidence/0.

Submission requirement thresholds are configuration-driven and can change over time. The set of codes is append-only, so treat an unrecognized code as opaque.

message instance-attribute

message: str

A detailed, human-readable description of the unmet submission requirement.

path instance-attribute

path: str

A JSON Pointer expression to the report member that did not meet the requirement. An empty string refers to the report as a whole.