Skip to content

Commit

Permalink
fix(cli): Support default query parameters. (#5445)
Browse files Browse the repository at this point in the history 
* Support default query parameters.

* Update Snapshots
  • Loading branch information
@eyw520
eyw520 authored Dec 19, 2024
1 parent e7e5d4a commit 7770eed
Show file tree
Hide file tree
Showing 35 changed files with 765 additions and 1 deletion.
22 changes: 22 additions & 0 deletions ...ers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/apiture.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13538,6 +13538,7 @@ The response may be incomplete. Given a `Retry-After` response header, the clien
"type": "optional<root.AccountAllowsFilter>",
},
"limit": {
"default": 100,
"docs": "The maximum number of items to return in this paged response.",
"type": "optional<integer>",
"validation": {
Expand All @@ -13558,6 +13559,7 @@ The response may be incomplete. Given a `Retry-After` response header, the clien
"type": "optional<root.ProductType>",
},
"start": {
"default": "",
"docs": "The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`.",
"type": "optional<string>",
"validation": {
Expand Down Expand Up @@ -13605,6 +13607,7 @@ Optionally, an agent can access a business customer's ACH accounts when acting o
"type": "optional<root.ResourceId>",
},
"limit": {
"default": 100,
"docs": "The maximum number of items to return in this paged response.",
"type": "optional<integer>",
"validation": {
Expand All @@ -13620,6 +13623,7 @@ Optionally, an agent can access a business customer's ACH accounts when acting o
"type": "root.AchSecCode",
},
"start": {
"default": "",
"docs": "The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`.",
"type": "optional<string>",
"validation": {
Expand Down Expand Up @@ -13708,6 +13712,7 @@ service:
`account.allows.view` are all `true` for the caller.
start:
type: optional<string>
default: ''
docs: >-
The location of the next item in the collection. This is an opaque
cursor supplied by the API service. Omit this to start at the
Expand All @@ -13718,6 +13723,7 @@ service:
maxLength: 256
limit:
type: optional<integer>
default: 100
docs: The maximum number of items to return in this paged response.
validation:
min: 0
Expand Down Expand Up @@ -13940,6 +13946,7 @@ service:
authenticated caller's customer ID (not their access ID).
start:
type: optional<string>
default: ''
docs: >-
The location of the next item in the collection. This is an opaque
cursor supplied by the API service. Omit this to start at the
Expand All @@ -13950,6 +13957,7 @@ service:
maxLength: 256
limit:
type: optional<integer>
default: 100
docs: The maximum number of items to return in this paged response.
validation:
min: 0
Expand Down Expand Up @@ -14309,6 +14317,7 @@ This information provides hints to clients, allowing bank customers to select tr
"name": "InstitutionsListTransferScheduleRequest",
"query-parameters": {
"count": {
"default": 6,
"docs": "The maximum amount of dates to calculate and include in the response. If an end date is provided, the total count may be lower than the requested count.",
"type": "optional<integer>",
"validation": {
Expand Down Expand Up @@ -14593,6 +14602,7 @@ service:
`credit`, dates are adjusted to the previous business day.
count:
type: optional<integer>
default: 6
docs: >-
The maximum amount of dates to calculate and include in the
response. If an end date is provided, the total count may be lower
Expand Down Expand Up @@ -15117,6 +15127,7 @@ To obtain available balances for these accounts, use [`listAccountBalances`](#op
"name": "OverdraftProtectionListEligibleOverdraftAccountsRequest",
"query-parameters": {
"limit": {
"default": 100,
"docs": "The maximum number of items to return in this paged response.",
"type": "optional<integer>",
"validation": {
Expand All @@ -15128,6 +15139,7 @@ To obtain available balances for these accounts, use [`listAccountBalances`](#op
},
},
"start": {
"default": "",
"docs": "The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`.",
"type": "optional<string>",
"validation": {
Expand Down Expand Up @@ -15251,6 +15263,7 @@ service:
query-parameters:
start:
type: optional<string>
default: ''
docs: >-
The location of the next item in the collection. This is an opaque
cursor supplied by the API service. Omit this to start at the
Expand All @@ -15261,6 +15274,7 @@ service:
maxLength: 256
limit:
type: optional<integer>
default: 100
docs: The maximum number of items to return in this paged response.
validation:
min: 0
Expand Down Expand Up @@ -15644,6 +15658,7 @@ The default response lists only recent transactions. Normally, this is transacti
"type": "optional<root.DateRange>",
},
"limit": {
"default": 100,
"docs": "The maximum number of items to return in this paged response.",
"type": "optional<integer>",
"validation": {
Expand Down Expand Up @@ -15685,6 +15700,7 @@ The default response lists only recent transactions. Normally, this is transacti
},
},
"start": {
"default": "",
"docs": "The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`.",
"type": "optional<string>",
"validation": {
Expand Down Expand Up @@ -15761,6 +15777,7 @@ service:
query-parameters:
start:
type: optional<string>
default: ''
docs: >-
The location of the next item in the collection. This is an opaque
cursor supplied by the API service. Omit this to start at the
Expand All @@ -15771,6 +15788,7 @@ service:
maxLength: 256
limit:
type: optional<integer>
default: 100
docs: The maximum number of items to return in this paged response.
validation:
min: 0
Expand Down Expand Up @@ -16278,6 +16296,7 @@ Note: This operation requires an identity challenge if the financial institution
"type": "optional<boolean>",
},
"limit": {
"default": 100,
"docs": "The maximum number of items to return in this paged response.",
"type": "optional<integer>",
"validation": {
Expand All @@ -16293,6 +16312,7 @@ Note: This operation requires an identity challenge if the financial institution
"type": "optional<root.DateRange>",
},
"start": {
"default": "",
"docs": "The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`.",
"type": "optional<string>",
"validation": {
Expand Down Expand Up @@ -16487,6 +16507,7 @@ service:
finished processing. If omitted, list all transfers.
start:
type: optional<string>
default: ''
docs: >-
The location of the next item in the collection. This is an opaque
cursor supplied by the API service. Omit this to start at the
Expand All @@ -16497,6 +16518,7 @@ service:
maxLength: 256
limit:
type: optional<integer>
default: 100
docs: The maximum number of items to return in this paged response.
validation:
min: 0
Expand Down
6 changes: 6 additions & 0 deletions ...rters/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/aries.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22340,6 +22340,7 @@ docs: Interaction with ledger
},
},
"role": {
"default": "server",
"docs": "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent",
"type": "optional<GetKeylistsRequestRole>",
},
Expand Down Expand Up @@ -22661,10 +22662,12 @@ docs: Interaction with ledger
"path-parameters": undefined,
"query-parameters": {
"paginate_limit": {
"default": -1,
"docs": "limit number of results",
"type": "optional<integer>",
},
"paginate_offset": {
"default": 0,
"docs": "offset to use in pagination",
"type": "optional<integer>",
},
Expand Down Expand Up @@ -22986,6 +22989,7 @@ service:
format: uuid
role:
type: optional<GetKeylistsRequestRole>
default: server
docs: >-
Filer on role, 'client' for keys mediated by other agents,
'server' for keys mediated by this agent
Expand Down Expand Up @@ -23028,9 +23032,11 @@ service:
query-parameters:
paginate_limit:
type: optional<integer>
default: -1
docs: limit number of results
paginate_offset:
type: optional<integer>
default: 0
docs: offset to use in pagination
body:
properties:
Expand Down
2 changes: 2 additions & 0 deletions ...rs/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/assembly.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6575,6 +6575,7 @@ docs: Real-time transcription
},
},
"limit": {
"default": 10,
"docs": "Maximum amount of transcripts to retrieve",
"type": "optional<long>",
},
Expand Down Expand Up @@ -6704,6 +6705,7 @@ service:
query-parameters:
limit:
type: optional<long>
default: 10
docs: Maximum amount of transcripts to retrieve
status:
type: optional<TranscriptListRequestStatus>
Expand Down
Loading

0 comments on commit 7770eed

Please sign in to comment.