diff --git a/api/generated/api.json b/api/generated/api.json index 4752c51..748dbd7 100644 --- a/api/generated/api.json +++ b/api/generated/api.json @@ -12219,13 +12219,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -12400,13 +12400,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -12439,13 +12439,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -12463,13 +12463,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "authScheme": { "type": "string", @@ -14807,7 +14807,6 @@ "default": "api:create-installation" }, "content": { - "description": "The content of the config.", "title": "Config Content", "allOf": [ { @@ -16380,7 +16379,8 @@ } } } - ] + ], + "description": "The content of the config." } }, "description": "The config of the installation." @@ -16517,13 +16517,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -16698,13 +16698,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -16737,13 +16737,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -16761,13 +16761,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "authScheme": { "type": "string", @@ -19407,13 +19407,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -19588,13 +19588,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -19627,13 +19627,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -19651,13 +19651,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "authScheme": { "type": "string", @@ -22853,13 +22853,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -23034,13 +23034,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -23073,13 +23073,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -23097,13 +23097,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "authScheme": { "type": "string", @@ -25585,13 +25585,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -25766,13 +25766,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -25805,13 +25805,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -25829,13 +25829,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "authScheme": { "type": "string", @@ -28838,13 +28838,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -29019,13 +29019,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -29058,13 +29058,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -29082,13 +29082,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "authScheme": { "type": "string", @@ -33707,7 +33707,7 @@ "type": "string", "description": "The time the operation was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } } @@ -35388,7 +35388,7 @@ "type": "string", "description": "The time the operation was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -35660,7 +35660,7 @@ "timestamp": { "type": "string", "description": "The time the log was created.", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "message": { "type": "object", @@ -37484,6 +37484,25 @@ } } } + }, + "subscribeRequirements": { + "title": "Subscribe Requirements", + "type": "object", + "description": "Declares which auxiliary steps a provider requires to support subscriptions, beyond the per-object subscribe call itself.", + "properties": { + "registration": { + "type": "boolean", + "description": "Whether the provider requires a one-time registration step that is shared across all subscribed objects. The subscribe method is object-scoped, so if a separate API call is needed beyond per-object configuration (e.g., registering a single webhook/endpoint that all object subscriptions hang off of), registration is required." + }, + "maintenance": { + "type": "boolean", + "description": "Whether the subscription requires periodic maintenance. Some providers expire subscriptions/watches after a fixed TTL, so the subscription must be renewed on a schedule to remain active." + }, + "postProcess": { + "type": "boolean", + "description": "Whether subscribing requires a third-party setup step that the connector instance itself cannot perform. Examples: Salesforce requires AWS EventBridge configuration; Gmail requires a Google Pub/Sub topic to be configured. Any configuration that must happen outside the connector falls into post-process." + } + } } } } @@ -38884,6 +38903,25 @@ } } } + }, + "subscribeRequirements": { + "title": "Subscribe Requirements", + "type": "object", + "description": "Declares which auxiliary steps a provider requires to support subscriptions, beyond the per-object subscribe call itself.", + "properties": { + "registration": { + "type": "boolean", + "description": "Whether the provider requires a one-time registration step that is shared across all subscribed objects. The subscribe method is object-scoped, so if a separate API call is needed beyond per-object configuration (e.g., registering a single webhook/endpoint that all object subscriptions hang off of), registration is required." + }, + "maintenance": { + "type": "boolean", + "description": "Whether the subscription requires periodic maintenance. Some providers expire subscriptions/watches after a fixed TTL, so the subscription must be renewed on a schedule to remain active." + }, + "postProcess": { + "type": "boolean", + "description": "Whether subscribing requires a third-party setup step that the connector instance itself cannot perform. Examples: Salesforce requires AWS EventBridge configuration; Gmail requires a Google Pub/Sub topic to be configured. Any configuration that must happen outside the connector falls into post-process." + } + } } } } @@ -42687,13 +42725,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -42726,13 +42764,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -42750,13 +42788,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "authScheme": { "type": "string", @@ -43751,13 +43789,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -43790,13 +43828,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -43814,13 +43852,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "authScheme": { "type": "string", @@ -44946,13 +44984,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -44985,13 +45023,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -45009,13 +45047,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "authScheme": { "type": "string", @@ -46072,13 +46110,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -46111,13 +46149,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -46135,13 +46173,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "authScheme": { "type": "string", @@ -67826,13 +67864,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -68007,13 +68045,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -68046,13 +68084,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -68070,13 +68108,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "authScheme": { "type": "string", @@ -71615,13 +71653,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -71654,13 +71692,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -71678,13 +71716,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "authScheme": { "type": "string", @@ -72616,13 +72654,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -72655,13 +72693,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -72788,7 +72826,7 @@ "type": "string", "description": "The time the operation was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" } } }, @@ -72848,7 +72886,7 @@ "timestamp": { "type": "string", "description": "The time the log was created.", - "example": "2023-07-13T21:34:44.816Z" + "example": "2023-07-13T21:34:44.816354Z" }, "message": { "type": "object", diff --git a/catalog/catalog.yaml b/catalog/catalog.yaml index 5cb20f1..d2e1eea 100644 --- a/catalog/catalog.yaml +++ b/catalog/catalog.yaml @@ -527,6 +527,8 @@ components: type: string support: $ref: '#/components/schemas/Support' + subscribeRequirements: + $ref: '#/components/schemas/SubscribeRequirements' Provider: title: Provider diff --git a/catalog/generated/catalog.json b/catalog/generated/catalog.json index e89bb18..96ee4d4 100644 --- a/catalog/generated/catalog.json +++ b/catalog/generated/catalog.json @@ -1342,6 +1342,25 @@ } } } + }, + "subscribeRequirements": { + "title": "Subscribe Requirements", + "type": "object", + "description": "Declares which auxiliary steps a provider requires to support subscriptions, beyond the per-object subscribe call itself.", + "properties": { + "registration": { + "type": "boolean", + "description": "Whether the provider requires a one-time registration step that is shared across all subscribed objects. The subscribe method is object-scoped, so if a separate API call is needed beyond per-object configuration (e.g., registering a single webhook/endpoint that all object subscriptions hang off of), registration is required." + }, + "maintenance": { + "type": "boolean", + "description": "Whether the subscription requires periodic maintenance. Some providers expire subscriptions/watches after a fixed TTL, so the subscription must be renewed on a schedule to remain active." + }, + "postProcess": { + "type": "boolean", + "description": "Whether subscribing requires a third-party setup step that the connector instance itself cannot perform. Examples: Salesforce requires AWS EventBridge configuration; Gmail requires a Google Pub/Sub topic to be configured. Any configuration that must happen outside the connector falls into post-process." + } + } } } } @@ -1558,6 +1577,25 @@ } } } + }, + "subscribeRequirements": { + "title": "Subscribe Requirements", + "type": "object", + "description": "Declares which auxiliary steps a provider requires to support subscriptions, beyond the per-object subscribe call itself.", + "properties": { + "registration": { + "type": "boolean", + "description": "Whether the provider requires a one-time registration step that is shared across all subscribed objects. The subscribe method is object-scoped, so if a separate API call is needed beyond per-object configuration (e.g., registering a single webhook/endpoint that all object subscriptions hang off of), registration is required." + }, + "maintenance": { + "type": "boolean", + "description": "Whether the subscription requires periodic maintenance. Some providers expire subscriptions/watches after a fixed TTL, so the subscription must be renewed on a schedule to remain active." + }, + "postProcess": { + "type": "boolean", + "description": "Whether subscribing requires a third-party setup step that the connector instance itself cannot perform. Examples: Salesforce requires AWS EventBridge configuration; Gmail requires a Google Pub/Sub topic to be configured. Any configuration that must happen outside the connector falls into post-process." + } + } } } }, @@ -2541,6 +2579,25 @@ } } } + }, + "subscribeRequirements": { + "title": "Subscribe Requirements", + "type": "object", + "description": "Declares which auxiliary steps a provider requires to support subscriptions, beyond the per-object subscribe call itself.", + "properties": { + "registration": { + "type": "boolean", + "description": "Whether the provider requires a one-time registration step that is shared across all subscribed objects. The subscribe method is object-scoped, so if a separate API call is needed beyond per-object configuration (e.g., registering a single webhook/endpoint that all object subscriptions hang off of), registration is required." + }, + "maintenance": { + "type": "boolean", + "description": "Whether the subscription requires periodic maintenance. Some providers expire subscriptions/watches after a fixed TTL, so the subscription must be renewed on a schedule to remain active." + }, + "postProcess": { + "type": "boolean", + "description": "Whether subscribing requires a third-party setup step that the connector instance itself cannot perform. Examples: Salesforce requires AWS EventBridge configuration; Gmail requires a Google Pub/Sub topic to be configured. Any configuration that must happen outside the connector falls into post-process." + } + } } } } @@ -2863,7 +2920,7 @@ "properties": { "timestamp": { "type": "string", - "example": "2024-07-30T22:14:51.000Z", + "example": "2024-07-30T15:14:51-07:00", "description": "An RFC3339 formatted timestamp of when the catalog was generated.", "x-oapi-codegen-extra-tags": { "validate": "required" @@ -3847,6 +3904,25 @@ } } } + }, + "subscribeRequirements": { + "title": "Subscribe Requirements", + "type": "object", + "description": "Declares which auxiliary steps a provider requires to support subscriptions, beyond the per-object subscribe call itself.", + "properties": { + "registration": { + "type": "boolean", + "description": "Whether the provider requires a one-time registration step that is shared across all subscribed objects. The subscribe method is object-scoped, so if a separate API call is needed beyond per-object configuration (e.g., registering a single webhook/endpoint that all object subscriptions hang off of), registration is required." + }, + "maintenance": { + "type": "boolean", + "description": "Whether the subscription requires periodic maintenance. Some providers expire subscriptions/watches after a fixed TTL, so the subscription must be renewed on a schedule to remain active." + }, + "postProcess": { + "type": "boolean", + "description": "Whether subscribing requires a third-party setup step that the connector instance itself cannot perform. Examples: Salesforce requires AWS EventBridge configuration; Gmail requires a Google Pub/Sub topic to be configured. Any configuration that must happen outside the connector falls into post-process." + } + } } } } @@ -5031,6 +5107,25 @@ } } } + }, + "subscribeRequirements": { + "title": "Subscribe Requirements", + "type": "object", + "description": "Declares which auxiliary steps a provider requires to support subscriptions, beyond the per-object subscribe call itself.", + "properties": { + "registration": { + "type": "boolean", + "description": "Whether the provider requires a one-time registration step that is shared across all subscribed objects. The subscribe method is object-scoped, so if a separate API call is needed beyond per-object configuration (e.g., registering a single webhook/endpoint that all object subscriptions hang off of), registration is required." + }, + "maintenance": { + "type": "boolean", + "description": "Whether the subscription requires periodic maintenance. Some providers expire subscriptions/watches after a fixed TTL, so the subscription must be renewed on a schedule to remain active." + }, + "postProcess": { + "type": "boolean", + "description": "Whether subscribing requires a third-party setup step that the connector instance itself cannot perform. Examples: Salesforce requires AWS EventBridge configuration; Gmail requires a Google Pub/Sub topic to be configured. Any configuration that must happen outside the connector falls into post-process." + } + } } } }