add access_token_params to OAuth Spec

airbytehq · Nov 27, 2024 · 8732f9a · 8732f9a
1 parent 3c96f16
commit 8732f9a
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 4 deletions.
diff --git a/protocol-models/src/main/resources/airbyte_protocol/airbyte_protocol.yaml b/protocol-models/src/main/resources/airbyte_protocol/airbyte_protocol.yaml
@@ -659,10 +659,9 @@ definitions:
         description: |-
           OAuth specific blob. Pertains to the fields defined by the connector relating to the OAuth flow.
         type: object
-        additionalProperties: false
+        additionalProperties: true
         required: 
           - consent_url
-          - scope
           - access_token_url
           - extract_output
         properties:
@@ -710,6 +709,20 @@ definitions:
                       "Authorization": "Basic {base64Encoder:{client_id}:{client_secret}}"
                   }
                 }
+          access_token_params:
+            type: object
+            additionalProperties: true
+            description: |-
+              The OAuth Specific optional query parameters to inject while exchanging the `auth_code` to `access_token` during `completeOAuthFlow` step.
+              When this property is provided, the query params are encoded as `Json string` and passed to the outgoing API request.
+
+              Examples:
+                {
+                  "access_token_params": {
+                      "my_query_param": "param_value",
+                      "{client_id_key}": {{client_id_key}}
+                  }
+                }
           extract_output:
             type: array
             items:

diff --git a/protocol-models/src/main/resources/airbyte_protocol/v0/airbyte_protocol.yaml b/protocol-models/src/main/resources/airbyte_protocol/v0/airbyte_protocol.yaml
@@ -714,10 +714,9 @@ definitions:
         description: |-
           OAuth specific blob. Pertains to the fields defined by the connector relating to the OAuth flow.
         type: object
-        additionalProperties: false
+        additionalProperties: true
         required: 
           - consent_url
-          - scope
           - access_token_url
           - extract_output
         properties:
@@ -765,6 +764,20 @@ definitions:
                       "Authorization": "Basic {base64Encoder:{client_id}:{client_secret}}"
                   }
                 }
+          access_token_params:
+            type: object
+            additionalProperties: true
+            description: |-
+              The OAuth Specific optional query parameters to inject while exchanging the `auth_code` to `access_token` during `completeOAuthFlow` step.
+              When this property is provided, the query params are encoded as `Json string` and passed to the outgoing API request.
+
+              Examples:
+                {
+                  "access_token_params": {
+                      "my_query_param": "param_value",
+                      "{client_id_key}": {{client_id_key}}
+                  }
+                }
           extract_output:
             type: array
             items: