fix(source-zendesk-support): Stream Tags: use cursor based pagination

airbyte-integrations/connectors/source-zendesk-support/metadata.yaml

@@ -11,7 +11,7 @@ data:
   connectorSubtype: api
   connectorType: source
   definitionId: 79c1aa37-dae3-42ae-b333-d1c105477715
-  dockerImageTag: 3.0.0
+  dockerImageTag: 4.0.0
   dockerRepository: airbyte/source-zendesk-support
   documentationUrl: https://docs.airbyte.com/integrations/sources/zendesk-support
   githubIssueLabel: source-zendesk-support
@@ -44,6 +44,13 @@ data:
           - scopeType: stream
             impactedScopes:
               - "ticket_metrics"
+      4.0.0:
+        message: "This version includes breaking changes to the `Tags` stream. The pagination strategy has been changed from `Offset` to `Cursor-Based`. It is necessary to reset the stream. Please see the migration guide for additional details."
+        upgradeDeadline: "2024-09-12"
+        scopedImpact:
+          - scopeType: stream
+            impactedScopes:
+              - "tags"
   suggestedStreams:
     streams:
       - brands

airbyte-integrations/connectors/source-zendesk-support/pyproject.toml

@@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-version = "3.0.0"
+version = "4.0.0"
 name = "source-zendesk-support"
 description = "Source implementation for Zendesk Support."
 authors = [ "Airbyte <[email protected]>",]

airbyte-integrations/connectors/source-zendesk-support/source_zendesk_support/manifest.yaml

@@ -190,6 +190,10 @@ definitions:
 
   tags_stream:
     $ref: "#/definitions/base_stream"
+    retriever:
+      $ref: "#/definitions/retriever"
+      paginator:
+        $ref: "#/definitions/links_next_paginator"
     $parameters:
       name: "tags"
       path: "tags"

docs/integrations/sources/zendesk-support-migrations.md

@@ -1,5 +1,62 @@
 # Zendesk Support Migration Guide
 
+## Upgrading to 4.0.0
+
+The pagination strategy has been changed from `Offset` to `Cursor-Based`. It is necessary to reset the stream.
+
+### For Airbyte Open Source: Update the local connector image
+
+Airbyte Open Source users must manually update the connector image in their local registry before proceeding with the migration. To do so:
+
+1. Select **Settings** in the main navbar.
+    - Select **Sources**.
+2. Find Zendesk Support in the list of connectors.
+
+:::note
+You will see two versions listed, the current in-use version and the latest version available.
+:::
+
+3. Select **Change** to update your OSS version to the latest available version.
+
+### For Airbyte Cloud: Update the connector version
+
+1. Select **Sources** in the main navbar.
+2. Select the instance of the connector you wish to upgrade.
+
+:::note
+Each instance of the connector must be updated separately. If you have created multiple instances of a connector, updating one will not affect the others.
+:::
+
+3. Select **Upgrade**
+    - Follow the prompt to confirm you are ready to upgrade to the new version.
+
+### Refresh affected schemas and data
+
+1. Select **Connections** in the main nav bar.
+    - Select the connection(s) affected by the update.
+2. Select the **Replication** tab.
+    - Select **Refresh source schema**.
+    - Select **OK**.
+
+:::note
+Any detected schema changes will be listed for your review.
+:::
+
+3. Select **Save changes** at the bottom of the page.
+    - Ensure the **Refresh affected streams** option is checked.
+
+:::note
+Depending on destination type you may not be prompted to refresh your data. See below.
+:::
+
+4. Select **Save connection**.
+
+:::note
+This will refresh the data in your destination and initiate a fresh sync.
+:::
+
+For more information on refreshes your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/refreshes).
+
 ## Upgrading to 3.0.0
 
 `cursor_field` for `TicketsMetric` stream is changed to `generated_timestamp`. It is necessary to refresh the data and schema for the affected stream.