From 58c9bc8cbb7c5c4c417bfe5b345b2336c96f2176 Mon Sep 17 00:00:00 2001 From: Jaehyun Lim Date: Mon, 20 Apr 2026 18:09:53 -0700 Subject: [PATCH 1/3] add support config --- api/generated/api.json | 30 +++++++++++++++++ catalog/catalog.yaml | 13 ++++++++ catalog/generated/catalog.json | 60 ++++++++++++++++++++++++++++++++++ 3 files changed, 103 insertions(+) diff --git a/api/generated/api.json b/api/generated/api.json index c6f2119..87fd67e 100644 --- a/api/generated/api.json +++ b/api/generated/api.json @@ -37249,6 +37249,21 @@ "type": "string" } }, + "subscribeSupportConfig": { + "title": "Subscribe Support Config", + "type": "object", + "properties": { + "registration": { + "type": "boolean" + }, + "maintenance": { + "type": "boolean" + }, + "postProcess": { + "type": "boolean" + } + } + }, "modules": { "title": "Modules that this provider supports", "type": "object", @@ -38630,6 +38645,21 @@ "type": "string" } }, + "subscribeSupportConfig": { + "title": "Subscribe Support Config", + "type": "object", + "properties": { + "registration": { + "type": "boolean" + }, + "maintenance": { + "type": "boolean" + }, + "postProcess": { + "type": "boolean" + } + } + }, "modules": { "title": "Modules that this provider supports", "type": "object", diff --git a/catalog/catalog.yaml b/catalog/catalog.yaml index ece1571..057af88 100644 --- a/catalog/catalog.yaml +++ b/catalog/catalog.yaml @@ -582,6 +582,8 @@ components: $ref: '#/components/schemas/Media' labels: $ref: '#/components/schemas/Labels' + subscribeSupportConfig: + $ref: '#/components/schemas/SubscribeSupportConfig' modules: $ref: '#/components/schemas/Modules' metadata: @@ -642,6 +644,17 @@ components: passThrough: type: boolean + SubscribeSupportConfig: + title: Subscribe Support Config + type: object + properties: + registration: + type: boolean + maintenance: + type: boolean + postProcess: + type: boolean + BatchWriteSupport: required: - delete diff --git a/catalog/generated/catalog.json b/catalog/generated/catalog.json index b6ef2cd..7f5e40f 100644 --- a/catalog/generated/catalog.json +++ b/catalog/generated/catalog.json @@ -2306,6 +2306,21 @@ "type": "string" } }, + "subscribeSupportConfig": { + "title": "Subscribe Support Config", + "type": "object", + "properties": { + "registration": { + "type": "boolean" + }, + "maintenance": { + "type": "boolean" + }, + "postProcess": { + "type": "boolean" + } + } + }, "modules": { "title": "Modules that this provider supports", "type": "object", @@ -3593,6 +3608,21 @@ "type": "string" } }, + "subscribeSupportConfig": { + "title": "Subscribe Support Config", + "type": "object", + "properties": { + "registration": { + "type": "boolean" + }, + "maintenance": { + "type": "boolean" + }, + "postProcess": { + "type": "boolean" + } + } + }, "modules": { "title": "Modules that this provider supports", "type": "object", @@ -4758,6 +4788,21 @@ "type": "string" } }, + "subscribeSupportConfig": { + "title": "Subscribe Support Config", + "type": "object", + "properties": { + "registration": { + "type": "boolean" + }, + "maintenance": { + "type": "boolean" + }, + "postProcess": { + "type": "boolean" + } + } + }, "modules": { "title": "Modules that this provider supports", "type": "object", @@ -5196,6 +5241,21 @@ } } }, + "SubscribeSupportConfig": { + "title": "Subscribe Support Config", + "type": "object", + "properties": { + "registration": { + "type": "boolean" + }, + "maintenance": { + "type": "boolean" + }, + "postProcess": { + "type": "boolean" + } + } + }, "BatchWriteSupport": { "required": [ "delete", From b03e301bfd9a2e9c4544b90a91664451d57880ba Mon Sep 17 00:00:00 2001 From: Jaehyun Lim Date: Mon, 20 Apr 2026 19:48:26 -0700 Subject: [PATCH 2/3] add better description --- api/generated/api.json | 20 ++++++++++++----- catalog/catalog.yaml | 12 ++++++++++ catalog/generated/catalog.json | 40 ++++++++++++++++++++++++---------- 3 files changed, 54 insertions(+), 18 deletions(-) diff --git a/api/generated/api.json b/api/generated/api.json index 87fd67e..cf685aa 100644 --- a/api/generated/api.json +++ b/api/generated/api.json @@ -37252,15 +37252,19 @@ "subscribeSupportConfig": { "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" + "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" + "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" + "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." } } }, @@ -38648,15 +38652,19 @@ "subscribeSupportConfig": { "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" + "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" + "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" + "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." } } }, diff --git a/catalog/catalog.yaml b/catalog/catalog.yaml index 057af88..a7a9a48 100644 --- a/catalog/catalog.yaml +++ b/catalog/catalog.yaml @@ -647,13 +647,25 @@ components: SubscribeSupportConfig: 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: diff --git a/catalog/generated/catalog.json b/catalog/generated/catalog.json index 7f5e40f..8290ab7 100644 --- a/catalog/generated/catalog.json +++ b/catalog/generated/catalog.json @@ -2309,15 +2309,19 @@ "subscribeSupportConfig": { "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" + "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" + "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" + "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." } } }, @@ -3611,15 +3615,19 @@ "subscribeSupportConfig": { "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" + "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" + "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" + "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." } } }, @@ -4791,15 +4799,19 @@ "subscribeSupportConfig": { "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" + "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" + "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" + "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." } } }, @@ -5244,15 +5256,19 @@ "SubscribeSupportConfig": { "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" + "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" + "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" + "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." } } }, From 664a48e86035551cb0e7be58825585ef120eff5a Mon Sep 17 00:00:00 2001 From: Jaehyun Lim Date: Thu, 23 Apr 2026 17:08:50 -0700 Subject: [PATCH 3/3] change to subscribe requirements --- api/generated/api.json | 4 ++-- catalog/catalog.yaml | 6 +++--- catalog/generated/catalog.json | 8 ++++---- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/api/generated/api.json b/api/generated/api.json index cf685aa..3513993 100644 --- a/api/generated/api.json +++ b/api/generated/api.json @@ -37249,7 +37249,7 @@ "type": "string" } }, - "subscribeSupportConfig": { + "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.", @@ -38649,7 +38649,7 @@ "type": "string" } }, - "subscribeSupportConfig": { + "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.", diff --git a/catalog/catalog.yaml b/catalog/catalog.yaml index a7a9a48..93912cc 100644 --- a/catalog/catalog.yaml +++ b/catalog/catalog.yaml @@ -582,8 +582,8 @@ components: $ref: '#/components/schemas/Media' labels: $ref: '#/components/schemas/Labels' - subscribeSupportConfig: - $ref: '#/components/schemas/SubscribeSupportConfig' + subscribeRequirements: + $ref: '#/components/schemas/SubscribeRequirements' modules: $ref: '#/components/schemas/Modules' metadata: @@ -644,7 +644,7 @@ components: passThrough: type: boolean - SubscribeSupportConfig: + 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. diff --git a/catalog/generated/catalog.json b/catalog/generated/catalog.json index 8290ab7..dabdfdb 100644 --- a/catalog/generated/catalog.json +++ b/catalog/generated/catalog.json @@ -2306,7 +2306,7 @@ "type": "string" } }, - "subscribeSupportConfig": { + "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.", @@ -3612,7 +3612,7 @@ "type": "string" } }, - "subscribeSupportConfig": { + "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.", @@ -4796,7 +4796,7 @@ "type": "string" } }, - "subscribeSupportConfig": { + "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.", @@ -5253,7 +5253,7 @@ } } }, - "SubscribeSupportConfig": { + "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.",