Skip to content

Commit 9bc1b5a

Browse files
committed
fix more fields in declarative_component_schema
1 parent ce2a7bb commit 9bc1b5a

File tree

1 file changed

+53
-9
lines changed

1 file changed

+53
-9
lines changed

airbyte_cdk/sources/declarative/declarative_component_schema.yaml

Lines changed: 53 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1937,8 +1937,8 @@ definitions:
19371937
- "https://connect.squareup.com/v2/quotes/{{ stream_partition['id'] }}/quote_line_groups"
19381938
- "https://example.com/api/v1/resource/{{ next_page_token['id'] }}"
19391939
url:
1940-
title: The URL of an API endpoint
1941-
description: The URL of the API source. Do not put sensitive information (e.g. API tokens) into this field - Use the Authentication component for this.
1940+
title: API Endpoint URL
1941+
description: The URL of the source API endpoint. Do not put sensitive information (e.g. API tokens) into this field - Use the Authentication component for this.
19421942
type: string
19431943
interpolation_context:
19441944
- config
@@ -2003,6 +2003,46 @@ definitions:
20032003
title: Fetch Properties from Endpoint
20042004
description: Allows for retrieving a dynamic set of properties from an API endpoint which can be injected into outbound request using the stream_partition.extra_fields.
20052005
"$ref": "#/definitions/PropertiesFromEndpoint"
2006+
request_parameters:
2007+
title: Query Parameters
2008+
description: Specifies the query parameters that should be set on an outgoing HTTP request given the inputs.
2009+
anyOf:
2010+
- type: object
2011+
title: Key/Value Pairs
2012+
additionalProperties:
2013+
anyOf:
2014+
- type: string
2015+
- $ref: "#/definitions/QueryProperties"
2016+
- type: string
2017+
title: Interpolated Value
2018+
interpolation_context:
2019+
- next_page_token
2020+
- stream_interval
2021+
- stream_partition
2022+
- stream_slice
2023+
examples:
2024+
- unit: "day"
2025+
- query: 'last_event_time BETWEEN TIMESTAMP "{{ stream_interval.start_time }}" AND TIMESTAMP "{{ stream_interval.end_time }}"'
2026+
- searchIn: "{{ ','.join(config.get('search_in', [])) }}"
2027+
- sort_by[asc]: updated_at
2028+
request_headers:
2029+
title: Request Headers
2030+
description: Return any non-auth headers. Authentication headers will overwrite any overlapping headers returned from this method.
2031+
anyOf:
2032+
- type: object
2033+
title: Key/Value Pairs
2034+
additionalProperties:
2035+
type: string
2036+
- type: string
2037+
title: Interpolated Value
2038+
interpolation_context:
2039+
- next_page_token
2040+
- stream_interval
2041+
- stream_partition
2042+
- stream_slice
2043+
examples:
2044+
- Output-Format: JSON
2045+
- Version: "{{ config['version'] }}"
20062046
request_body_data:
20072047
deprecated: true
20082048
deprecation_message: "Use `request_body` field instead."
@@ -2045,7 +2085,7 @@ definitions:
20452085
field: "updated_at"
20462086
order: "ascending"
20472087
request_body:
2048-
title: Request Body Payload to be send as a part of the API request.
2088+
title: Request Body
20492089
description: Specifies how to populate the body of the request with a payload. Can contain nested objects.
20502090
anyOf:
20512091
- "$ref": "#/definitions/RequestBodyPlainText"
@@ -2076,6 +2116,7 @@ definitions:
20762116
value:
20772117
param1: "value1"
20782118
param2: "{{ config['param2_value'] }}"
2119+
<<<<<<< Updated upstream
20792120
- type: RequestBodyGraphQL
20802121
value:
20812122
query:
@@ -2121,6 +2162,8 @@ definitions:
21212162
- query: 'last_event_time BETWEEN TIMESTAMP "{{ stream_interval.start_time }}" AND TIMESTAMP "{{ stream_interval.end_time }}"'
21222163
- searchIn: "{{ ','.join(config.get('search_in', [])) }}"
21232164
- sort_by[asc]: updated_at
2165+
=======
2166+
>>>>>>> Stashed changes
21242167
error_handler:
21252168
title: Error Handler
21262169
description: Error handler component that defines how to handle errors.
@@ -3100,7 +3143,7 @@ definitions:
31003143
type: array
31013144
default: []
31023145
items:
3103-
- type: string
3146+
type: string
31043147
interpolation_context:
31053148
- config
31063149
parent_key:
@@ -3194,8 +3237,8 @@ definitions:
31943237
retriever:
31953238
description: Requester component that describes how to fetch the properties to query from a remote API endpoint.
31963239
anyOf:
3197-
- "$ref": "#/definitions/CustomRetriever"
31983240
- "$ref": "#/definitions/SimpleRetriever"
3241+
- "$ref": "#/definitions/CustomRetriever"
31993242
$parameters:
32003243
type: object
32013244
additionalProperties: true
@@ -3426,6 +3469,7 @@ definitions:
34263469
additionalProperties: true
34273470
LegacySessionTokenAuthenticator:
34283471
title: Session Token Authenticator
3472+
deprecated: true
34293473
description: Deprecated - use SessionTokenAuthenticator instead. Authenticator for requests authenticated using session tokens. A session token is a random value generated by a server to identify a specific user for the duration of one interaction session.
34303474
type: object
34313475
required:
@@ -3534,15 +3578,15 @@ definitions:
35343578
- "$ref": "#/definitions/HttpRequester"
35353579
- "$ref": "#/definitions/CustomRequester"
35363580
decoder:
3537-
title: Decoder
3581+
title: HTTP Response Format
35383582
description: Component decoding the response so records can be extracted.
35393583
anyOf:
3540-
- "$ref": "#/definitions/CsvDecoder"
3541-
- "$ref": "#/definitions/GzipDecoder"
35423584
- "$ref": "#/definitions/JsonDecoder"
3585+
- "$ref": "#/definitions/XmlDecoder"
3586+
- "$ref": "#/definitions/CsvDecoder"
35433587
- "$ref": "#/definitions/JsonlDecoder"
3588+
- "$ref": "#/definitions/GzipDecoder"
35443589
- "$ref": "#/definitions/IterableDecoder"
3545-
- "$ref": "#/definitions/XmlDecoder"
35463590
- "$ref": "#/definitions/ZipfileDecoder"
35473591
- "$ref": "#/definitions/CustomDecoder"
35483592
record_selector:

0 commit comments

Comments
 (0)