Update fields in source-connectors specifications: retently (#9045)

* Files title/description update for issue # 8914 * Version update for issue # 8914 * Update airbyte-integrations/connectors/source-retently/source_retently/spec.json Update description Co-authored-by: Anna Lvova <[email protected]> * Update airbyte-integrations/connectors/source-retently/source_retently/spec.json Update Description Co-authored-by: Anna Lvova <[email protected]> * add doc * add doc * bump version Co-authored-by: Anna Lvova <[email protected]> Co-authored-by: alvova <[email protected]>
airbytehq · Dec 28, 2021 · 1e4eea2 · 1e4eea2
1 parent 0e1073d
commit 1e4eea2
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 17 deletions.
diff --git a/...ain/resources/config/STANDARD_SOURCE_DEFINITION/db04ecd1-42e7-4115-9cec-95812905c626.json b/...ain/resources/config/STANDARD_SOURCE_DEFINITION/db04ecd1-42e7-4115-9cec-95812905c626.json
@@ -2,7 +2,7 @@
   "sourceDefinitionId": "db04ecd1-42e7-4115-9cec-95812905c626",
   "name": "Retently",
   "dockerRepository": "airbyte/source-retently",
-  "dockerImageTag": "0.1.1",
+  "dockerImageTag": "0.1.2",
   "documentationUrl": "https://docs.airbyte.io/integrations/sources/retently",
   "icon": "retently.svg"
 }
diff --git a/airbyte-config/init/src/main/resources/seed/source_definitions.yaml b/airbyte-config/init/src/main/resources/seed/source_definitions.yaml
@@ -586,7 +586,7 @@
 - name: Retently
   sourceDefinitionId: db04ecd1-42e7-4115-9cec-95812905c626
   dockerRepository: airbyte/source-retently
-  dockerImageTag: 0.1.1
+  dockerImageTag: 0.1.2
   documentationUrl: https://docs.airbyte.io/integrations/sources/retently
   icon: retently.svg
   sourceType: api

diff --git a/airbyte-config/init/src/main/resources/seed/source_specs.yaml b/airbyte-config/init/src/main/resources/seed/source_specs.yaml
@@ -5920,7 +5920,7 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
-- dockerImage: "airbyte/source-retently:0.1.1"
+- dockerImage: "airbyte/source-retently:0.1.2"
   spec:
     documentationUrl: "https://docsurl.com"
     connectionSpecification:
@@ -5930,12 +5930,12 @@
       additionalProperties: true
       properties:
         credentials:
-          title: "Authentication mechanism"
+          title: "Authentication Mechanism"
           description: "Choose how to authenticate to Retently"
           type: "object"
           oneOf:
           - type: "object"
-            title: "Authenticate via Retently (Oauth)"
+            title: "Authenticate via Retently (OAuth)"
             required:
             - "client_id"
             - "client_secret"
@@ -5952,17 +5952,17 @@
               client_id:
                 title: "Client ID"
                 type: "string"
-                description: "The Client ID of your application"
+                description: "The Client ID of your Retently developer application."
               client_secret:
                 title: "Client Secret"
                 type: "string"
-                description: "The client secret of your application"
+                description: "The Client Secret of your Retently developer application."
                 airbyte_secret: true
               refresh_token:
                 title: "Refresh Token"
                 type: "string"
-                description: "A refresh token generated using the above client ID\
-                  \ and secret"
+                description: "Retently Refresh Token which can be used to fetch new\
+                  \ Bearer Tokens when the current one expires."
                 airbyte_secret: true
           - type: "object"
             title: "Authenticate with API Token"
@@ -5979,7 +5979,8 @@
                 order: 0
               api_key:
                 title: "API Token"
-                description: "API token from https://app.retently.com/settings/api/tokens"
+                description: "Retently API Token. See the <a href=\"https://app.retently.com/settings/api/tokens\"\
+                  >docs</a> for more information on how to obtain this key."
                 type: "string"
                 airbyte_secret: true
     supportsNormalization: false

