Skip to content

Commit f0a8f30

Browse files
authored
docs: adjust descriptions of page token option (#701)
1 parent e1664ec commit f0a8f30

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

airbyte_cdk/sources/declarative/declarative_component_schema.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1838,6 +1838,7 @@ definitions:
18381838
"$ref": "#/definitions/RequestOption"
18391839
page_token_option:
18401840
title: Inject Page Token Into Outgoing HTTP Request
1841+
description: Inject the page token into the outgoing HTTP requests by inserting it into either the request URL path or a field on the request.
18411842
anyOf:
18421843
- "$ref": "#/definitions/RequestOption"
18431844
- "$ref": "#/definitions/RequestPath"
@@ -3486,7 +3487,7 @@ definitions:
34863487
- [["content", "html"], ["content", "plain_text"]]
34873488
RequestPath:
34883489
title: Request Path
3489-
description: Specifies where in the request path a component's value should be inserted.
3490+
description: The URL path to be used for the HTTP request.
34903491
type: object
34913492
required:
34923493
- type

airbyte_cdk/sources/declarative/models/declarative_component_schema.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2002,7 +2002,9 @@ class DefaultPaginator(BaseModel):
20022002
None, title="Inject Page Size Into Outgoing HTTP Request"
20032003
)
20042004
page_token_option: Optional[Union[RequestOption, RequestPath]] = Field(
2005-
None, title="Inject Page Token Into Outgoing HTTP Request"
2005+
None,
2006+
description="Inject the page token into the outgoing HTTP requests by inserting it into either the request URL path or a field on the request.",
2007+
title="Inject Page Token Into Outgoing HTTP Request",
20062008
)
20072009
parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
20082010

0 commit comments

Comments
 (0)