Skip to content

[ENG-3857] Refactor: Providerinfo subscribe support config #352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jlimatampersand merged 3 commits into from
Apr 24, 2026
Merged

[ENG-3857] Refactor: Providerinfo subscribe support config #352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
58c9bc8
add support config
jlimatampersand Apr 21, 2026
b03e301
add better description
jlimatampersand Apr 21, 2026
664a48e
change to subscribe requirements
jlimatampersand Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions api/generated/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
25 changes: 25 additions & 0 deletions catalog/catalog.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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.
Comment on lines +647 to +668
Copy link
Copy Markdown

@graphite-app graphite-app Bot Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Schema name mismatch: The schema is defined as SubscribeRequirements but line 586 references SubscribeSupportConfig. This will cause schema resolution to fail.

# Change from:
SubscribeRequirements:
  title: Subscribe Action Requirements
  
# To:
SubscribeSupportConfig:
  title: Subscribe Support Config

The schema name must match the $ref target at line 586, or the reference must be updated to point to SubscribeRequirements. Based on the generated JSON files using SubscribeSupportConfig, the schema should be renamed to SubscribeSupportConfig.

Suggested change
SubscribeRequirements:
title: Subscribe Action 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.
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.

Spotted by Graphite

Fix in Graphite

Is this helpful? React 👍 or 👎 to let us know.


BatchWriteSupport:
required:
- delete
Expand Down
76 changes: 76 additions & 0 deletions catalog/generated/catalog.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
Loading