Skip to content

Commit 74b8773

Browse files
authored
chore: reorder inject_into in RequestOption and fix title and description in refresh token updater (#635)
1 parent 940e1fc commit 74b8773

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

airbyte_cdk/sources/declarative/declarative_component_schema.yaml

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1339,8 +1339,8 @@ definitions:
13391339
examples:
13401340
- "%Y-%m-%d %H:%M:%S.%f+00:00"
13411341
refresh_token_updater:
1342-
title: Token Updater
1343-
description: When the token updater is defined, new refresh tokens, access tokens and the access token expiry date are written back from the authentication response to the config object. This is important if the refresh token can only used once.
1342+
title: Refresh Token Updater
1343+
description: When the refresh token updater is defined, new refresh tokens, access tokens and the access token expiry date are written back from the authentication response to the config object. This is important if the refresh token can only used once.
13441344
properties:
13451345
refresh_token_name:
13461346
title: Refresh Token Property Name
@@ -3424,6 +3424,19 @@ definitions:
34243424
type:
34253425
type: string
34263426
enum: [RequestOption]
3427+
inject_into:
3428+
title: Inject Into
3429+
description: Configures where the descriptor should be set on the HTTP requests. Note that request parameters that are already encoded in the URL path will not be duplicated.
3430+
enum:
3431+
- request_parameter
3432+
- header
3433+
- body_data
3434+
- body_json
3435+
examples:
3436+
- request_parameter
3437+
- header
3438+
- body_data
3439+
- body_json
34273440
field_name:
34283441
title: Field Name
34293442
description: Configures which key should be used in the location that the descriptor is being injected into. We hope to eventually deprecate this field in favor of `field_path` for all request_options, but must currently maintain it for backwards compatibility in the Builder.
@@ -3444,19 +3457,6 @@ definitions:
34443457
interpolation_context:
34453458
- config
34463459
- parameters
3447-
inject_into:
3448-
title: Inject Into
3449-
description: Configures where the descriptor should be set on the HTTP requests. Note that request parameters that are already encoded in the URL path will not be duplicated.
3450-
enum:
3451-
- request_parameter
3452-
- header
3453-
- body_data
3454-
- body_json
3455-
examples:
3456-
- request_parameter
3457-
- header
3458-
- body_data
3459-
- body_json
34603460
Schemas:
34613461
title: Schemas
34623462
description: The stream schemas representing the shape of the data emitted by the stream.

airbyte_cdk/sources/declarative/models/declarative_component_schema.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -637,8 +637,8 @@ class OAuthAuthenticator(BaseModel):
637637
)
638638
refresh_token_updater: Optional[RefreshTokenUpdater] = Field(
639639
None,
640-
description="When the token updater is defined, new refresh tokens, access tokens and the access token expiry date are written back from the authentication response to the config object. This is important if the refresh token can only used once.",
641-
title="Token Updater",
640+
description="When the refresh token updater is defined, new refresh tokens, access tokens and the access token expiry date are written back from the authentication response to the config object. This is important if the refresh token can only used once.",
641+
title="Refresh Token Updater",
642642
)
643643
profile_assertion: Optional[JwtAuthenticator] = Field(
644644
None,
@@ -1307,6 +1307,12 @@ class InjectInto(Enum):
13071307

13081308
class RequestOption(BaseModel):
13091309
type: Literal["RequestOption"]
1310+
inject_into: InjectInto = Field(
1311+
...,
1312+
description="Configures where the descriptor should be set on the HTTP requests. Note that request parameters that are already encoded in the URL path will not be duplicated.",
1313+
examples=["request_parameter", "header", "body_data", "body_json"],
1314+
title="Inject Into",
1315+
)
13101316
field_name: Optional[str] = Field(
13111317
None,
13121318
description="Configures which key should be used in the location that the descriptor is being injected into. We hope to eventually deprecate this field in favor of `field_path` for all request_options, but must currently maintain it for backwards compatibility in the Builder.",
@@ -1319,12 +1325,6 @@ class RequestOption(BaseModel):
13191325
examples=[["data", "viewer", "id"]],
13201326
title="Field Path",
13211327
)
1322-
inject_into: InjectInto = Field(
1323-
...,
1324-
description="Configures where the descriptor should be set on the HTTP requests. Note that request parameters that are already encoded in the URL path will not be duplicated.",
1325-
examples=["request_parameter", "header", "body_data", "body_json"],
1326-
title="Inject Into",
1327-
)
13281328

13291329

13301330
class Schemas(BaseModel):

0 commit comments

Comments
 (0)