diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/apiture.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/apiture.json index 833115b805e..845c7b04623 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/apiture.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/apiture.json @@ -13538,6 +13538,7 @@ The response may be incomplete. Given a `Retry-After` response header, the clien "type": "optional", }, "limit": { + "default": 100, "docs": "The maximum number of items to return in this paged response.", "type": "optional", "validation": { @@ -13558,6 +13559,7 @@ The response may be incomplete. Given a `Retry-After` response header, the clien "type": "optional", }, "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", "validation": { @@ -13605,6 +13607,7 @@ Optionally, an agent can access a business customer's ACH accounts when acting o "type": "optional", }, "limit": { + "default": 100, "docs": "The maximum number of items to return in this paged response.", "type": "optional", "validation": { @@ -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", "validation": { @@ -13708,6 +13712,7 @@ service: `account.allows.view` are all `true` for the caller. start: type: optional + 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 @@ -13718,6 +13723,7 @@ service: maxLength: 256 limit: type: optional + default: 100 docs: The maximum number of items to return in this paged response. validation: min: 0 @@ -13940,6 +13946,7 @@ service: authenticated caller's customer ID (not their access ID). start: type: optional + 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 @@ -13950,6 +13957,7 @@ service: maxLength: 256 limit: type: optional + default: 100 docs: The maximum number of items to return in this paged response. validation: min: 0 @@ -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", "validation": { @@ -14593,6 +14602,7 @@ service: `credit`, dates are adjusted to the previous business day. count: type: optional + 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 @@ -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", "validation": { @@ -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", "validation": { @@ -15251,6 +15263,7 @@ service: query-parameters: start: type: optional + 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 @@ -15261,6 +15274,7 @@ service: maxLength: 256 limit: type: optional + default: 100 docs: The maximum number of items to return in this paged response. validation: min: 0 @@ -15644,6 +15658,7 @@ The default response lists only recent transactions. Normally, this is transacti "type": "optional", }, "limit": { + "default": 100, "docs": "The maximum number of items to return in this paged response.", "type": "optional", "validation": { @@ -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", "validation": { @@ -15761,6 +15777,7 @@ service: query-parameters: start: type: optional + 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 @@ -15771,6 +15788,7 @@ service: maxLength: 256 limit: type: optional + default: 100 docs: The maximum number of items to return in this paged response. validation: min: 0 @@ -16278,6 +16296,7 @@ Note: This operation requires an identity challenge if the financial institution "type": "optional", }, "limit": { + "default": 100, "docs": "The maximum number of items to return in this paged response.", "type": "optional", "validation": { @@ -16293,6 +16312,7 @@ Note: This operation requires an identity challenge if the financial institution "type": "optional", }, "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", "validation": { @@ -16487,6 +16507,7 @@ service: finished processing. If omitted, list all transfers. start: type: optional + 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 @@ -16497,6 +16518,7 @@ service: maxLength: 256 limit: type: optional + default: 100 docs: The maximum number of items to return in this paged response. validation: min: 0 diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/aries.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/aries.json index ad8c91902c0..e23a8d9833c 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/aries.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/aries.json @@ -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", }, @@ -22661,10 +22662,12 @@ docs: Interaction with ledger "path-parameters": undefined, "query-parameters": { "paginate_limit": { + "default": -1, "docs": "limit number of results", "type": "optional", }, "paginate_offset": { + "default": 0, "docs": "offset to use in pagination", "type": "optional", }, @@ -22986,6 +22989,7 @@ service: format: uuid role: type: optional + default: server docs: >- Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent @@ -23028,9 +23032,11 @@ service: query-parameters: paginate_limit: type: optional + default: -1 docs: limit number of results paginate_offset: type: optional + default: 0 docs: offset to use in pagination body: properties: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/assembly.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/assembly.json index d0ad7a97f3b..2bb579b1d57 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/assembly.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/assembly.json @@ -6575,6 +6575,7 @@ docs: Real-time transcription }, }, "limit": { + "default": 10, "docs": "Maximum amount of transcripts to retrieve", "type": "optional", }, @@ -6704,6 +6705,7 @@ service: query-parameters: limit: type: optional + default: 10 docs: Maximum amount of transcripts to retrieve status: type: optional diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/belvo.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/belvo.json index fa029dd0715..e52f22ef15a 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/belvo.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/belvo.json @@ -30564,6 +30564,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -32570,6 +32571,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -36181,6 +36183,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -36723,6 +36726,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -40115,6 +40119,7 @@ At the moment, the employment records resource is available for: "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -40293,6 +40298,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -41405,6 +41411,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -41854,6 +41861,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -43057,6 +43065,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -43134,6 +43143,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -43977,6 +43987,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -44372,6 +44383,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -47467,6 +47479,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -48966,6 +48979,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -52840,6 +52854,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -53587,6 +53602,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -55360,6 +55376,7 @@ Cancun, COL 10447", "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -55724,6 +55741,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -58542,6 +58560,7 @@ types: "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 100. If you enter a value greater than 100, our API will default to the maximum value (1000). @@ -58723,6 +58742,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -60095,6 +60115,7 @@ docs: >+ "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -60302,6 +60323,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -61208,6 +61230,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -61695,6 +61718,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -63151,6 +63175,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -63641,6 +63666,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -65306,6 +65332,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -65526,6 +65553,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -66715,6 +66743,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -67114,6 +67143,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -68154,6 +68184,7 @@ client.tax_retentions.list(params: { "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -68344,6 +68375,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -71604,6 +71636,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -73561,6 +73594,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -78256,6 +78290,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -78731,6 +78766,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -81501,6 +81537,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -82965,6 +83002,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/deel.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/deel.json index cb2f0dfb222..0360432297e 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/deel.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/deel.json @@ -21501,6 +21501,7 @@ service: }, }, "offset": { + "default": 0, "docs": "Return a page of results with given number of records.", "type": "optional", }, @@ -21538,6 +21539,7 @@ service: query-parameters: offset: type: optional + default: 0 docs: Return a page of results with given number of records. limit: type: optional @@ -26162,6 +26164,7 @@ docs: API end-points related to HRIS data. "type": "optional", }, "limit": { + "default": 10, "docs": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", "validation": { @@ -26173,6 +26176,7 @@ docs: API end-points related to HRIS data. }, }, "offset": { + "default": 0, "docs": "Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", }, @@ -26307,6 +26311,7 @@ docs: API end-points related to HRIS data. "type": "optional", }, "limit": { + "default": 10, "docs": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", "validation": { @@ -26318,6 +26323,7 @@ docs: API end-points related to HRIS data. }, }, "offset": { + "default": 0, "docs": "Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", }, @@ -26470,6 +26476,7 @@ service: (excludes records submitted on this date) limit: type: optional + default: 10 docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings @@ -26478,6 +26485,7 @@ service: max: 99 offset: type: optional + default: 0 docs: >- Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings @@ -26589,6 +26597,7 @@ service: (excludes records submitted on this date) limit: type: optional + default: 10 docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings @@ -26597,6 +26606,7 @@ service: max: 99 offset: type: optional + default: 0 docs: >- Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings @@ -27015,6 +27025,7 @@ docs: >- "type": "optional", }, "limit": { + "default": 99, "docs": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", }, @@ -27066,6 +27077,7 @@ docs: >- "name": "GetSeniorityListRequest", "query-parameters": { "limit": { + "default": 50, "docs": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", }, @@ -27204,6 +27216,7 @@ service: query-parameters: limit: type: optional + default: 99 docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings @@ -27246,6 +27259,7 @@ service: query-parameters: limit: type: optional + default: 50 docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings @@ -30893,10 +30907,12 @@ docs: Manage time off requests. "type": "optional", }, "limit": { + "default": 99, "docs": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", }, "offset": { + "default": 0, "docs": "Return a page of results after given index of row", "type": "optional", }, @@ -31016,10 +31032,12 @@ docs: Manage time off requests. "type": "optional", }, "limit": { + "default": 99, "docs": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", }, "offset": { + "default": 0, "docs": "Return a page of results after given index of row", "type": "optional", }, @@ -31159,11 +31177,13 @@ service: date. limit: type: optional + default: 99 docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings offset: type: optional + default: 0 docs: Return a page of results after given index of row response: docs: Successful operation. @@ -31260,11 +31280,13 @@ service: date. limit: type: optional + default: 99 docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings offset: type: optional + default: 0 docs: Return a page of results after given index of row response: docs: Successful operation. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/flexport.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/flexport.json index 29bcb63a483..5f69f7bda11 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/flexport.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/flexport.json @@ -10762,6 +10762,7 @@ errors: "name": "BookingsIndexRequest", "query-parameters": { "direction": { + "default": "desc", "docs": "Set sort order. Allows "asc"(ascending) or "desc" (descending).", "type": "optional", }, @@ -10828,6 +10829,7 @@ errors: "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -10839,6 +10841,7 @@ errors: }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", "validation": { @@ -11775,11 +11778,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). @@ -11791,6 +11796,7 @@ service: docs: Sort results by the specified field. direction: type: optional + default: desc docs: Set sort order. Allows "asc"(ascending) or "desc" (descending). f.status: type: optional @@ -13350,6 +13356,7 @@ docs: >- "name": "BookingLineItemIndexRequest", "query-parameters": { "direction": { + "default": "desc", "docs": "Set sort order. Allows "asc" (ascending) or "desc" (descending)", "type": "optional", }, @@ -13366,6 +13373,7 @@ docs: >- "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -13377,6 +13385,7 @@ docs: >- }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -13584,11 +13593,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -13597,6 +13608,7 @@ service: max: 100 direction: type: optional + default: desc docs: Set sort order. Allows "asc" (ascending) or "desc" (descending) f.purchase_order.id: type: optional @@ -14496,6 +14508,7 @@ docs: Endpoints relating to Carbon Calculations "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -14507,6 +14520,7 @@ docs: Endpoints relating to Carbon Calculations }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -14978,11 +14992,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -15712,6 +15728,7 @@ docs: Endpoints relating to Commercial Invoice objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -15723,6 +15740,7 @@ docs: Endpoints relating to Commercial Invoice objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -16179,11 +16197,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -16624,6 +16644,7 @@ docs: Endpoints relating to Company objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -16635,6 +16656,7 @@ docs: Endpoints relating to Company objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -17041,11 +17063,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -17454,6 +17478,7 @@ docs: Endpoints relating to CompanyEntity objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -17465,6 +17490,7 @@ docs: Endpoints relating to CompanyEntity objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -17759,11 +17785,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -18103,6 +18131,7 @@ docs: Endpoints relating to Contact objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -18114,6 +18143,7 @@ docs: Endpoints relating to Contact objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", "validation": { @@ -18332,11 +18362,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). @@ -18602,6 +18634,7 @@ docs: Endpoints relating to Container objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -18613,6 +18646,7 @@ docs: Endpoints relating to Container objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", "validation": { @@ -18783,11 +18817,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). @@ -18952,6 +18988,7 @@ docs: Endpoints relating to ContainerLeg objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -18963,6 +19000,7 @@ docs: Endpoints relating to ContainerLeg objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -19127,11 +19165,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -19382,6 +19422,7 @@ docs: Endpoints relating to Customs Entry objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -19393,6 +19434,7 @@ docs: Endpoints relating to Customs Entry objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -19585,11 +19627,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -20535,6 +20579,7 @@ Other details about this invoice", "name": "InvoiceIndexRequest", "query-parameters": { "direction": { + "default": "desc", "docs": "Set sort order. Allows "asc"(ascending) or "desc" (descending).", "type": "optional", }, @@ -20591,6 +20636,7 @@ This parameter is mutually exclusive with the f.shipment.id filter. "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -21019,6 +21065,7 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 @@ -21035,6 +21082,7 @@ service: docs: Sort results by the specified field. direction: type: optional + default: desc docs: Set sort order. Allows "asc"(ascending) or "desc" (descending). f.status: type: optional @@ -21602,6 +21650,7 @@ docs: Endpoints relating to Invoice objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -21613,6 +21662,7 @@ docs: Endpoints relating to Invoice objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -22047,11 +22097,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -22463,6 +22515,7 @@ docs: Endpoints relating to Location objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -22474,6 +22527,7 @@ docs: Endpoints relating to Location objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -22586,11 +22640,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -24045,6 +24101,7 @@ docs: Endpoints relating to Product objects "name": "PurchaseOrderIndexRequest", "query-parameters": { "direction": { + "default": "asc", "docs": "Set sort order. Allows "asc"(ascending) or "desc" (descending)", "type": "optional", }, @@ -24094,6 +24151,7 @@ docs: Endpoints relating to Product objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -24105,6 +24163,7 @@ docs: Endpoints relating to Product objects }, }, "per": { + "default": 20, "docs": "Count of items in each page Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -24673,11 +24732,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page Should be between 1 and 100 (inclusive) @@ -24691,6 +24752,7 @@ service: this time) direction: type: optional + default: asc docs: Set sort order. Allows "asc"(ascending) or "desc" (descending) f.archived_at.exists: type: optional @@ -25572,6 +25634,7 @@ docs: >- "name": "PurchaseOrderLineItemIndexRequest", "query-parameters": { "direction": { + "default": "desc", "docs": "Set sort order. Allows "asc"(ascending) or "desc" (descending)", "type": "optional", }, @@ -25592,6 +25655,7 @@ docs: >- "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -25603,6 +25667,7 @@ docs: >- }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -25873,11 +25938,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -25886,6 +25953,7 @@ service: max: 100 direction: type: optional + default: desc docs: Set sort order. Allows "asc"(ascending) or "desc" (descending) f.purchase_order.id: type: optional @@ -26432,6 +26500,7 @@ docs: >- "name": "ShipmentIndexRequest", "query-parameters": { "direction": { + "default": "desc", "docs": "Set sort order. Allows "asc" (ascending) or "desc" (descending).", "type": "optional", }, @@ -26567,6 +26636,7 @@ docs: >- }, }, "sort": { + "default": "id", "docs": "Sort results by the specified field.", "type": "optional", }, @@ -27518,9 +27588,11 @@ service: max: 100 sort: type: optional + default: id docs: Sort results by the specified field. direction: type: optional + default: desc docs: Set sort order. Allows "asc" (ascending) or "desc" (descending). f.transportation_mode: type: optional @@ -28611,6 +28683,7 @@ docs: Endpoints relating to Shipment objects "name": "ShipmentLegIndexRequest", "query-parameters": { "f.include_deleted": { + "default": false, "docs": "Returns legs including deleted legs", "type": "optional", }, @@ -28623,6 +28696,7 @@ docs: Endpoints relating to Shipment objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -28634,6 +28708,7 @@ docs: Endpoints relating to Shipment objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", "validation": { @@ -28817,6 +28892,7 @@ docs: Endpoints relating to Shipment objects "name": "ShipmentLegShowRequest", "query-parameters": { "f.include_deleted": { + "default": false, "docs": "Retrieves the leg even if it was deleted", "type": "optional", }, @@ -28924,11 +29000,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). @@ -28943,6 +29021,7 @@ service: docs: Only return legs that match the given transportation mode f.include_deleted: type: optional + default: false docs: Returns legs including deleted legs response: docs: Success @@ -29081,6 +29160,7 @@ service: query-parameters: f.include_deleted: type: optional + default: false docs: Retrieves the leg even if it was deleted response: docs: Success diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/humanloop.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/humanloop.json index 02e49b11501..8f25619100d 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/humanloop.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/humanloop.json @@ -7557,6 +7557,7 @@ By default the deployed version of the Dataset is returned. Use the query parame "type": "optional", }, "include_datapoints": { + "default": false, "docs": "If set to `true`, include all Datapoints in the response. Defaults to `false`. Consider using the paginated List Datapoints endpoint instead.", "type": "optional", }, @@ -7637,6 +7638,7 @@ By default the deployed version of the Dataset is returned. Use the query parame "type": "optional", }, "page": { + "default": 1, "docs": "Page offset for pagination.", "type": "optional", "validation": { @@ -7648,6 +7650,7 @@ By default the deployed version of the Dataset is returned. Use the query parame }, }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Datasets to fetch.", "type": "optional", "validation": { @@ -7730,6 +7733,7 @@ By default the deployed version of the Dataset is returned. Use the query parame "type": "optional", }, "page": { + "default": 1, "docs": "Page number for pagination.", "type": "optional", "validation": { @@ -7741,6 +7745,7 @@ By default the deployed version of the Dataset is returned. Use the query parame }, }, "size": { + "default": 50, "docs": "Page size for pagination. Number of Datapoints to fetch.", "type": "optional", "validation": { @@ -7958,11 +7963,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page offset for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Datasets to fetch. validation: min: 0 @@ -8179,6 +8186,7 @@ service: docs: An environment tag to retrieve a deployed Version from. include_datapoints: type: optional + default: false docs: >- If set to `true`, include all Datapoints in the response. Defaults to `false`. Consider using the paginated List Datapoints endpoint @@ -8316,11 +8324,13 @@ service: docs: An environment tag to retrieve a deployed Version from. page: type: optional + default: 1 docs: Page number for pagination. validation: min: 1 size: type: optional + default: 50 docs: Page size for pagination. Number of Datapoints to fetch. validation: min: 0 @@ -9057,6 +9067,7 @@ Retrieve a list of Evaluations that evaluate versions of the specified File.", "type": "string", }, "page": { + "default": 1, "docs": "Page number for pagination.", "type": "optional", "validation": { @@ -9068,6 +9079,7 @@ Retrieve a list of Evaluations that evaluate versions of the specified File.", }, }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Evaluations to fetch.", "type": "optional", "validation": { @@ -9410,11 +9422,13 @@ service: File will be returned. page: type: optional + default: 1 docs: Page number for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Evaluations to fetch. validation: min: 0 @@ -10707,6 +10721,7 @@ By default the deployed version of the Evaluator is returned. Use the query para "type": "optional", }, "page": { + "default": 1, "docs": "Page offset for pagination.", "type": "optional", "validation": { @@ -10718,6 +10733,7 @@ By default the deployed version of the Evaluator is returned. Use the query para }, }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Evaluators to fetch.", "type": "optional", }, @@ -11045,11 +11061,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page offset for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Evaluators to fetch. name: type: optional @@ -12092,6 +12110,7 @@ You can manually create Logs through the API. "type": "optional", }, "page": { + "default": 1, "docs": "Page number for pagination.", "type": "optional", "validation": { @@ -12107,6 +12126,7 @@ You can manually create Logs through the API. "type": "optional", }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Logs to fetch.", "type": "optional", "validation": { @@ -12167,11 +12187,13 @@ service: docs: Unique identifier for the File to list Logs for. page: type: optional + default: 1 docs: Page number for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Logs to fetch. validation: min: 0 @@ -13382,6 +13404,7 @@ By default the deployed version of the Prompt is returned. Use the query paramet "type": "optional", }, "page": { + "default": 1, "docs": "Page number for pagination.", "type": "optional", "validation": { @@ -13393,6 +13416,7 @@ By default the deployed version of the Prompt is returned. Use the query paramet }, }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Prompts to fetch.", "type": "optional", "validation": { @@ -14052,11 +14076,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Prompts to fetch. validation: min: 0 @@ -15586,6 +15612,7 @@ Log is in, nested within the evaluated Log. "type": "optional", }, "page": { + "default": 1, "docs": "Page number for pagination.", "type": "optional", "validation": { @@ -15597,6 +15624,7 @@ Log is in, nested within the evaluated Log. }, }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Sessions to fetch.", "type": "optional", "validation": { @@ -15745,11 +15773,13 @@ service: that contain any Logs associated to this Version will be returned. page: type: optional + default: 1 docs: Page number for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Sessions to fetch. validation: min: 0 @@ -16315,6 +16345,7 @@ By default the deployed version of the Tool is returned. Use the query parameter "type": "optional", }, "page": { + "default": 1, "docs": "Page offset for pagination.", "type": "optional", "validation": { @@ -16326,6 +16357,7 @@ By default the deployed version of the Tool is returned. Use the query parameter }, }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Tools to fetch.", "type": "optional", }, @@ -16832,11 +16864,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page offset for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Tools to fetch. name: type: optional diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hume.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hume.json index 525c50ba481..b93e4cabadc 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hume.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hume.json @@ -107,6 +107,7 @@ "type": "optional", }, "limit": { + "default": 50, "docs": "The maximum number of jobs to include in the response.", "type": "optional", }, @@ -1332,6 +1333,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive query-parameters: limit: type: optional + default: 50 docs: The maximum number of jobs to include in the response. status: type: optional diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/intercom.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/intercom.json index dac6ff60561..70658512321 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/intercom.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/intercom.json @@ -26318,6 +26318,7 @@ You can optionally request the result page size and the cursor to start after to "name": "ListConversationsRequest", "query-parameters": { "per_page": { + "default": 20, "docs": "How many results per page", "type": "optional", "validation": { @@ -28782,6 +28783,7 @@ service: query-parameters: per_page: type: optional + default: 20 docs: How many results per page validation: max: 150 diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ntropy.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ntropy.json index 20a1c1a672a..140324fea4b 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ntropy.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ntropy.json @@ -5107,6 +5107,7 @@ ah = sdk.account_holders.get("f35b927b6-6fda-40aa-93b8-95b47c2b2cad") ", "type": "optional", }, "limit": { + "default": 10, "docs": "The limit of account holders to be returned", "type": "optional", "validation": { @@ -5240,6 +5241,7 @@ service: docs: Starting point for the set of account holders limit: type: optional + default: 10 docs: The limit of account holders to be returned validation: min: 1 @@ -5727,6 +5729,7 @@ for bs in sdk.bank_statements.list().auto_paginate(): "type": "optional", }, "limit": { + "default": 10, "docs": "The limit of bank statements to be returned", "type": "optional", "validation": { @@ -5864,6 +5867,7 @@ service: docs: Starting point for the set of bank statements limit: type: optional + default: 10 docs: The limit of bank statements to be returned validation: min: 1 @@ -6387,6 +6391,7 @@ for batch in sdk.batches.list().auto_paginate(): "type": "optional", }, "limit": { + "default": 10, "docs": "The limit of batches to be returned", "type": "optional", "validation": { @@ -6624,6 +6629,7 @@ service: docs: Starting point for the set of batches limit: type: optional + default: 10 docs: The limit of batches to be returned validation: min: 1 @@ -8706,6 +8712,7 @@ reports = sdk.reports.list() "type": "optional", }, "limit": { + "default": 10, "docs": "The limit of report to be returned", "type": "optional", "validation": { @@ -8871,6 +8878,7 @@ service: docs: Starting point for the set of report limit: type: optional + default: 10 docs: The limit of report to be returned validation: min: 1 @@ -9357,6 +9365,7 @@ for tx in sdk.transactions.list().auto_paginate(): "type": "optional", }, "limit": { + "default": 25, "docs": "The limit of transactions to be returned", "type": "optional", "validation": { @@ -9826,6 +9835,7 @@ service: docs: Starting point for the set of transactions limit: type: optional + default: 25 docs: The limit of transactions to be returned validation: min: 1 diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json index 30726459099..999dce126c4 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json @@ -25803,6 +25803,7 @@ You can optionally request the result page size and the cursor to start after to "name": "ListConversationsRequest", "query-parameters": { "per_page": { + "default": 20, "docs": "How many results per page", "type": "optional", "validation": { @@ -28267,6 +28268,7 @@ service: query-parameters: per_page: type: optional + default: 20 docs: How many results per page validation: max: 150 diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/permit.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/permit.json index e9acecb4488..74f28c10e6d 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/permit.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/permit.json @@ -6983,6 +6983,7 @@ If the permission is already granted, it is skipped.", "name": "ListSetPermissionsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -6994,6 +6995,7 @@ If the permission is already granted, it is skipped.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -7159,11 +7161,13 @@ service: permission is granted on this resource set page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -7842,6 +7846,7 @@ This includes any permissions granted to said condition set (i.e: any matching c "name": "GetConditionSetAncestorsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -7853,6 +7858,7 @@ This includes any permissions granted to said condition set (i.e: any matching c }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -7986,6 +7992,7 @@ This includes any permissions granted to said condition set (i.e: any matching c "name": "GetConditionSetDescendantsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -7997,6 +8004,7 @@ This includes any permissions granted to said condition set (i.e: any matching c }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -8124,10 +8132,12 @@ This includes any permissions granted to said condition set (i.e: any matching c "name": "ListConditionSetsRequest", "query-parameters": { "include_total_count": { + "default": false, "docs": "Include total count in response", "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -8139,6 +8149,7 @@ This includes any permissions granted to said condition set (i.e: any matching c }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -8403,14 +8414,17 @@ service: type. e.g: only user sets. include_total_count: type: optional + default: false docs: Include total count in response page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -8887,11 +8901,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -8991,11 +9007,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -9436,6 +9454,7 @@ allowed.", "name": "ListEnvironmentsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -9447,6 +9466,7 @@ allowed.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -9827,11 +9847,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -10408,6 +10430,7 @@ authenticated actor (i.e: human team member or api key).", "name": "ListOrganizationsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -10419,6 +10442,7 @@ authenticated actor (i.e: human team member or api key).", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -10536,11 +10560,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -10983,6 +11009,7 @@ Every project is a separate silo, and has its own unique set of environments and "name": "ListProjectsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -10994,6 +11021,7 @@ Every project is a separate silo, and has its own unique set of environments and }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -11120,11 +11148,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -11631,6 +11661,7 @@ This includes any permissions granted to perform the action.", "name": "ListResourceActionGroupsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -11642,6 +11673,7 @@ This includes any permissions granted to perform the action.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -11798,11 +11830,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -12390,6 +12424,7 @@ This includes any permissions granted to perform the action.", "name": "ListResourceActionsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -12401,6 +12436,7 @@ This includes any permissions granted to perform the action.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -12553,11 +12589,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -12987,6 +13025,7 @@ attribute to evaluate as `undefined`.", "name": "DeleteResourceAttributeRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -12998,6 +13037,7 @@ attribute to evaluate as `undefined`.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -13131,6 +13171,7 @@ attribute to evaluate as `undefined`.", "name": "ListResourceAttributesRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -13142,6 +13183,7 @@ attribute to evaluate as `undefined`.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -13275,11 +13317,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -13460,11 +13504,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -13830,6 +13876,7 @@ and will return the existing instance object in the response body.", "name": "ListResourceInstancesRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -13841,6 +13888,7 @@ and will return the existing instance object in the response body.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -13979,11 +14027,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -14801,6 +14851,7 @@ This includes any permissions granted to said role.", "name": "ListResourceRolesRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -14812,6 +14863,7 @@ This includes any permissions granted to said role.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -15062,11 +15114,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -16077,14 +16131,17 @@ A resource may also contain: "name": "ListResourcesRequest", "query-parameters": { "include_built_in": { + "default": false, "docs": "Whether to include or exclude built-in resources, default is False", "type": "optional", }, "include_total_count": { + "default": false, "docs": "Include total count in response", "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -16096,6 +16153,7 @@ A resource may also contain: }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -16472,17 +16530,21 @@ service: docs: Text search for the resources name or key include_built_in: type: optional + default: false docs: Whether to include or exclude built-in resources, default is False include_total_count: type: optional + default: false docs: Include total count in response page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -17293,6 +17355,7 @@ The tenant defines the scope of the assignment. In other words, the role is effe "name": "ListRoleAssignmentsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -17304,6 +17367,7 @@ The tenant defines the scope of the assignment. In other words, the role is effe }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -17445,11 +17509,13 @@ service: in that tenant. page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -18162,10 +18228,12 @@ This includes any permissions granted to said role.", "name": "ListRolesRequest", "query-parameters": { "include_total_count": { + "default": false, "docs": "Include total count in response", "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -18177,6 +18245,7 @@ This includes any permissions granted to said role.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -18442,14 +18511,17 @@ service: docs: Text search for the roles name or key include_total_count: type: optional + default: false docs: Include total count in response page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -19320,6 +19392,7 @@ and will return the existing tenant object in the response body.", "name": "ListTenantUsersRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -19331,6 +19404,7 @@ and will return the existing tenant object in the response body.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -19417,10 +19491,12 @@ and will return the existing tenant object in the response body.", "name": "ListTenantsRequest", "query-parameters": { "include_total_count": { + "default": false, "docs": "Include total count in response", "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -19432,6 +19508,7 @@ and will return the existing tenant object in the response body.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -19605,11 +19682,13 @@ service: docs: Match users with a specific role page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -19684,14 +19763,17 @@ service: docs: Text search for the tenant name or key include_total_count: type: optional + default: false docs: Include total count in response page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -20135,6 +20217,7 @@ attribute to evaluate as `undefined`.", "name": "DeleteUserAttributeRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -20146,6 +20229,7 @@ attribute to evaluate as `undefined`.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -20276,6 +20360,7 @@ attribute to evaluate as `undefined`.", "name": "ListUserAttributesRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -20287,6 +20372,7 @@ attribute to evaluate as `undefined`.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -20416,11 +20502,13 @@ service: resource_id: optional page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -20589,11 +20677,13 @@ service: resource_id: optional page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -21105,6 +21195,7 @@ and will return the existing user object in the response body.", "name": "ListUsersRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -21116,6 +21207,7 @@ and will return the existing user object in the response body.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -21479,11 +21571,13 @@ service: docs: Match users with a specific role page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/squidex.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/squidex.json index 247a8055f29..104ed4df4fc 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/squidex.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/squidex.json @@ -23049,6 +23049,7 @@ service: "name": "BackupsGetBackupContentV2Request", "query-parameters": { "app": { + "default": "", "docs": "The name of the app.", "type": "optional", }, @@ -23313,6 +23314,7 @@ service: docs: The ID of the app. app: type: optional + default: '' docs: The name of the app. response: docs: Backup found and content returned. @@ -23538,6 +23540,7 @@ service: "name": "CommentsGetCommentsRequest", "query-parameters": { "version": { + "default": -2, "docs": "The current version.", "type": "optional", }, @@ -23750,6 +23753,7 @@ service: query-parameters: version: type: optional + default: -2 docs: The current version. response: docs: Comments returned. @@ -24536,6 +24540,7 @@ service: "name": "ContentsGetContentRequest", "query-parameters": { "version": { + "default": -2, "docs": "The optional version.", "type": "optional", }, @@ -26280,6 +26285,7 @@ service: query-parameters: version: type: optional + default: -2 docs: The optional version. response: docs: Content returned. @@ -28235,6 +28241,7 @@ service: "name": "NewsGetNewsRequest", "query-parameters": { "version": { + "default": 0, "docs": "The latest received version.", "type": "optional", }, @@ -28272,6 +28279,7 @@ service: query-parameters: version: type: optional + default: 0 docs: The latest received version. response: docs: Latest features returned. @@ -28386,6 +28394,7 @@ service: "name": "NotificationsGetNotificationsRequest", "query-parameters": { "version": { + "default": -2, "docs": "The current version.", "type": "optional", }, @@ -28428,6 +28437,7 @@ service: query-parameters: version: type: optional + default: -2 docs: The current version. response: docs: All comments returned. @@ -29485,10 +29495,12 @@ service: "type": "optional", }, "skip": { + "default": 0, "docs": "The number of events to skip.", "type": "optional", }, "take": { + "default": 20, "docs": "The number of events to take.", "type": "optional", }, @@ -29837,6 +29849,7 @@ service: "name": "RulesPutRuleRunRequest", "query-parameters": { "fromSnapshots": { + "default": false, "docs": "Runs the rule from snapeshots if possible.", "type": "optional", }, @@ -30455,6 +30468,7 @@ service: query-parameters: fromSnapshots: type: optional + default: false docs: Runs the rule from snapeshots if possible. errors: - root.RulesPutRuleRunRequestBadRequestError @@ -30605,9 +30619,11 @@ service: docs: The optional rule id to filter to events. skip: type: optional + default: 0 docs: The number of events to skip. take: type: optional + default: 20 docs: The number of events to take. response: docs: Rule events returned. @@ -40685,10 +40701,12 @@ service: "type": "optional", }, "skip": { + "default": 0, "docs": "The number of users to skip.", "type": "optional", }, "take": { + "default": 10, "docs": "The number of users to return.", "type": "optional", }, @@ -41024,9 +41042,11 @@ service: docs: Optional query to search by email address or username. skip: type: optional + default: 0 docs: The number of users to skip. take: type: optional + default: 10 docs: The number of users to return. response: docs: Users returned. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/switchboard.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/switchboard.json index 17f14de6f23..ffa4b7e97af 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/switchboard.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/switchboard.json @@ -2304,10 +2304,12 @@ service: "name": "SessionsListRequest", "query-parameters": { "limit": { + "default": 0, "docs": "limit for pagination", "type": "optional", }, "offset": { + "default": -1, "docs": "offset for pagination", "type": "optional", }, @@ -2593,9 +2595,11 @@ service: docs: status of the session to get offset: type: optional + default: -1 docs: offset for pagination limit: type: optional + default: 0 docs: limit for pagination response: docs: OK diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/valtown.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/valtown.json index 98f13da2cd0..8f25328549c 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/valtown.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/valtown.json @@ -2123,6 +2123,7 @@ give access to details and data from the requesting user.", "name": "MeCommentsRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -2134,6 +2135,7 @@ give access to details and data from the requesting user.", }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -2145,6 +2147,7 @@ give access to details and data from the requesting user.", }, }, "relationship": { + "default": "any", "docs": "Whether to get comments you have received, given, or both", "type": "MeCommentsRequestRelationship", }, @@ -2247,6 +2250,7 @@ give access to details and data from the requesting user.", "name": "MeLikesRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -2258,6 +2262,7 @@ give access to details and data from the requesting user.", }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -2318,6 +2323,7 @@ give access to details and data from the requesting user.", "name": "MeReferencesRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -2329,6 +2335,7 @@ give access to details and data from the requesting user.", }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -2956,11 +2963,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 @@ -3007,11 +3016,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 @@ -3024,6 +3035,7 @@ service: docs: Include items created before this date relationship: type: MeCommentsRequestRelationship + default: any docs: Whether to get comments you have received, given, or both response: docs: A paginated result set @@ -3062,11 +3074,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 @@ -3170,6 +3184,7 @@ imports: "name": "SearchValsRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -3181,6 +3196,7 @@ imports: }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -3256,11 +3272,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 @@ -3827,6 +3845,7 @@ docs: SQLite "name": "UsersValsRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -3838,6 +3857,7 @@ docs: SQLite }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -3925,11 +3945,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 @@ -4512,6 +4534,7 @@ let you get, create, and run vals.", "name": "ValsGetVersionRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -4523,6 +4546,7 @@ let you get, create, and run vals.", }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -4586,6 +4610,7 @@ let you get, create, and run vals.", "name": "ValsListRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -4597,6 +4622,7 @@ let you get, create, and run vals.", }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -5449,11 +5475,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 @@ -5574,11 +5602,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/apiture.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/apiture.json index f190a039609..8eba07161f0 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/apiture.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/apiture.json @@ -6160,6 +6160,7 @@ The response may be incomplete. Given a `Retry-After` response header, the clien "type": "optional", }, "limit": { + "default": 100, "docs": "The maximum number of items to return in this paged response.", "type": "optional", "validation": { @@ -6180,6 +6181,7 @@ The response may be incomplete. Given a `Retry-After` response header, the clien "type": "optional", }, "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", "validation": { @@ -6227,6 +6229,7 @@ Optionally, an agent can access a business customer's ACH accounts when acting o "type": "optional", }, "limit": { + "default": 100, "docs": "The maximum number of items to return in this paged response.", "type": "optional", "validation": { @@ -6242,6 +6245,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", "validation": { @@ -6330,6 +6334,7 @@ service: `account.allows.view` are all `true` for the caller. start: type: optional + 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 @@ -6340,6 +6345,7 @@ service: maxLength: 256 limit: type: optional + default: 100 docs: The maximum number of items to return in this paged response. validation: min: 0 @@ -6562,6 +6568,7 @@ service: authenticated caller's customer ID (not their access ID). start: type: optional + 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 @@ -6572,6 +6579,7 @@ service: maxLength: 256 limit: type: optional + default: 100 docs: The maximum number of items to return in this paged response. validation: min: 0 @@ -6931,6 +6939,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", "validation": { @@ -7214,6 +7223,7 @@ service: `credit`, dates are adjusted to the previous business day. count: type: optional + 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 @@ -7736,6 +7746,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", "validation": { @@ -7747,6 +7758,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", "validation": { @@ -7870,6 +7882,7 @@ service: query-parameters: start: type: optional + 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 @@ -7880,6 +7893,7 @@ service: maxLength: 256 limit: type: optional + default: 100 docs: The maximum number of items to return in this paged response. validation: min: 0 @@ -8253,6 +8267,7 @@ The default response lists only recent transactions. Normally, this is transacti "type": "optional", }, "limit": { + "default": 100, "docs": "The maximum number of items to return in this paged response.", "type": "optional", "validation": { @@ -8294,6 +8309,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", "validation": { @@ -8370,6 +8386,7 @@ service: query-parameters: start: type: optional + 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 @@ -8380,6 +8397,7 @@ service: maxLength: 256 limit: type: optional + default: 100 docs: The maximum number of items to return in this paged response. validation: min: 0 @@ -8887,6 +8905,7 @@ Note: This operation requires an identity challenge if the financial institution "type": "optional", }, "limit": { + "default": 100, "docs": "The maximum number of items to return in this paged response.", "type": "optional", "validation": { @@ -8902,6 +8921,7 @@ Note: This operation requires an identity challenge if the financial institution "type": "optional", }, "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", "validation": { @@ -9096,6 +9116,7 @@ service: finished processing. If omitted, list all transfers. start: type: optional + 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 @@ -9106,6 +9127,7 @@ service: maxLength: 256 limit: type: optional + default: 100 docs: The maximum number of items to return in this paged response. validation: min: 0 diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/aries.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/aries.json index ad8c91902c0..e23a8d9833c 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/aries.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/aries.json @@ -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", }, @@ -22661,10 +22662,12 @@ docs: Interaction with ledger "path-parameters": undefined, "query-parameters": { "paginate_limit": { + "default": -1, "docs": "limit number of results", "type": "optional", }, "paginate_offset": { + "default": 0, "docs": "offset to use in pagination", "type": "optional", }, @@ -22986,6 +22989,7 @@ service: format: uuid role: type: optional + default: server docs: >- Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent @@ -23028,9 +23032,11 @@ service: query-parameters: paginate_limit: type: optional + default: -1 docs: limit number of results paginate_offset: type: optional + default: 0 docs: offset to use in pagination body: properties: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/assembly.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/assembly.json index de5fe617b31..4779f4e9b70 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/assembly.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/assembly.json @@ -4730,6 +4730,7 @@ docs: Real-time transcription }, }, "limit": { + "default": 10, "docs": "Maximum amount of transcripts to retrieve", "type": "optional", }, @@ -4859,6 +4860,7 @@ service: query-parameters: limit: type: optional + default: 10 docs: Maximum amount of transcripts to retrieve status: type: optional diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/belvo.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/belvo.json index 95073e80807..9ff8f65b49b 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/belvo.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/belvo.json @@ -22799,6 +22799,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -24805,6 +24806,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -28416,6 +28418,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -28958,6 +28961,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -32350,6 +32354,7 @@ At the moment, the employment records resource is available for: "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -32528,6 +32533,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -33640,6 +33646,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -34089,6 +34096,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -35292,6 +35300,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -35369,6 +35378,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -36212,6 +36222,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -36607,6 +36618,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -39702,6 +39714,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -41201,6 +41214,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -45075,6 +45089,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -45822,6 +45837,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -47595,6 +47611,7 @@ Cancun, COL 10447", "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -47959,6 +47976,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -50777,6 +50795,7 @@ types: "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 100. If you enter a value greater than 100, our API will default to the maximum value (1000). @@ -50958,6 +50977,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -52330,6 +52350,7 @@ docs: >+ "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -52537,6 +52558,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -53443,6 +53465,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -53930,6 +53953,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -55386,6 +55410,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -55876,6 +55901,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -57541,6 +57567,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -57761,6 +57788,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -58950,6 +58978,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -59349,6 +59378,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -60389,6 +60419,7 @@ client.tax_retentions.list(params: { "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -60579,6 +60610,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -63839,6 +63871,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -65796,6 +65829,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -70491,6 +70525,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -70966,6 +71001,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. @@ -73736,6 +73772,7 @@ client.connect() "type": "optional", }, "page_size": { + "default": 100, "docs": "Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). @@ -75200,6 +75237,7 @@ service: docs: A page number within the paginated result set. page_size: type: optional + default: 100 docs: > Indicates how many results to return per page. By default we return 100 results per page. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/deel.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/deel.json index b647ec7ea96..4544f367eac 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/deel.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/deel.json @@ -11871,6 +11871,7 @@ service: }, }, "offset": { + "default": 0, "docs": "Return a page of results with given number of records.", "type": "optional", }, @@ -11908,6 +11909,7 @@ service: query-parameters: offset: type: optional + default: 0 docs: Return a page of results with given number of records. limit: type: optional @@ -16532,6 +16534,7 @@ docs: API end-points related to HRIS data. "type": "optional", }, "limit": { + "default": 10, "docs": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", "validation": { @@ -16543,6 +16546,7 @@ docs: API end-points related to HRIS data. }, }, "offset": { + "default": 0, "docs": "Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", }, @@ -16677,6 +16681,7 @@ docs: API end-points related to HRIS data. "type": "optional", }, "limit": { + "default": 10, "docs": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", "validation": { @@ -16688,6 +16693,7 @@ docs: API end-points related to HRIS data. }, }, "offset": { + "default": 0, "docs": "Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", }, @@ -16840,6 +16846,7 @@ service: (excludes records submitted on this date) limit: type: optional + default: 10 docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings @@ -16848,6 +16855,7 @@ service: max: 99 offset: type: optional + default: 0 docs: >- Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings @@ -16959,6 +16967,7 @@ service: (excludes records submitted on this date) limit: type: optional + default: 10 docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings @@ -16967,6 +16976,7 @@ service: max: 99 offset: type: optional + default: 0 docs: >- Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings @@ -17385,6 +17395,7 @@ docs: >- "type": "optional", }, "limit": { + "default": 99, "docs": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", }, @@ -17436,6 +17447,7 @@ docs: >- "name": "GetSeniorityListRequest", "query-parameters": { "limit": { + "default": 50, "docs": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", }, @@ -17574,6 +17586,7 @@ service: query-parameters: limit: type: optional + default: 99 docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings @@ -17616,6 +17629,7 @@ service: query-parameters: limit: type: optional + default: 50 docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings @@ -21263,10 +21277,12 @@ docs: Manage time off requests. "type": "optional", }, "limit": { + "default": 99, "docs": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", }, "offset": { + "default": 0, "docs": "Return a page of results after given index of row", "type": "optional", }, @@ -21386,10 +21402,12 @@ docs: Manage time off requests. "type": "optional", }, "limit": { + "default": 99, "docs": "Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings", "type": "optional", }, "offset": { + "default": 0, "docs": "Return a page of results after given index of row", "type": "optional", }, @@ -21529,11 +21547,13 @@ service: date. limit: type: optional + default: 99 docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings offset: type: optional + default: 0 docs: Return a page of results after given index of row response: docs: Successful operation. @@ -21630,11 +21650,13 @@ service: date. limit: type: optional + default: 99 docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings offset: type: optional + default: 0 docs: Return a page of results after given index of row response: docs: Successful operation. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/flexport.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/flexport.json index 590decba284..6b9e4ad10a3 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/flexport.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/flexport.json @@ -8559,6 +8559,7 @@ errors: "name": "BookingsIndexRequest", "query-parameters": { "direction": { + "default": "desc", "docs": "Set sort order. Allows "asc"(ascending) or "desc" (descending).", "type": "optional", }, @@ -8625,6 +8626,7 @@ errors: "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -8636,6 +8638,7 @@ errors: }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", "validation": { @@ -9572,11 +9575,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). @@ -9588,6 +9593,7 @@ service: docs: Sort results by the specified field. direction: type: optional + default: desc docs: Set sort order. Allows "asc"(ascending) or "desc" (descending). f.status: type: optional @@ -11147,6 +11153,7 @@ docs: >- "name": "BookingLineItemIndexRequest", "query-parameters": { "direction": { + "default": "desc", "docs": "Set sort order. Allows "asc" (ascending) or "desc" (descending)", "type": "optional", }, @@ -11163,6 +11170,7 @@ docs: >- "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -11174,6 +11182,7 @@ docs: >- }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -11381,11 +11390,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -11394,6 +11405,7 @@ service: max: 100 direction: type: optional + default: desc docs: Set sort order. Allows "asc" (ascending) or "desc" (descending) f.purchase_order.id: type: optional @@ -12293,6 +12305,7 @@ docs: Endpoints relating to Carbon Calculations "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -12304,6 +12317,7 @@ docs: Endpoints relating to Carbon Calculations }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -12775,11 +12789,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -13509,6 +13525,7 @@ docs: Endpoints relating to Commercial Invoice objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -13520,6 +13537,7 @@ docs: Endpoints relating to Commercial Invoice objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -13976,11 +13994,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -14421,6 +14441,7 @@ docs: Endpoints relating to Company objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -14432,6 +14453,7 @@ docs: Endpoints relating to Company objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -14838,11 +14860,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -15251,6 +15275,7 @@ docs: Endpoints relating to CompanyEntity objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -15262,6 +15287,7 @@ docs: Endpoints relating to CompanyEntity objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -15556,11 +15582,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -15900,6 +15928,7 @@ docs: Endpoints relating to Contact objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -15911,6 +15940,7 @@ docs: Endpoints relating to Contact objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", "validation": { @@ -16129,11 +16159,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). @@ -16399,6 +16431,7 @@ docs: Endpoints relating to Container objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -16410,6 +16443,7 @@ docs: Endpoints relating to Container objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", "validation": { @@ -16580,11 +16614,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). @@ -16749,6 +16785,7 @@ docs: Endpoints relating to ContainerLeg objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -16760,6 +16797,7 @@ docs: Endpoints relating to ContainerLeg objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -16924,11 +16962,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -17179,6 +17219,7 @@ docs: Endpoints relating to Customs Entry objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -17190,6 +17231,7 @@ docs: Endpoints relating to Customs Entry objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -17382,11 +17424,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -18332,6 +18376,7 @@ Other details about this invoice", "name": "InvoiceIndexRequest", "query-parameters": { "direction": { + "default": "desc", "docs": "Set sort order. Allows "asc"(ascending) or "desc" (descending).", "type": "optional", }, @@ -18388,6 +18433,7 @@ This parameter is mutually exclusive with the f.shipment.id filter. "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -18816,6 +18862,7 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 @@ -18832,6 +18879,7 @@ service: docs: Sort results by the specified field. direction: type: optional + default: desc docs: Set sort order. Allows "asc"(ascending) or "desc" (descending). f.status: type: optional @@ -19399,6 +19447,7 @@ docs: Endpoints relating to Invoice objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -19410,6 +19459,7 @@ docs: Endpoints relating to Invoice objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -19844,11 +19894,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -20260,6 +20312,7 @@ docs: Endpoints relating to Location objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -20271,6 +20324,7 @@ docs: Endpoints relating to Location objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -20383,11 +20437,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -21842,6 +21898,7 @@ docs: Endpoints relating to Product objects "name": "PurchaseOrderIndexRequest", "query-parameters": { "direction": { + "default": "asc", "docs": "Set sort order. Allows "asc"(ascending) or "desc" (descending)", "type": "optional", }, @@ -21891,6 +21948,7 @@ docs: Endpoints relating to Product objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -21902,6 +21960,7 @@ docs: Endpoints relating to Product objects }, }, "per": { + "default": 20, "docs": "Count of items in each page Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -22470,11 +22529,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page Should be between 1 and 100 (inclusive) @@ -22488,6 +22549,7 @@ service: this time) direction: type: optional + default: asc docs: Set sort order. Allows "asc"(ascending) or "desc" (descending) f.archived_at.exists: type: optional @@ -23369,6 +23431,7 @@ docs: >- "name": "PurchaseOrderLineItemIndexRequest", "query-parameters": { "direction": { + "default": "desc", "docs": "Set sort order. Allows "asc"(ascending) or "desc" (descending)", "type": "optional", }, @@ -23389,6 +23452,7 @@ docs: >- "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -23400,6 +23464,7 @@ docs: >- }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", "validation": { @@ -23670,11 +23735,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) @@ -23683,6 +23750,7 @@ service: max: 100 direction: type: optional + default: desc docs: Set sort order. Allows "asc"(ascending) or "desc" (descending) f.purchase_order.id: type: optional @@ -24229,6 +24297,7 @@ docs: >- "name": "ShipmentIndexRequest", "query-parameters": { "direction": { + "default": "desc", "docs": "Set sort order. Allows "asc" (ascending) or "desc" (descending).", "type": "optional", }, @@ -24364,6 +24433,7 @@ docs: >- }, }, "sort": { + "default": "id", "docs": "Sort results by the specified field.", "type": "optional", }, @@ -25315,9 +25385,11 @@ service: max: 100 sort: type: optional + default: id docs: Sort results by the specified field. direction: type: optional + default: desc docs: Set sort order. Allows "asc" (ascending) or "desc" (descending). f.transportation_mode: type: optional @@ -26408,6 +26480,7 @@ docs: Endpoints relating to Shipment objects "name": "ShipmentLegIndexRequest", "query-parameters": { "f.include_deleted": { + "default": false, "docs": "Returns legs including deleted legs", "type": "optional", }, @@ -26420,6 +26493,7 @@ docs: Endpoints relating to Shipment objects "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the page to retrieve", "type": "optional", "validation": { @@ -26431,6 +26505,7 @@ docs: Endpoints relating to Shipment objects }, }, "per": { + "default": 20, "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", "validation": { @@ -26614,6 +26689,7 @@ docs: Endpoints relating to Shipment objects "name": "ShipmentLegShowRequest", "query-parameters": { "f.include_deleted": { + "default": false, "docs": "Retrieves the leg even if it was deleted", "type": "optional", }, @@ -26721,11 +26797,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the page to retrieve validation: min: 1 per: type: optional + default: 20 docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). @@ -26740,6 +26818,7 @@ service: docs: Only return legs that match the given transportation mode f.include_deleted: type: optional + default: false docs: Returns legs including deleted legs response: docs: Success @@ -26878,6 +26957,7 @@ service: query-parameters: f.include_deleted: type: optional + default: false docs: Retrieves the leg even if it was deleted response: docs: Success diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/humanloop.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/humanloop.json index 368be829217..32aa1009928 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/humanloop.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/humanloop.json @@ -6603,6 +6603,7 @@ By default the deployed version of the Dataset is returned. Use the query parame "type": "optional", }, "include_datapoints": { + "default": false, "docs": "If set to `true`, include all Datapoints in the response. Defaults to `false`. Consider using the paginated List Datapoints endpoint instead.", "type": "optional", }, @@ -6683,6 +6684,7 @@ By default the deployed version of the Dataset is returned. Use the query parame "type": "optional", }, "page": { + "default": 1, "docs": "Page offset for pagination.", "type": "optional", "validation": { @@ -6694,6 +6696,7 @@ By default the deployed version of the Dataset is returned. Use the query parame }, }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Datasets to fetch.", "type": "optional", "validation": { @@ -6776,6 +6779,7 @@ By default the deployed version of the Dataset is returned. Use the query parame "type": "optional", }, "page": { + "default": 1, "docs": "Page number for pagination.", "type": "optional", "validation": { @@ -6787,6 +6791,7 @@ By default the deployed version of the Dataset is returned. Use the query parame }, }, "size": { + "default": 50, "docs": "Page size for pagination. Number of Datapoints to fetch.", "type": "optional", "validation": { @@ -7004,11 +7009,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page offset for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Datasets to fetch. validation: min: 0 @@ -7225,6 +7232,7 @@ service: docs: An environment tag to retrieve a deployed Version from. include_datapoints: type: optional + default: false docs: >- If set to `true`, include all Datapoints in the response. Defaults to `false`. Consider using the paginated List Datapoints endpoint @@ -7362,11 +7370,13 @@ service: docs: An environment tag to retrieve a deployed Version from. page: type: optional + default: 1 docs: Page number for pagination. validation: min: 1 size: type: optional + default: 50 docs: Page size for pagination. Number of Datapoints to fetch. validation: min: 0 @@ -8102,6 +8112,7 @@ Retrieve a list of Evaluations that evaluate versions of the specified File.", "type": "string", }, "page": { + "default": 1, "docs": "Page number for pagination.", "type": "optional", "validation": { @@ -8113,6 +8124,7 @@ Retrieve a list of Evaluations that evaluate versions of the specified File.", }, }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Evaluations to fetch.", "type": "optional", "validation": { @@ -8455,11 +8467,13 @@ service: File will be returned. page: type: optional + default: 1 docs: Page number for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Evaluations to fetch. validation: min: 0 @@ -9752,6 +9766,7 @@ By default the deployed version of the Evaluator is returned. Use the query para "type": "optional", }, "page": { + "default": 1, "docs": "Page offset for pagination.", "type": "optional", "validation": { @@ -9763,6 +9778,7 @@ By default the deployed version of the Evaluator is returned. Use the query para }, }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Evaluators to fetch.", "type": "optional", }, @@ -10090,11 +10106,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page offset for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Evaluators to fetch. name: type: optional @@ -11136,6 +11154,7 @@ You can manually create Logs through the API. "type": "optional", }, "page": { + "default": 1, "docs": "Page number for pagination.", "type": "optional", "validation": { @@ -11151,6 +11170,7 @@ You can manually create Logs through the API. "type": "optional", }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Logs to fetch.", "type": "optional", "validation": { @@ -11211,11 +11231,13 @@ service: docs: Unique identifier for the File to list Logs for. page: type: optional + default: 1 docs: Page number for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Logs to fetch. validation: min: 0 @@ -12426,6 +12448,7 @@ By default the deployed version of the Prompt is returned. Use the query paramet "type": "optional", }, "page": { + "default": 1, "docs": "Page number for pagination.", "type": "optional", "validation": { @@ -12437,6 +12460,7 @@ By default the deployed version of the Prompt is returned. Use the query paramet }, }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Prompts to fetch.", "type": "optional", "validation": { @@ -13096,11 +13120,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Prompts to fetch. validation: min: 0 @@ -14628,6 +14654,7 @@ Log is in, nested within the evaluated Log. "type": "optional", }, "page": { + "default": 1, "docs": "Page number for pagination.", "type": "optional", "validation": { @@ -14639,6 +14666,7 @@ Log is in, nested within the evaluated Log. }, }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Sessions to fetch.", "type": "optional", "validation": { @@ -14787,11 +14815,13 @@ service: that contain any Logs associated to this Version will be returned. page: type: optional + default: 1 docs: Page number for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Sessions to fetch. validation: min: 0 @@ -15357,6 +15387,7 @@ By default the deployed version of the Tool is returned. Use the query parameter "type": "optional", }, "page": { + "default": 1, "docs": "Page offset for pagination.", "type": "optional", "validation": { @@ -15368,6 +15399,7 @@ By default the deployed version of the Tool is returned. Use the query parameter }, }, "size": { + "default": 10, "docs": "Page size for pagination. Number of Tools to fetch.", "type": "optional", }, @@ -15874,11 +15906,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page offset for pagination. validation: min: 1 size: type: optional + default: 10 docs: Page size for pagination. Number of Tools to fetch. name: type: optional diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hume.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hume.json index 525c50ba481..b93e4cabadc 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hume.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hume.json @@ -107,6 +107,7 @@ "type": "optional", }, "limit": { + "default": 50, "docs": "The maximum number of jobs to include in the response.", "type": "optional", }, @@ -1332,6 +1333,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive query-parameters: limit: type: optional + default: 50 docs: The maximum number of jobs to include in the response. status: type: optional diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/intercom.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/intercom.json index d8df318af39..eb07ae9162e 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/intercom.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/intercom.json @@ -24266,6 +24266,7 @@ You can optionally request the result page size and the cursor to start after to "name": "ListConversationsRequest", "query-parameters": { "per_page": { + "default": 20, "docs": "How many results per page", "type": "optional", "validation": { @@ -26730,6 +26731,7 @@ service: query-parameters: per_page: type: optional + default: 20 docs: How many results per page validation: max: 150 diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ntropy.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ntropy.json index eca84e8fbf6..f900172c4e3 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ntropy.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ntropy.json @@ -4225,6 +4225,7 @@ ah = sdk.account_holders.get("f35b927b6-6fda-40aa-93b8-95b47c2b2cad") ", "type": "optional", }, "limit": { + "default": 10, "docs": "The limit of account holders to be returned", "type": "optional", "validation": { @@ -4356,6 +4357,7 @@ service: docs: Starting point for the set of account holders limit: type: optional + default: 10 docs: The limit of account holders to be returned validation: min: 1 @@ -4841,6 +4843,7 @@ for bs in sdk.bank_statements.list().auto_paginate(): "type": "optional", }, "limit": { + "default": 10, "docs": "The limit of bank statements to be returned", "type": "optional", "validation": { @@ -4978,6 +4981,7 @@ service: docs: Starting point for the set of bank statements limit: type: optional + default: 10 docs: The limit of bank statements to be returned validation: min: 1 @@ -5493,6 +5497,7 @@ for batch in sdk.batches.list().auto_paginate(): "type": "optional", }, "limit": { + "default": 10, "docs": "The limit of batches to be returned", "type": "optional", "validation": { @@ -5730,6 +5735,7 @@ service: docs: Starting point for the set of batches limit: type: optional + default: 10 docs: The limit of batches to be returned validation: min: 1 @@ -7806,6 +7812,7 @@ reports = sdk.reports.list() "type": "optional", }, "limit": { + "default": 10, "docs": "The limit of report to be returned", "type": "optional", "validation": { @@ -7971,6 +7978,7 @@ service: docs: Starting point for the set of report limit: type: optional + default: 10 docs: The limit of report to be returned validation: min: 1 @@ -8457,6 +8465,7 @@ for tx in sdk.transactions.list().auto_paginate(): "type": "optional", }, "limit": { + "default": 25, "docs": "The limit of transactions to be returned", "type": "optional", "validation": { @@ -8925,6 +8934,7 @@ service: docs: Starting point for the set of transactions limit: type: optional + default: 25 docs: The limit of transactions to be returned validation: min: 1 diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json index 2b7438636ca..5abbe50f7f9 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json @@ -23751,6 +23751,7 @@ You can optionally request the result page size and the cursor to start after to "name": "ListConversationsRequest", "query-parameters": { "per_page": { + "default": 20, "docs": "How many results per page", "type": "optional", "validation": { @@ -26215,6 +26216,7 @@ service: query-parameters: per_page: type: optional + default: 20 docs: How many results per page validation: max: 150 diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/permit.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/permit.json index 51cebc15e77..c29240f33dd 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/permit.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/permit.json @@ -5165,6 +5165,7 @@ If the permission is already granted, it is skipped.", "name": "ListSetPermissionsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -5176,6 +5177,7 @@ If the permission is already granted, it is skipped.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -5341,11 +5343,13 @@ service: permission is granted on this resource set page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -6024,6 +6028,7 @@ This includes any permissions granted to said condition set (i.e: any matching c "name": "GetConditionSetAncestorsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -6035,6 +6040,7 @@ This includes any permissions granted to said condition set (i.e: any matching c }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -6168,6 +6174,7 @@ This includes any permissions granted to said condition set (i.e: any matching c "name": "GetConditionSetDescendantsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -6179,6 +6186,7 @@ This includes any permissions granted to said condition set (i.e: any matching c }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -6306,10 +6314,12 @@ This includes any permissions granted to said condition set (i.e: any matching c "name": "ListConditionSetsRequest", "query-parameters": { "include_total_count": { + "default": false, "docs": "Include total count in response", "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -6321,6 +6331,7 @@ This includes any permissions granted to said condition set (i.e: any matching c }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -6585,14 +6596,17 @@ service: type. e.g: only user sets. include_total_count: type: optional + default: false docs: Include total count in response page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -7069,11 +7083,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -7173,11 +7189,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -7618,6 +7636,7 @@ allowed.", "name": "ListEnvironmentsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -7629,6 +7648,7 @@ allowed.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -8009,11 +8029,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -8590,6 +8612,7 @@ authenticated actor (i.e: human team member or api key).", "name": "ListOrganizationsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -8601,6 +8624,7 @@ authenticated actor (i.e: human team member or api key).", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -8718,11 +8742,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -9165,6 +9191,7 @@ Every project is a separate silo, and has its own unique set of environments and "name": "ListProjectsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -9176,6 +9203,7 @@ Every project is a separate silo, and has its own unique set of environments and }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -9302,11 +9330,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -9813,6 +9843,7 @@ This includes any permissions granted to perform the action.", "name": "ListResourceActionGroupsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -9824,6 +9855,7 @@ This includes any permissions granted to perform the action.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -9980,11 +10012,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -10572,6 +10606,7 @@ This includes any permissions granted to perform the action.", "name": "ListResourceActionsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -10583,6 +10618,7 @@ This includes any permissions granted to perform the action.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -10735,11 +10771,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -11169,6 +11207,7 @@ attribute to evaluate as `undefined`.", "name": "DeleteResourceAttributeRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -11180,6 +11219,7 @@ attribute to evaluate as `undefined`.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -11313,6 +11353,7 @@ attribute to evaluate as `undefined`.", "name": "ListResourceAttributesRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -11324,6 +11365,7 @@ attribute to evaluate as `undefined`.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -11457,11 +11499,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -11642,11 +11686,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -12012,6 +12058,7 @@ and will return the existing instance object in the response body.", "name": "ListResourceInstancesRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -12023,6 +12070,7 @@ and will return the existing instance object in the response body.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -12161,11 +12209,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -12983,6 +13033,7 @@ This includes any permissions granted to said role.", "name": "ListResourceRolesRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -12994,6 +13045,7 @@ This includes any permissions granted to said role.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -13244,11 +13296,13 @@ service: query-parameters: page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -14259,14 +14313,17 @@ A resource may also contain: "name": "ListResourcesRequest", "query-parameters": { "include_built_in": { + "default": false, "docs": "Whether to include or exclude built-in resources, default is False", "type": "optional", }, "include_total_count": { + "default": false, "docs": "Include total count in response", "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -14278,6 +14335,7 @@ A resource may also contain: }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -14654,17 +14712,21 @@ service: docs: Text search for the resources name or key include_built_in: type: optional + default: false docs: Whether to include or exclude built-in resources, default is False include_total_count: type: optional + default: false docs: Include total count in response page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -15475,6 +15537,7 @@ The tenant defines the scope of the assignment. In other words, the role is effe "name": "ListRoleAssignmentsRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -15486,6 +15549,7 @@ The tenant defines the scope of the assignment. In other words, the role is effe }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -15627,11 +15691,13 @@ service: in that tenant. page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -16344,10 +16410,12 @@ This includes any permissions granted to said role.", "name": "ListRolesRequest", "query-parameters": { "include_total_count": { + "default": false, "docs": "Include total count in response", "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -16359,6 +16427,7 @@ This includes any permissions granted to said role.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -16624,14 +16693,17 @@ service: docs: Text search for the roles name or key include_total_count: type: optional + default: false docs: Include total count in response page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -17502,6 +17574,7 @@ and will return the existing tenant object in the response body.", "name": "ListTenantUsersRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -17513,6 +17586,7 @@ and will return the existing tenant object in the response body.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -17599,10 +17673,12 @@ and will return the existing tenant object in the response body.", "name": "ListTenantsRequest", "query-parameters": { "include_total_count": { + "default": false, "docs": "Include total count in response", "type": "optional", }, "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -17614,6 +17690,7 @@ and will return the existing tenant object in the response body.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -17787,11 +17864,13 @@ service: docs: Match users with a specific role page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -17866,14 +17945,17 @@ service: docs: Text search for the tenant name or key include_total_count: type: optional + default: false docs: Include total count in response page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -18317,6 +18399,7 @@ attribute to evaluate as `undefined`.", "name": "DeleteUserAttributeRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -18328,6 +18411,7 @@ attribute to evaluate as `undefined`.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -18458,6 +18542,7 @@ attribute to evaluate as `undefined`.", "name": "ListUserAttributesRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -18469,6 +18554,7 @@ attribute to evaluate as `undefined`.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -18598,11 +18684,13 @@ service: resource_id: optional page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -18771,11 +18859,13 @@ service: resource_id: optional page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 @@ -19287,6 +19377,7 @@ and will return the existing user object in the response body.", "name": "ListUsersRequest", "query-parameters": { "page": { + "default": 1, "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", "validation": { @@ -19298,6 +19389,7 @@ and will return the existing user object in the response body.", }, }, "per_page": { + "default": 30, "docs": "The number of results per page (max 100).", "type": "optional", "validation": { @@ -19661,11 +19753,13 @@ service: docs: Match users with a specific role page: type: optional + default: 1 docs: Page number of the results to fetch, starting at 1. validation: min: 1 per_page: type: optional + default: 30 docs: The number of results per page (max 100). validation: min: 1 diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/squidex.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/squidex.json index 6336c86a9ef..35b77c8fdef 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/squidex.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/squidex.json @@ -14680,6 +14680,7 @@ service: "name": "BackupsGetBackupContentV2Request", "query-parameters": { "app": { + "default": "", "docs": "The name of the app.", "type": "optional", }, @@ -14944,6 +14945,7 @@ service: docs: The ID of the app. app: type: optional + default: '' docs: The name of the app. response: docs: Backup found and content returned. @@ -15169,6 +15171,7 @@ service: "name": "CommentsGetCommentsRequest", "query-parameters": { "version": { + "default": -2, "docs": "The current version.", "type": "optional", }, @@ -15381,6 +15384,7 @@ service: query-parameters: version: type: optional + default: -2 docs: The current version. response: docs: Comments returned. @@ -16167,6 +16171,7 @@ service: "name": "ContentsGetContentRequest", "query-parameters": { "version": { + "default": -2, "docs": "The optional version.", "type": "optional", }, @@ -17911,6 +17916,7 @@ service: query-parameters: version: type: optional + default: -2 docs: The optional version. response: docs: Content returned. @@ -19866,6 +19872,7 @@ service: "name": "NewsGetNewsRequest", "query-parameters": { "version": { + "default": 0, "docs": "The latest received version.", "type": "optional", }, @@ -19903,6 +19910,7 @@ service: query-parameters: version: type: optional + default: 0 docs: The latest received version. response: docs: Latest features returned. @@ -20017,6 +20025,7 @@ service: "name": "NotificationsGetNotificationsRequest", "query-parameters": { "version": { + "default": -2, "docs": "The current version.", "type": "optional", }, @@ -20059,6 +20068,7 @@ service: query-parameters: version: type: optional + default: -2 docs: The current version. response: docs: All comments returned. @@ -21116,10 +21126,12 @@ service: "type": "optional", }, "skip": { + "default": 0, "docs": "The number of events to skip.", "type": "optional", }, "take": { + "default": 20, "docs": "The number of events to take.", "type": "optional", }, @@ -21468,6 +21480,7 @@ service: "name": "RulesPutRuleRunRequest", "query-parameters": { "fromSnapshots": { + "default": false, "docs": "Runs the rule from snapeshots if possible.", "type": "optional", }, @@ -22086,6 +22099,7 @@ service: query-parameters: fromSnapshots: type: optional + default: false docs: Runs the rule from snapeshots if possible. errors: - root.BadRequestError @@ -22236,9 +22250,11 @@ service: docs: The optional rule id to filter to events. skip: type: optional + default: 0 docs: The number of events to skip. take: type: optional + default: 20 docs: The number of events to take. response: docs: Rule events returned. @@ -32315,10 +32331,12 @@ service: "type": "optional", }, "skip": { + "default": 0, "docs": "The number of users to skip.", "type": "optional", }, "take": { + "default": 10, "docs": "The number of users to return.", "type": "optional", }, @@ -32654,9 +32672,11 @@ service: docs: Optional query to search by email address or username. skip: type: optional + default: 0 docs: The number of users to skip. take: type: optional + default: 10 docs: The number of users to return. response: docs: Users returned. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/switchboard.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/switchboard.json index 70b100ebd8c..503d311fa24 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/switchboard.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/switchboard.json @@ -2196,10 +2196,12 @@ service: "name": "SessionsListRequest", "query-parameters": { "limit": { + "default": 0, "docs": "limit for pagination", "type": "optional", }, "offset": { + "default": -1, "docs": "offset for pagination", "type": "optional", }, @@ -2485,9 +2487,11 @@ service: docs: status of the session to get offset: type: optional + default: -1 docs: offset for pagination limit: type: optional + default: 0 docs: limit for pagination response: docs: OK diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/valtown.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/valtown.json index 7ba3f68a848..10c8e8ee6f2 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/valtown.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/valtown.json @@ -2065,6 +2065,7 @@ give access to details and data from the requesting user.", "name": "MeCommentsRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -2076,6 +2077,7 @@ give access to details and data from the requesting user.", }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -2087,6 +2089,7 @@ give access to details and data from the requesting user.", }, }, "relationship": { + "default": "any", "docs": "Whether to get comments you have received, given, or both", "type": "MeCommentsRequestRelationship", }, @@ -2189,6 +2192,7 @@ give access to details and data from the requesting user.", "name": "MeLikesRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -2200,6 +2204,7 @@ give access to details and data from the requesting user.", }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -2260,6 +2265,7 @@ give access to details and data from the requesting user.", "name": "MeReferencesRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -2271,6 +2277,7 @@ give access to details and data from the requesting user.", }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -2898,11 +2905,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 @@ -2949,11 +2958,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 @@ -2966,6 +2977,7 @@ service: docs: Include items created before this date relationship: type: MeCommentsRequestRelationship + default: any docs: Whether to get comments you have received, given, or both response: docs: A paginated result set @@ -3004,11 +3016,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 @@ -3112,6 +3126,7 @@ imports: "name": "SearchValsRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -3123,6 +3138,7 @@ imports: }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -3198,11 +3214,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 @@ -3769,6 +3787,7 @@ docs: SQLite "name": "UsersValsRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -3780,6 +3799,7 @@ docs: SQLite }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -3867,11 +3887,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 @@ -4454,6 +4476,7 @@ let you get, create, and run vals.", "name": "ValsGetVersionRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -4465,6 +4488,7 @@ let you get, create, and run vals.", }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -4528,6 +4552,7 @@ let you get, create, and run vals.", "name": "ValsListRequest", "query-parameters": { "limit": { + "default": 20, "docs": "Maximum items to return in each paginated response", "type": "integer", "validation": { @@ -4539,6 +4564,7 @@ let you get, create, and run vals.", }, }, "offset": { + "default": 0, "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", "validation": { @@ -5391,11 +5417,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 @@ -5516,11 +5544,13 @@ service: query-parameters: offset: type: integer + default: 0 docs: Number of items to skip in order to deliver paginated results validation: min: 0 limit: type: integer + default: 20 docs: Maximum items to return in each paginated response validation: min: 1 diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildQueryParameter.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildQueryParameter.ts index 26eaf22881f..1eb69827f02 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildQueryParameter.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildQueryParameter.ts @@ -6,7 +6,7 @@ import { RawSchemas } from "@fern-api/fern-definition-schema"; import { buildTypeReference } from "./buildTypeReference"; import { OpenApiIrConverterContext } from "./OpenApiIrConverterContext"; import { convertAvailability } from "./utils/convertAvailability"; -import { getTypeFromTypeReference } from "./utils/getTypeFromTypeReference"; +import { getTypeFromTypeReference, getDefaultFromTypeReference } from "./utils/getTypeFromTypeReference"; export function buildQueryParameter({ queryParameter, @@ -30,6 +30,7 @@ export function buildQueryParameter({ } let queryParameterType = getTypeFromTypeReference(typeReference.value); + const queryParameterDefault = getDefaultFromTypeReference(typeReference.value); // we can assume unknown-typed query parameteters are strings by default if (queryParameterType === "unknown") { @@ -51,6 +52,10 @@ export function buildQueryParameter({ type: queryParameterType }; + if (queryParameterDefault != null) { + queryParameterSchema.default = queryParameterDefault; + } + if (typeReference.allowMultiple) { queryParameterSchema["allow-multiple"] = true; } diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml index 208a33453bb..fa91410da94 100644 --- a/packages/cli/cli/versions.yml +++ b/packages/cli/cli/versions.yml @@ -1,3 +1,10 @@ +- changelogEntry: + - summary: | + The generated Fern Definition now properly supports default values for query parameters. + type: fix + irVersion: 53 + version: 0.46.7 + - changelogEntry: - summary: | The audiences property on WebSocket channels is now respected when filtering diff --git a/packages/cli/ete-tests/src/tests/write-definition/__snapshots__/writeDefinition.test.ts.snap b/packages/cli/ete-tests/src/tests/write-definition/__snapshots__/writeDefinition.test.ts.snap index de34cee5810..c7bd230b810 100644 --- a/packages/cli/ete-tests/src/tests/write-definition/__snapshots__/writeDefinition.test.ts.snap +++ b/packages/cli/ete-tests/src/tests/write-definition/__snapshots__/writeDefinition.test.ts.snap @@ -486,25 +486,31 @@ channel: type: string query-parameters: auctions: + default: true docs: Include auction events type: optional bids: + default: true docs: Include bids in change events type: optional heartbeat: + default: false docs: >- Optionally add this parameter and set to true to receive a heartbeat every 5 seconds type: optional offers: + default: true docs: Include asks in change events type: optional top_of_book: + default: false docs: >- If absent or false, receive full order book depth; if present and true, receive top of book only. Only applies to bids and offers. type: optional trades: + default: true docs: Include trade events type: optional ", @@ -1470,6 +1476,7 @@ service: name: GetTripsRequest query-parameters: bicycles: + default: false docs: Only return trips where bicycles are known to be allowed type: optional date: @@ -1483,6 +1490,7 @@ service: validation: format: uuid dogs: + default: false docs: Only return trips where dogs are known to be allowed type: optional origin: diff --git a/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/stream/__package__.yml b/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/stream/__package__.yml index b088d509de7..44cf48220df 100644 --- a/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/stream/__package__.yml +++ b/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/stream/__package__.yml @@ -128,24 +128,30 @@ channel: type: string query-parameters: auctions: + default: true docs: Include auction events type: optional bids: + default: true docs: Include bids in change events type: optional heartbeat: + default: false docs: >- Optionally add this parameter and set to true to receive a heartbeat every 5 seconds type: optional offers: + default: true docs: Include asks in change events type: optional top_of_book: + default: false docs: >- If absent or false, receive full order book depth; if present and true, receive top of book only. Only applies to bids and offers. type: optional trades: + default: true docs: Include trade events type: optional diff --git a/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/trains/trips.yml b/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/trains/trips.yml index 47be0e1f0fb..e563045ec3e 100644 --- a/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/trains/trips.yml +++ b/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/trains/trips.yml @@ -74,6 +74,7 @@ service: name: GetTripsRequest query-parameters: bicycles: + default: false docs: Only return trips where bicycles are known to be allowed type: optional date: @@ -87,6 +88,7 @@ service: validation: format: uuid dogs: + default: false docs: Only return trips where dogs are known to be allowed type: optional origin: