diff --git a/api/generated/api.json b/api/generated/api.json index c6f2119..3513993 100644 --- a/api/generated/api.json +++ b/api/generated/api.json @@ -37249,6 +37249,25 @@ "type": "string" } }, + "subscribeRequirements": { + "title": "Subscribe Support Config", + "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." + } + } + }, "modules": { "title": "Modules that this provider supports", "type": "object", @@ -38630,6 +38649,25 @@ "type": "string" } }, + "subscribeRequirements": { + "title": "Subscribe Support Config", + "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." + } + } + }, "modules": { "title": "Modules that this provider supports", "type": "object", diff --git a/catalog/catalog.yaml b/catalog/catalog.yaml index ece1571..93912cc 100644 --- a/catalog/catalog.yaml +++ b/catalog/catalog.yaml @@ -582,6 +582,8 @@ components: $ref: '#/components/schemas/Media' labels: $ref: '#/components/schemas/Labels' + subscribeRequirements: + $ref: '#/components/schemas/SubscribeRequirements' modules: $ref: '#/components/schemas/Modules' metadata: @@ -642,6 +644,29 @@ components: passThrough: type: boolean + SubscribeRequirements: + title: Subscribe Support Config + 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. + BatchWriteSupport: required: - delete diff --git a/catalog/generated/catalog.json b/catalog/generated/catalog.json index b6ef2cd..dabdfdb 100644 --- a/catalog/generated/catalog.json +++ b/catalog/generated/catalog.json @@ -2306,6 +2306,25 @@ "type": "string" } }, + "subscribeRequirements": { + "title": "Subscribe Support Config", + "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." + } + } + }, "modules": { "title": "Modules that this provider supports", "type": "object", @@ -3593,6 +3612,25 @@ "type": "string" } }, + "subscribeRequirements": { + "title": "Subscribe Support Config", + "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." + } + } + }, "modules": { "title": "Modules that this provider supports", "type": "object", @@ -4758,6 +4796,25 @@ "type": "string" } }, + "subscribeRequirements": { + "title": "Subscribe Support Config", + "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." + } + } + }, "modules": { "title": "Modules that this provider supports", "type": "object", @@ -5196,6 +5253,25 @@ } } }, + "SubscribeRequirements": { + "title": "Subscribe Support Config", + "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." + } + } + }, "BatchWriteSupport": { "required": [ "delete",