Skip to content

Commit a63a0c0

Browse files
authored
docs(api): list all 3 supported webhook event types in CreateWebhookRequest (#2155)
The event_types field description said 'Currently supported: consolidation.completed', but the API actually emits and accepts all three events: - retain.completed (memory_engine.py) - consolidation.completed (memory_engine.py) - memory_defense.triggered (retain/orchestrator.py) Update the description accordingly and propagate through the regenerated OpenAPI spec + the embedded copies in the go/python/typescript clients. Description-only change; no behavior change.
1 parent 30fb287 commit a63a0c0

7 files changed

Lines changed: 8 additions & 7 deletions

File tree

hindsight-api-slim/hindsight_api/api/http.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2670,7 +2670,7 @@ class CreateWebhookRequest(BaseModel):
26702670
secret: str | None = Field(default=None, description="HMAC-SHA256 signing secret (optional)")
26712671
event_types: list[str] = Field(
26722672
default=["consolidation.completed"],
2673-
description="List of event types to deliver. Currently supported: 'consolidation.completed'",
2673+
description="List of event types to deliver. Supported: 'retain.completed', 'consolidation.completed', 'memory_defense.triggered'.",
26742674
)
26752675
enabled: bool = Field(default=True, description="Whether this webhook is active")
26762676
http_config: WebhookHttpConfig = Field(

hindsight-clients/go/api/openapi.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5103,7 +5103,8 @@ components:
51035103
event_types:
51045104
default:
51055105
- consolidation.completed
5106-
description: "List of event types to deliver. Currently supported: 'consolidation.completed'"
5106+
description: "List of event types to deliver. Supported: 'retain.completed',\
5107+
\ 'consolidation.completed', 'memory_defense.triggered'."
51075108
items:
51085109
type: string
51095110
type: array

hindsight-clients/go/model_create_webhook_request.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

hindsight-clients/python/hindsight_client_api/models/create_webhook_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class CreateWebhookRequest(BaseModel):
2929
""" # noqa: E501
3030
url: StrictStr = Field(description="HTTP(S) endpoint URL to deliver events to")
3131
secret: Optional[StrictStr] = None
32-
event_types: Optional[List[StrictStr]] = Field(default=None, description="List of event types to deliver. Currently supported: 'consolidation.completed'")
32+
event_types: Optional[List[StrictStr]] = Field(default=None, description="List of event types to deliver. Supported: 'retain.completed', 'consolidation.completed', 'memory_defense.triggered'.")
3333
enabled: Optional[StrictBool] = Field(default=True, description="Whether this webhook is active")
3434
http_config: Optional[WebhookHttpConfig] = Field(default=None, description="HTTP delivery configuration (method, timeout, headers, params)")
3535
__properties: ClassVar[List[str]] = ["url", "secret", "event_types", "enabled", "http_config"]

hindsight-clients/typescript/generated/types.gen.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1224,7 +1224,7 @@ export type CreateWebhookRequest = {
12241224
/**
12251225
* Event Types
12261226
*
1227-
* List of event types to deliver. Currently supported: 'consolidation.completed'
1227+
* List of event types to deliver. Supported: 'retain.completed', 'consolidation.completed', 'memory_defense.triggered'.
12281228
*/
12291229
event_types?: Array<string>;
12301230
/**

hindsight-docs/static/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7748,7 +7748,7 @@
77487748
},
77497749
"type": "array",
77507750
"title": "Event Types",
7751-
"description": "List of event types to deliver. Currently supported: 'consolidation.completed'",
7751+
"description": "List of event types to deliver. Supported: 'retain.completed', 'consolidation.completed', 'memory_defense.triggered'.",
77527752
"default": [
77537753
"consolidation.completed"
77547754
]

skills/hindsight-docs/references/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7748,7 +7748,7 @@
77487748
},
77497749
"type": "array",
77507750
"title": "Event Types",
7751-
"description": "List of event types to deliver. Currently supported: 'consolidation.completed'",
7751+
"description": "List of event types to deliver. Supported: 'retain.completed', 'consolidation.completed', 'memory_defense.triggered'.",
77527752
"default": [
77537753
"consolidation.completed"
77547754
]

0 commit comments

Comments
 (0)