diff --git a/airbyte-integrations/connectors/source-retently/Dockerfile b/airbyte-integrations/connectors/source-retently/Dockerfile
@@ -34,5 +34,5 @@ COPY source_retently ./source_retently
 ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
 ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
 
-LABEL io.airbyte.version=0.1.1
+LABEL io.airbyte.version=0.1.2
 LABEL io.airbyte.name=airbyte/source-retently
diff --git a/airbyte-integrations/connectors/source-retently/source_retently/spec.json b/airbyte-integrations/connectors/source-retently/source_retently/spec.json
@@ -7,13 +7,13 @@
     "additionalProperties": true,
     "properties": {
       "credentials": {
-        "title": "Authentication mechanism",
+        "title": "Authentication Mechanism",
         "description": "Choose how to authenticate to Retently",
         "type": "object",
         "oneOf": [
           {
             "type": "object",
-            "title": "Authenticate via Retently (Oauth)",
+            "title": "Authenticate via Retently (OAuth)",
             "required": ["client_id", "client_secret", "refresh_token"],
             "additionalProperties": false,
             "properties": {
@@ -27,18 +27,18 @@
               "client_id": {
                 "title": "Client ID",
                 "type": "string",
-                "description": "The Client ID of your application"
+                "description": "The Client ID of your Retently developer application."
               },
               "client_secret": {
                 "title": "Client Secret",
                 "type": "string",
-                "description": "The client secret of your application",
+                "description": "The Client Secret of your Retently developer application.",
                 "airbyte_secret": true
               },
               "refresh_token": {
                 "title": "Refresh Token",
                 "type": "string",
-                "description": "A refresh token generated using the above client ID and secret",
+                "description": "Retently Refresh Token which can be used to fetch new Bearer Tokens when the current one expires.",
                 "airbyte_secret": true
               }
             }
@@ -58,7 +58,7 @@
               },
               "api_key": {
                 "title": "API Token",
-                "description": "API token from https://app.retently.com/settings/api/tokens",
+                "description": "Retently API Token. See the <a href=\"https://app.retently.com/settings/api/tokens\">docs</a> for more information on how to obtain this key.",
                 "type": "string",
                 "airbyte_secret": true
               }

diff --git a/docs/integrations/sources/retently.md b/docs/integrations/sources/retently.md
@@ -0,0 +1,46 @@
+# Retently
+
+## Overview
+
+The Retently source supports full refresh sync.
+
+### Output schema
+
+Several output streams are available from this source:
+
+* [Customers](https://www.retently.com/api/#api-get-customers-get)
+* [Companies](https://www.retently.com/api/#api-get-companies-get)
+* [Reports](https://www.retently.com/api/#api-get-reports-get)
+
+If there are more endpoints you'd like Airbyte to support, please [create an issue](https://github.com/airbytehq/airbyte/issues/new/choose).
+
+### Features
+
+| Feature | Supported? |
+| :--- | :--- |
+| Full Refresh Sync | Yes |
+| Incremental Sync | No |
+| SSL connection | No |
+| Namespaces | No |
+
+## Getting started
+
+### Requirements
+
+* Retently Account
+* Retently API Token
+
+### Setup guide
+
+Retently supports two types of authentication: by API Token or using Retently oAuth application.
+
+You can get the API Token for Retently [here](https://app.retently.com/settings/api/tokens).
+OAuth application is [here](https://app.retently.com/settings/oauth).
+
+## Changelog
+
+| Version | Date | Pull Request | Subject |
+| :--- | :--- | :--- | :--- |
+| 0.1.2 | 2021-12-28 | [9045](https://github.com/airbytehq/airbyte/pull/9045) | Update titles and descriptions |
+| 0.1.1 | 2021-12-06 | [8043](https://github.com/airbytehq/airbyte/pull/8043) | 🎉 Source Retently: add OAuth 2.0 |
+| 0.1.0 | 2021-11-02 | [6966](https://github.com/airbytehq/airbyte/pull/6966) | 🎉 New Source: Retently |