Update connector oneOf descriptions (#20378)

Update descriptions in some specs to render them better in the form
airbytehq · Dec 15, 2022 · b8724c2 · b8724c2
1 parent 8f1f90a
commit b8724c2
Show file tree

Hide file tree

Showing 18 changed files with 89 additions and 100 deletions.
diff --git a/airbyte-config/init/src/main/resources/seed/source_definitions.yaml b/airbyte-config/init/src/main/resources/seed/source_definitions.yaml
@@ -38,7 +38,7 @@
 - name: AlloyDB for PostgreSQL
   sourceDefinitionId: 1fa90628-2b9e-11ed-a261-0242ac120002
   dockerRepository: airbyte/source-alloydb
-  dockerImageTag: 1.0.33
+  dockerImageTag: 1.0.34
   documentationUrl: https://docs.airbyte.com/integrations/sources/alloydb
   icon: alloydb.svg
   sourceType: database
@@ -1006,7 +1006,7 @@
 - name: MySQL
   sourceDefinitionId: 435bb9a5-7887-4809-aa58-28c27df0d7ad
   dockerRepository: airbyte/source-mysql
-  dockerImageTag: 1.0.17
+  dockerImageTag: 1.0.18
   documentationUrl: https://docs.airbyte.com/integrations/sources/mysql
   icon: mysql.svg
   sourceType: database
@@ -1258,7 +1258,7 @@
 - name: Postgres
   sourceDefinitionId: decd338e-5647-4c0b-adf4-da0e75f5a750
   dockerRepository: airbyte/source-postgres
-  dockerImageTag: 1.0.33
+  dockerImageTag: 1.0.34
   documentationUrl: https://docs.airbyte.com/integrations/sources/postgres
   icon: postgresql.svg
   sourceType: database

diff --git a/airbyte-config/init/src/main/resources/seed/source_specs.yaml b/airbyte-config/init/src/main/resources/seed/source_specs.yaml
@@ -299,7 +299,7 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
-- dockerImage: "airbyte/source-alloydb:1.0.33"
+- dockerImage: "airbyte/source-alloydb:1.0.34"
   spec:
     documentationUrl: "https://docs.airbyte.com/integrations/sources/postgres"
     connectionSpecification:
@@ -373,24 +373,15 @@
           order: 7
         ssl_mode:
           title: "SSL Modes"
-          description: "SSL connection modes. \n <ul><li><b>disable</b> - Disables\
-            \ encryption of communication between Airbyte and source database</li>\n\
-            \ <li><b>allow</b> - Enables encryption only when required by the source\
-            \ database</li>\n <li><b>prefer</b> - allows unencrypted connection only\
-            \ if the source database does not support encryption</li>\n <li><b>require</b>\
-            \ - Always require encryption. If the source database server does not\
-            \ support encryption, connection will fail</li>\n  <li><b>verify-ca</b>\
-            \ - Always require encryption and verifies that the source database server\
-            \ has a valid SSL certificate</li>\n  <li><b>verify-full</b> - This is\
-            \ the most secure mode. Always require encryption and verifies the identity\
-            \ of the source database server</li></ul>\n Read more <a href=\"https://jdbc.postgresql.org/documentation/head/ssl-client.html\"\
+          description: "SSL connection modes. \n  Read more <a href=\"https://jdbc.postgresql.org/documentation/head/ssl-client.html\"\
             > in the docs</a>."
           type: "object"
           order: 7
           oneOf:
           - title: "disable"
             additionalProperties: true
-            description: "Disable SSL."
+            description: "Disables encryption of communication between Airbyte and\
+              \ source database."
             required:
             - "mode"
             properties:
@@ -400,7 +391,7 @@
                 order: 0
           - title: "allow"
             additionalProperties: true
-            description: "Allow SSL mode."
+            description: "Enables encryption only when required by the source database."
             required:
             - "mode"
             properties:
@@ -410,7 +401,8 @@
                 order: 0
           - title: "prefer"
             additionalProperties: true
-            description: "Prefer SSL mode."
+            description: "Allows unencrypted connection only if the source database\
+              \ does not support encryption."
             required:
             - "mode"
             properties:
@@ -420,7 +412,8 @@
                 order: 0
           - title: "require"
             additionalProperties: true
-            description: "Require SSL mode."
+            description: "Always require encryption. If the source database server\
+              \ does not support encryption, connection will fail."
             required:
             - "mode"
             properties:
@@ -430,7 +423,8 @@
                 order: 0
           - title: "verify-ca"
             additionalProperties: true
-            description: "Verify-ca SSL mode."
+            description: "Always require encryption and verifies that the source database\
+              \ server has a valid SSL certificate."
             required:
             - "mode"
             - "ca_certificate"
@@ -469,7 +463,8 @@
                 order: 4
           - title: "verify-full"
             additionalProperties: true
-            description: "Verify-full SSL mode."
+            description: "This is the most secure mode. Always require encryption\
+              \ and verifies the identity of the source database server."
             required:
             - "mode"
             - "ca_certificate"
@@ -8792,7 +8787,7 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
-- dockerImage: "airbyte/source-mysql:1.0.17"
+- dockerImage: "airbyte/source-mysql:1.0.18"
   spec:
     documentationUrl: "https://docs.airbyte.com/integrations/sources/mysql"
     connectionSpecification:
@@ -8854,21 +8849,14 @@
           order: 6
         ssl_mode:
           title: "SSL modes"
-          description: "SSL connection modes. <li><b>preferred</b> - Automatically\
-            \ attempt SSL connection. If the MySQL server does not support SSL, continue\
-            \ with a regular connection.</li><li><b>required</b> - Always connect\
-            \ with SSL. If the MySQL server doesn’t support SSL, the connection will\
-            \ not be established. Certificate Authority (CA) and Hostname are not\
-            \ verified.</li><li><b>verify-ca</b> - Always connect with SSL. Verifies\
-            \ CA, but allows connection even if Hostname does not match.</li><li><b>Verify\
-            \ Identity</b> - Always connect with SSL. Verify both CA and Hostname.</li></ul>Read\
-            \ more <a href=\"https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference-using-ssl.html\"\
+          description: "SSL connection modes. Read more <a href=\"https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference-using-ssl.html\"\
             > in the docs</a>."
           type: "object"
           order: 7
           oneOf:
           - title: "preferred"
-            description: "Preferred SSL mode."
+            description: "Automatically attempt SSL connection. If the MySQL server\
+              \ does not support SSL, continue with a regular connection."
             required:
             - "mode"
             properties:
@@ -8877,7 +8865,9 @@
                 const: "preferred"
                 order: 0
           - title: "required"
-            description: "Require SSL mode."
+            description: "Always connect with SSL. If the MySQL server doesn’t support\
+              \ SSL, the connection will not be established. Certificate Authority\
+              \ (CA) and Hostname are not verified."
             required:
             - "mode"
             properties:
@@ -8886,7 +8876,8 @@
                 const: "required"
                 order: 0
           - title: "Verify CA"
-            description: "Verify CA SSL mode."
+            description: "Always connect with SSL. Verifies CA, but allows connection\
+              \ even if Hostname does not match."
             required:
             - "mode"
             - "ca_certificate"
@@ -8928,7 +8919,7 @@
                 airbyte_secret: true
                 order: 4
           - title: "Verify Identity"
-            description: "Verify-full SSL mode."
+            description: "Always connect with SSL. Verify both CA and Hostname."
             required:
             - "mode"
             - "ca_certificate"
@@ -11353,7 +11344,7 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
-- dockerImage: "airbyte/source-postgres:1.0.33"
+- dockerImage: "airbyte/source-postgres:1.0.34"
   spec:
     documentationUrl: "https://docs.airbyte.com/integrations/sources/postgres"
     connectionSpecification:
@@ -11427,24 +11418,15 @@
           order: 7
         ssl_mode:
           title: "SSL Modes"
-          description: "SSL connection modes. \n <ul><li><b>disable</b> - Disables\
-            \ encryption of communication between Airbyte and source database</li>\n\
-            \ <li><b>allow</b> - Enables encryption only when required by the source\
-            \ database</li>\n <li><b>prefer</b> - allows unencrypted connection only\
-            \ if the source database does not support encryption</li>\n <li><b>require</b>\
-            \ - Always require encryption. If the source database server does not\
-            \ support encryption, connection will fail</li>\n  <li><b>verify-ca</b>\
-            \ - Always require encryption and verifies that the source database server\
-            \ has a valid SSL certificate</li>\n  <li><b>verify-full</b> - This is\
-            \ the most secure mode. Always require encryption and verifies the identity\
-            \ of the source database server</li></ul>\n Read more <a href=\"https://jdbc.postgresql.org/documentation/head/ssl-client.html\"\
+          description: "SSL connection modes. \n  Read more <a href=\"https://jdbc.postgresql.org/documentation/head/ssl-client.html\"\
             > in the docs</a>."
           type: "object"
           order: 7
           oneOf:
           - title: "disable"
             additionalProperties: true
-            description: "Disable SSL."
+            description: "Disables encryption of communication between Airbyte and\
+              \ source database."
             required:
             - "mode"
             properties:
@@ -11454,7 +11436,7 @@
                 order: 0
           - title: "allow"
             additionalProperties: true
-            description: "Allow SSL mode."
+            description: "Enables encryption only when required by the source database."
             required:
             - "mode"
             properties:
@@ -11464,7 +11446,8 @@
                 order: 0
           - title: "prefer"
             additionalProperties: true
-            description: "Prefer SSL mode."
+            description: "Allows unencrypted connection only if the source database\
+              \ does not support encryption."
             required:
             - "mode"
             properties:
@@ -11474,7 +11457,8 @@
                 order: 0
           - title: "require"
             additionalProperties: true
-            description: "Require SSL mode."
+            description: "Always require encryption. If the source database server\
+              \ does not support encryption, connection will fail."
             required:
             - "mode"
             properties:
@@ -11484,7 +11468,8 @@
                 order: 0
           - title: "verify-ca"
             additionalProperties: true
-            description: "Verify-ca SSL mode."
+            description: "Always require encryption and verifies that the source database\
+              \ server has a valid SSL certificate."
             required:
             - "mode"
             - "ca_certificate"
@@ -11523,7 +11508,8 @@
                 order: 4
           - title: "verify-full"
             additionalProperties: true
-            description: "Verify-full SSL mode."
+            description: "This is the most secure mode. Always require encryption\
+              \ and verifies the identity of the source database server."
             required:
             - "mode"
             - "ca_certificate"

diff --git a/airbyte-integrations/connectors/source-alloydb-strict-encrypt/Dockerfile b/airbyte-integrations/connectors/source-alloydb-strict-encrypt/Dockerfile
@@ -16,5 +16,5 @@ ENV APPLICATION source-alloydb-strict-encrypt
 
 COPY --from=build /airbyte /airbyte
 
-LABEL io.airbyte.version=1.0.33
+LABEL io.airbyte.version=1.0.34
 LABEL io.airbyte.name=airbyte/source-alloydb-strict-encrypt
diff --git a/airbyte-integrations/connectors/source-alloydb/Dockerfile b/airbyte-integrations/connectors/source-alloydb/Dockerfile
@@ -16,5 +16,5 @@ ENV APPLICATION source-alloydb
 
 COPY --from=build /airbyte /airbyte
 
-LABEL io.airbyte.version=1.0.33
+LABEL io.airbyte.version=1.0.34
 LABEL io.airbyte.name=airbyte/source-alloydb
diff --git a/airbyte-integrations/connectors/source-mysql-strict-encrypt/Dockerfile b/airbyte-integrations/connectors/source-mysql-strict-encrypt/Dockerfile
@@ -16,6 +16,6 @@ ENV APPLICATION source-mysql-strict-encrypt
 
 COPY --from=build /airbyte /airbyte
 
-LABEL io.airbyte.version=1.0.17
+LABEL io.airbyte.version=1.0.18
 
 LABEL io.airbyte.name=airbyte/source-mysql-strict-encrypt
diff --git a/...integrations/connectors/source-mysql-strict-encrypt/src/test/resources/expected_spec.json b/...integrations/connectors/source-mysql-strict-encrypt/src/test/resources/expected_spec.json
@@ -49,13 +49,13 @@
       },
       "ssl_mode": {
         "title": "SSL modes",
-        "description": "SSL connection modes. <li><b>preferred</b> - Automatically attempt SSL connection. If the MySQL server does not support SSL, continue with a regular connection.</li><li><b>required</b> - Always connect with SSL. If the MySQL server doesn’t support SSL, the connection will not be established. Certificate Authority (CA) and Hostname are not verified.</li><li><b>verify-ca</b> - Always connect with SSL. Verifies CA, but allows connection even if Hostname does not match.</li><li><b>Verify Identity</b> - Always connect with SSL. Verify both CA and Hostname.</li></ul>Read more <a href=\"https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference-using-ssl.html\"> in the docs</a>.",
+        "description": "SSL connection modes. Read more <a href=\"https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference-using-ssl.html\"> in the docs</a>.",
         "type": "object",
         "order": 7,
         "oneOf": [
           {
             "title": "preferred",
-            "description": "Preferred SSL mode.",
+            "description": "Automatically attempt SSL connection. If the MySQL server does not support SSL, continue with a regular connection.",
             "required": ["mode"],
             "properties": {
               "mode": {
@@ -67,7 +67,7 @@
           },
           {
             "title": "required",
-            "description": "Require SSL mode.",
+            "description": "Always connect with SSL. If the MySQL server doesn’t support SSL, the connection will not be established. Certificate Authority (CA) and Hostname are not verified.",
             "required": ["mode"],
             "properties": {
               "mode": {
@@ -79,7 +79,7 @@
           },
           {
             "title": "Verify CA",
-            "description": "Verify CA SSL mode.",
+            "description": "Always connect with SSL. Verifies CA, but allows connection even if Hostname does not match.",
             "required": ["mode", "ca_certificate"],
             "properties": {
               "mode": {
@@ -122,7 +122,7 @@
           },
           {
             "title": "Verify Identity",
-            "description": "Verify-full SSL mode.",
+            "description": "Always connect with SSL. Verify both CA and Hostname.",
             "required": ["mode", "ca_certificate"],
             "properties": {
               "mode": {

diff --git a/airbyte-integrations/connectors/source-mysql/Dockerfile b/airbyte-integrations/connectors/source-mysql/Dockerfile
@@ -16,6 +16,6 @@ ENV APPLICATION source-mysql
 
 COPY --from=build /airbyte /airbyte
 
-LABEL io.airbyte.version=1.0.17
+LABEL io.airbyte.version=1.0.18
 
 LABEL io.airbyte.name=airbyte/source-mysql
diff --git a/airbyte-integrations/connectors/source-mysql/src/main/resources/spec.json b/airbyte-integrations/connectors/source-mysql/src/main/resources/spec.json
@@ -56,13 +56,13 @@
       },
       "ssl_mode": {
         "title": "SSL modes",
-        "description": "SSL connection modes. <li><b>preferred</b> - Automatically attempt SSL connection. If the MySQL server does not support SSL, continue with a regular connection.</li><li><b>required</b> - Always connect with SSL. If the MySQL server doesn’t support SSL, the connection will not be established. Certificate Authority (CA) and Hostname are not verified.</li><li><b>verify-ca</b> - Always connect with SSL. Verifies CA, but allows connection even if Hostname does not match.</li><li><b>Verify Identity</b> - Always connect with SSL. Verify both CA and Hostname.</li></ul>Read more <a href=\"https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference-using-ssl.html\"> in the docs</a>.",
+        "description": "SSL connection modes. Read more <a href=\"https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference-using-ssl.html\"> in the docs</a>.",
         "type": "object",
         "order": 7,
         "oneOf": [
           {
             "title": "preferred",
-            "description": "Preferred SSL mode.",
+            "description": "Automatically attempt SSL connection. If the MySQL server does not support SSL, continue with a regular connection.",
             "required": ["mode"],
             "properties": {
               "mode": {
@@ -74,7 +74,7 @@
           },
           {
             "title": "required",
-            "description": "Require SSL mode.",
+            "description": "Always connect with SSL. If the MySQL server doesn’t support SSL, the connection will not be established. Certificate Authority (CA) and Hostname are not verified.",
             "required": ["mode"],
             "properties": {
               "mode": {
@@ -86,7 +86,7 @@
           },
           {
             "title": "Verify CA",
-            "description": "Verify CA SSL mode.",
+            "description": "Always connect with SSL. Verifies CA, but allows connection even if Hostname does not match.",
             "required": ["mode", "ca_certificate"],
             "properties": {
               "mode": {
@@ -129,7 +129,7 @@
           },
           {
             "title": "Verify Identity",
-            "description": "Verify-full SSL mode.",
+            "description": "Always connect with SSL. Verify both CA and Hostname.",
             "required": ["mode", "ca_certificate"],
             "properties": {
               "mode": {