From d69b2f22b16a6b1739a00e539ed035628808ac5e Mon Sep 17 00:00:00 2001 From: eden wang <64514273+eyw520@users.noreply.github.com> Date: Mon, 18 Nov 2024 12:01:58 -0500 Subject: [PATCH] fix(cli): support piping query parameter validation into fern definition generation & fix file typo. (#5172) * Feed validation information from typeReference schema into queryParameterSchema. * typo: FernDefnitionBuilder -> FernDefinitionBuilder * Add to changelog. * Fix nit & update ete test snapshot. * chore: update changelog * Update test snapshot. * Update snapshot. * Update test snapshot. * Update snapshot. * Update test snapshot. * Update test snapshots. --------- Co-authored-by: fern-bot --- ...ionBuilder.ts => FernDefinitionBuilder.ts} | 0 .../cli/api-importers/commons/src/index.ts | 2 +- .../__snapshots__/openapi-docs/ada.json | 10 + .../__snapshots__/openapi-docs/apiture.json | 178 ++++++ .../__snapshots__/openapi-docs/aries.json | 566 ++++++++++++++++++ .../__snapshots__/openapi-docs/assembly.json | 8 + .../__snapshots__/openapi-docs/belvo.json | 334 +++++++++++ .../__snapshots__/openapi-docs/deel.json | 40 ++ .../__snapshots__/openapi-docs/flexport.json | 323 ++++++++++ .../__snapshots__/openapi-docs/hookdeck.json | 337 +++++++++++ .../__snapshots__/openapi-docs/humanloop.json | 126 ++++ .../__snapshots__/openapi-docs/intercom.json | 9 + .../__snapshots__/openapi-docs/merge.json | 16 + .../only-include-referenced-schemas.json | 9 + .../__snapshots__/openapi-docs/permit.json | 399 ++++++++++++ .../openapi-docs/rightbrain.json | 62 ++ .../openapi-docs/uploadcare.json | 16 + .../__snapshots__/openapi-docs/valtown.json | 142 +++++ .../__snapshots__/openapi-docs/vellum.json | 8 + .../__test__/__snapshots__/openapi/ada.json | 10 + .../__snapshots__/openapi/apiture.json | 178 ++++++ .../__test__/__snapshots__/openapi/aries.json | 566 ++++++++++++++++++ .../__snapshots__/openapi/assembly.json | 8 + .../__test__/__snapshots__/openapi/belvo.json | 334 +++++++++++ .../__test__/__snapshots__/openapi/deel.json | 40 ++ .../__snapshots__/openapi/flexport.json | 323 ++++++++++ .../__snapshots__/openapi/hookdeck.json | 337 +++++++++++ .../__snapshots__/openapi/humanloop.json | 126 ++++ .../__snapshots__/openapi/intercom.json | 9 + .../__test__/__snapshots__/openapi/merge.json | 16 + .../only-include-referenced-schemas.json | 9 + .../__snapshots__/openapi/permit.json | 399 ++++++++++++ .../__snapshots__/openapi/rightbrain.json | 62 ++ .../__snapshots__/openapi/uploadcare.json | 16 + .../__snapshots__/openapi/valtown.json | 142 +++++ .../__snapshots__/openapi/vellum.json | 8 + .../src/buildQueryParameter.ts | 12 + .../__snapshots__/update-api.test.ts.snap | 20 +- .../__snapshots__/update-api.test.ts.snap | 20 +- .../writeDefinition.test.ts.snap | 10 + .../fern/.definition/pets.yml | 2 + .../fern/.definition/neopets/pets.yml | 2 + .../fern/.definition/trains/trips.yml | 4 + .../petstore/fern/.definition/pets.yml | 2 + 44 files changed, 5229 insertions(+), 11 deletions(-) rename packages/cli/api-importers/commons/src/{FernDefnitionBuilder.ts => FernDefinitionBuilder.ts} (100%) diff --git a/packages/cli/api-importers/commons/src/FernDefnitionBuilder.ts b/packages/cli/api-importers/commons/src/FernDefinitionBuilder.ts similarity index 100% rename from packages/cli/api-importers/commons/src/FernDefnitionBuilder.ts rename to packages/cli/api-importers/commons/src/FernDefinitionBuilder.ts diff --git a/packages/cli/api-importers/commons/src/index.ts b/packages/cli/api-importers/commons/src/index.ts index 1a2d852c5ed..c9fc36fec17 100644 --- a/packages/cli/api-importers/commons/src/index.ts +++ b/packages/cli/api-importers/commons/src/index.ts @@ -4,4 +4,4 @@ export { FernDefinitionBuilderImpl, type FernDefinition, type HttpServiceInfo -} from "./FernDefnitionBuilder"; +} from "./FernDefinitionBuilder"; diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ada.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ada.json index 93694e95ff2..bf145c9b59b 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ada.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ada.json @@ -561,6 +561,13 @@ types: "limit": { "docs": "The number of end user profile records to return", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -687,6 +694,9 @@ service: limit: type: optional docs: The number of end user profile records to return + validation: + min: 1 + max: 100 response: docs: OK type: root.EndUsers 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 c0cca8670c0..a7c4b44e38f 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 @@ -13366,6 +13366,13 @@ The response may be incomplete. Given a `Retry-After` response header, the clien "retryCount": { "docs": "When retrying the operation, pass the `retryCount` from the `incompleteAccountBalances` response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 10, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -13460,6 +13467,13 @@ The response may be incomplete. Given a `Retry-After` response header, the clien "limit": { "docs": "The maximum number of items to return in this paged response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 0, + "multipleOf": undefined, + }, }, "location": { "docs": "Filter accounts to just a subset of `internal` or `external` accounts (per the `location` property on the [`accountItem`](#schema-accountItem) schema).", @@ -13473,6 +13487,12 @@ The response may be incomplete. Given a `Retry-After` response header, the clien "start": { "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": { + "format": undefined, + "maxLength": 256, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -13514,6 +13534,13 @@ Optionally, an agent can access a business customer's ACH accounts when acting o "limit": { "docs": "The maximum number of items to return in this paged response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 0, + "multipleOf": undefined, + }, }, "secCode": { "docs": "Filter the result to accounts that allow ACH transfers of the given Standard Entry Class (SEC) codes.", @@ -13522,6 +13549,12 @@ Optionally, an agent can access a business customer's ACH accounts when acting o "start": { "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": { + "format": undefined, + "maxLength": 256, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -13607,9 +13640,14 @@ service: beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`. + validation: + maxLength: 256 limit: type: optional docs: The maximum number of items to return in this paged response. + validation: + min: 0 + max: 1000 response: docs: >- OK. A page from the full list of the customer's accounts. This list @@ -13754,6 +13792,9 @@ service: docs: >- When retrying the operation, pass the `retryCount` from the `incompleteAccountBalances` response. + validation: + min: 1 + max: 10 response: docs: >- OK. The response contains the balances for all the accounts in the @@ -13831,9 +13872,14 @@ service: beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`. + validation: + maxLength: 256 limit: type: optional docs: The maximum number of items to return in this paged response. + validation: + min: 0 + max: 1000 response: docs: >- OK. A page from the full list of the customer's ACH-eligible accounts. @@ -14087,6 +14133,12 @@ This information provides hints to clients, allowing bank customers to select tr "endsOn": { "docs": "The end of the range of dates to include in the response. in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. The default is at least one year from the `startOn` date and is limited to a four year interval.", "type": "optional", + "validation": { + "format": "date", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "risk": { "docs": "The primary account's risk level. This determines what business rules and adjustments to make to the date restrictions. This parameter only applies to ACH credit transfers (funds credited to an external account) and is ignored for others.", @@ -14095,6 +14147,12 @@ This information provides hints to clients, allowing bank customers to select tr "startsOn": { "docs": "The start of the range of dates to include in the response, in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. While start dates far in the future are allowed, bank holiday schedules are only available for a small number of years ahead. The default is the current date.", "type": "optional", + "validation": { + "format": "date", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "type": { "docs": "Describes the type of transfer. This determines what business rules and adjustments to make to the date restrictions. Note ACH transfers (including CTX and PPD), that `Credit` and `Debit` here are relative to the account at the _external_ financial institution.", @@ -14179,6 +14237,13 @@ This information provides hints to clients, allowing bank customers to select tr "count": { "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": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 12, + "min": 1, + "multipleOf": undefined, + }, }, "direction": { "docs": "The direction of the transfer from the institution to the customer used for adjusting transfer dates due to banking holidays. For `debit`, dates are adjusted to the next business day. For `credit`, dates are adjusted to the previous business day.", @@ -14187,6 +14252,12 @@ This information provides hints to clients, allowing bank customers to select tr "endsOn": { "docs": "The date to use to conclude calculations of the transfer schedule in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format.", "type": "optional", + "validation": { + "format": "date", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "frequency": { "docs": "The interval at which the money movement recurs.", @@ -14195,6 +14266,12 @@ This information provides hints to clients, allowing bank customers to select tr "startsOn": { "docs": "The date to use to begin calculations of the transfer schedule in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format.", "type": "string", + "validation": { + "format": "date", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -14269,6 +14346,12 @@ This information provides hints to clients, allowing bank customers to select tr "countryCode": { "docs": "The country code in which to search for institutions. For the US, the `locatorType` must be `abaRoutingNumber`. For non-US countries, the `locatorType` must be `swiftBicCode` or `ibanAccountNumber`.", "type": "string", + "validation": { + "format": undefined, + "maxLength": 2, + "minLength": 2, + "pattern": undefined, + }, }, "includeIntermediaryInstitutions": { "docs": "If looking up a beneficiary institution for a wire transfer beneficiary institution, request the response also include a list of intermediary institutions.", @@ -14277,6 +14360,12 @@ This information provides hints to clients, allowing bank customers to select tr "locator": { "docs": "The financial institution lookup key (routing number, IBAN, or SWIFT/BIC), as indicated by the `locatorType` query parameter.", "type": "string", + "validation": { + "format": undefined, + "maxLength": 36, + "minLength": undefined, + "pattern": undefined, + }, }, "locatorType": { "docs": "Indicates what type of value the `locator` query parameter is.", @@ -14328,6 +14417,8 @@ service: docs: >- The financial institution lookup key (routing number, IBAN, or SWIFT/BIC), as indicated by the `locatorType` query parameter. + validation: + maxLength: 36 locatorType: type: root.InstitutionLocatorType docs: Indicates what type of value the `locator` query parameter is. @@ -14338,6 +14429,9 @@ service: the `locatorType` must be `abaRoutingNumber`. For non-US countries, the `locatorType` must be `swiftBicCode` or `ibanAccountNumber`. + validation: + minLength: 2 + maxLength: 2 includeIntermediaryInstitutions: type: optional docs: >- @@ -14406,12 +14500,16 @@ service: The date to use to begin calculations of the transfer schedule in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. + validation: + format: date endsOn: type: optional docs: >- The date to use to conclude calculations of the transfer schedule in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. + validation: + format: date direction: type: root.TransferScheduleDirection docs: >- @@ -14425,6 +14523,9 @@ service: 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. + validation: + min: 1 + max: 12 frequency: type: root.TransferFrequency docs: The interval at which the money movement recurs. @@ -14565,6 +14666,8 @@ service: format. While start dates far in the future are allowed, bank holiday schedules are only available for a small number of years ahead. The default is the current date. + validation: + format: date endsOn: type: optional docs: >- @@ -14572,6 +14675,8 @@ service: `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. The default is at least one year from the `startOn` date and is limited to a four year interval. + validation: + format: date type: type: optional docs: >- @@ -14939,10 +15044,23 @@ To obtain available balances for these accounts, use [`listAccountBalances`](#op "limit": { "docs": "The maximum number of items to return in this paged response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 0, + "multipleOf": undefined, + }, }, "start": { "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": { + "format": undefined, + "maxLength": 256, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -15063,9 +15181,14 @@ service: beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`. + validation: + maxLength: 256 limit: type: optional docs: The maximum number of items to return in this paged response. + validation: + min: 0 + max: 1000 response: docs: >- OK. A page from the full list of the customer's eligible overdraft @@ -15447,10 +15570,23 @@ The default response lists only recent transactions. Normally, this is transacti "limit": { "docs": "The maximum number of items to return in this paged response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 10000, + "min": 0, + "multipleOf": undefined, + }, }, "occurredOn": { "docs": "Return only transactions whose `occurredOn` date is in this date range. Dates ranges use dates expressed in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format. Each account has an implicit default transaction history range of _n_ days. This is normally 30 days but may be shorter for accounts with high activity. This _n_ day period is applied to any unbounded date ranges. The default date range is the most recent _n_ days. Example date ranges:
  • `2023-05-19` match transactions occurring on May 19, 2023.
  • `[2023-05-01,2023-05-31]` match transactions occurring between May 1 and 31, 2023, inclusive
  • `[2023-05-01,2023-06-01)` match transactions occurring in May, 2023 (on or after May 1, but before June 1)
  • `[2023-05-09,]` match transactions _n_ days on or after May 9, 2023
  • `(2023-05-09,)` match transactions _n_ days after May 9, 2023
  • `[,2023-05-09]` match transactions _n_ days on or before May 9, 2023
  • `(,2023-05-09)` match transactions _n_ days before but excluding May 9, 2023
", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^\d{4}-\d{2}-\d{2}|([[(](\d{4}-\d{2}-\d{2},(\d{4}-\d{2}-\d{2})?|,\d{4}-\d{2}-\d{2})[)\]])$", + }, }, "posted": { "docs": "Limit transactions in the response based on the transaction's `posted` value. If `true`, include only posted transactions. If `false`, include only non-posted transactions. If omitted, do not filter based on `posted`. Note that using this filter excludes balance transactions because the `posted` property is not set on balance transactions, so neither `true` or `false` match them.", @@ -15464,10 +15600,23 @@ The default response lists only recent transactions. Normally, this is transacti "retryCount": { "docs": "When retrying the operation, pass the `retryCount` from the `incompleteTransactions` response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 10, + "min": 1, + "multipleOf": undefined, + }, }, "start": { "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": { + "format": undefined, + "maxLength": 256, + "minLength": undefined, + "pattern": undefined, + }, }, "subtype": { "allow-multiple": true, @@ -15542,9 +15691,14 @@ service: beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`. + validation: + maxLength: 256 limit: type: optional docs: The maximum number of items to return in this paged response. + validation: + min: 0 + max: 10000 occurredOn: type: optional docs: >- @@ -15566,6 +15720,9 @@ service: match transactions _n_ days on or before May 9, 2023
  • `(,2023-05-09)` match transactions _n_ days before but excluding May 9, 2023
    • + validation: + pattern: >- + ^\d{4}-\d{2}-\d{2}|([[(](\d{4}-\d{2}-\d{2},(\d{4}-\d{2}-\d{2})?|,\d{4}-\d{2}-\d{2})[)\]])$ posted: type: optional docs: >- @@ -15649,6 +15806,9 @@ service: docs: >- When retrying the operation, pass the `retryCount` from the `incompleteTransactions` response. + validation: + min: 1 + max: 10 response: docs: OK. type: root.Transactions @@ -16043,6 +16203,13 @@ Note: This operation requires an identity challenge if the financial institution "limit": { "docs": "The maximum number of items to return in this paged response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 0, + "multipleOf": undefined, + }, }, "scheduledOn": { "docs": "Return only transactions whose `schedule.scheduledOn` date is in this date range. Excludes any transfers that do not have a `scheduledOn` date. Dates ranges use dates expressed in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format. Example date ranges:
    • `2022-05-19` match only transfers scheduled on May 19, 2022.
    • `[2022-05-01,2022-06-01)` in May, 2022: on or after May 1, but _before_ June 1
    • `(2022-05-01,2022-06-01)` in May, 2022 (on or after May 1, but before June 1)
    • `[2022-05-09,]` on or after May 9, 2022
    • `(2022-05-09,)` after May 9, 2022
    • `[,2022-05-09]` on or before May 9, 2022
    • `(,2022-05-09)` before May 9, 2022
    ", @@ -16051,6 +16218,12 @@ Note: This operation requires an identity challenge if the financial institution "start": { "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": { + "format": undefined, + "maxLength": 256, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -16242,9 +16415,14 @@ service: beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`. + validation: + maxLength: 256 limit: type: optional docs: The maximum number of items to return in this paged response. + validation: + min: 0 + max: 1000 response: docs: OK. type: root.Transfers 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 ab8027fac96..57ac850af35 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 @@ -11886,10 +11886,22 @@ docs: Simple messaging "mediation_id": { "docs": "Identifier for active mediation record to be used", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, "my_endpoint": { "docs": "My URL endpoint", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + }, }, "my_label": { "docs": "Label for connection", @@ -11955,6 +11967,12 @@ docs: Simple messaging "my_endpoint": { "docs": "My URL endpoint", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + }, }, }, }, @@ -12431,14 +12449,32 @@ docs: Simple messaging "invitation_key": { "docs": "invitation key", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + }, }, "invitation_msg_id": { "docs": "Identifier of the associated Invitation Mesage", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "my_did": { "docs": "My DID", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "state": { "docs": "Connection state", @@ -12447,10 +12483,22 @@ docs: Simple messaging "their_did": { "docs": "Their DID", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "their_public_did": { "docs": "Their Public DID", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "their_role": { "docs": "Their role in the connection protocol", @@ -12571,6 +12619,12 @@ docs: Simple messaging "mediation_id": { "docs": "Identifier for active mediation record to be used", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, }, }, @@ -12797,21 +12851,35 @@ service: invitation_key: type: optional docs: invitation key + validation: + pattern: >- + ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$ invitation_msg_id: type: optional docs: Identifier of the associated Invitation Mesage + validation: + format: uuid my_did: type: optional docs: My DID + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ state: type: optional docs: Connection state their_did: type: optional docs: Their DID + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ their_public_did: type: optional docs: Their Public DID + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ their_role: type: optional docs: Their role in the connection protocol @@ -13046,6 +13114,9 @@ service: mediation_id: type: optional docs: Identifier for active mediation record to be used + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} body: properties: '@id': @@ -13188,9 +13259,15 @@ service: mediation_id: type: optional docs: Identifier for active mediation record to be used + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} my_endpoint: type: optional docs: My URL endpoint + validation: + pattern: >- + ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ my_label: type: optional docs: Label for connection @@ -13239,6 +13316,9 @@ service: my_endpoint: type: optional docs: My URL endpoint + validation: + pattern: >- + ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ response: docs: '' type: root.ConnRecord @@ -13409,18 +13489,42 @@ docs: Connection management "cred_def_id": { "docs": "Credential definition id", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + }, }, "issuer_did": { "docs": "Issuer DID", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "schema_id": { "docs": "Schema identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + }, }, "schema_issuer_did": { "docs": "Schema issuer DID", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "schema_name": { "docs": "Schema name", @@ -13429,6 +13533,12 @@ docs: Connection management "schema_version": { "docs": "Schema version", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9.]+$", + }, }, }, }, @@ -13776,21 +13886,35 @@ service: cred_def_id: type: optional docs: Credential definition id + validation: + pattern: >- + ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ issuer_did: type: optional docs: Issuer DID + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ schema_id: type: optional docs: Schema identifier + validation: + pattern: >- + ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$ schema_issuer_did: type: optional docs: Schema issuer DID + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ schema_name: type: optional docs: Schema name schema_version: type: optional docs: Schema version + validation: + pattern: ^[0-9.]+$ response: docs: '' type: root.CredentialDefinitionsCreatedResult @@ -14090,14 +14214,32 @@ docs: Credential definition operations "count": { "docs": "Maximum number to retrieve", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[1-9][0-9]*$", + }, }, "start": { "docs": "Start index", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9]*$", + }, }, "wql": { "docs": "(JSON) WQL query", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^{.*}$", + }, }, }, }, @@ -14140,10 +14282,22 @@ docs: Credential definition operations "from": { "docs": "Earliest epoch of revocation status interval of interest", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9]*$", + }, }, "to": { "docs": "Latest epoch of revocation status interval of interest", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9]*$", + }, }, }, }, @@ -14359,14 +14513,32 @@ docs: Credential definition operations "count": { "docs": "Maximum number to retrieve", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[1-9][0-9]*$", + }, }, "start": { "docs": "Start index", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9]*$", + }, }, "wql": { "docs": "(JSON) WQL query", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^{.*}$", + }, }, }, }, @@ -14428,9 +14600,13 @@ service: from: type: optional docs: Earliest epoch of revocation status interval of interest + validation: + pattern: ^[0-9]*$ to: type: optional docs: Latest epoch of revocation status interval of interest + validation: + pattern: ^[0-9]*$ response: docs: '' type: root.CredRevokedResult @@ -14559,12 +14735,18 @@ service: count: type: optional docs: Maximum number to retrieve + validation: + pattern: ^[1-9][0-9]*$ start: type: optional docs: Start index + validation: + pattern: ^[0-9]*$ wql: type: optional docs: (JSON) WQL query + validation: + pattern: ^{.*}$ response: docs: '' type: root.CredInfoList @@ -14601,12 +14783,18 @@ service: count: type: optional docs: Maximum number to retrieve + validation: + pattern: ^[1-9][0-9]*$ start: type: optional docs: Start index + validation: + pattern: ^[0-9]*$ wql: type: optional docs: (JSON) WQL query + validation: + pattern: ^{.*}$ body: properties: contexts: @@ -14770,6 +14958,12 @@ docs: Holder credential management "my_endpoint": { "docs": "My URL endpoint", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + }, }, "my_label": { "docs": "Label for connection request", @@ -14835,10 +15029,22 @@ docs: Holder credential management "mediation_id": { "docs": "Identifier for active mediation record to be used", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, "my_endpoint": { "docs": "My URL endpoint", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + }, }, }, }, @@ -14898,10 +15104,22 @@ docs: Holder credential management "mediation_id": { "docs": "Identifier for active mediation record to be used", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, "my_endpoint": { "docs": "My URL endpoint", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + }, }, "my_label": { "docs": "Label for connection request", @@ -14910,6 +15128,12 @@ docs: Holder credential management "their_public_did": { "docs": "Qualified public DID to which to request connection", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$", + }, }, "use_public_did": { "docs": "Use public DID for this connection", @@ -15026,10 +15250,22 @@ docs: Holder credential management "mediation_id": { "docs": "Identifier for active mediation record to be used", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, "my_endpoint": { "docs": "My URL endpoint", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + }, }, }, }, @@ -15066,15 +15302,24 @@ service: their_public_did: type: string docs: Qualified public DID to which to request connection + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$ alias: type: optional docs: Alias for connection mediation_id: type: optional docs: Identifier for active mediation record to be used + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} my_endpoint: type: optional docs: My URL endpoint + validation: + pattern: >- + ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ my_label: type: optional docs: Label for connection request @@ -15128,9 +15373,15 @@ service: mediation_id: type: optional docs: Identifier for active mediation record to be used + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} my_endpoint: type: optional docs: My URL endpoint + validation: + pattern: >- + ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ body: properties: '@id': @@ -15212,6 +15463,9 @@ service: my_endpoint: type: optional docs: My URL endpoint + validation: + pattern: >- + ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ my_label: type: optional docs: Label for connection request @@ -15260,9 +15514,15 @@ service: mediation_id: type: optional docs: Identifier for active mediation record to be used + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} my_endpoint: type: optional docs: My URL endpoint + validation: + pattern: >- + ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ response: docs: '' type: root.ConnRecord @@ -17921,6 +18181,12 @@ docs: Introduction of known parties "connection_id": { "docs": "Connection identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "role": { "docs": "Role assigned in credential exchange", @@ -17933,6 +18199,12 @@ docs: Introduction of known parties "thread_id": { "docs": "Thread identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -19848,6 +20120,8 @@ service: connection_id: type: optional docs: Connection identifier + validation: + format: uuid role: type: optional docs: Role assigned in credential exchange @@ -19857,6 +20131,8 @@ service: thread_id: type: optional docs: Thread identifier + validation: + format: uuid response: docs: '' type: root.V10CredentialExchangeListResult @@ -22557,6 +22833,12 @@ types: "connection_id": { "docs": "Connection identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "role": { "docs": "Role assigned in credential exchange", @@ -22569,6 +22851,12 @@ types: "thread_id": { "docs": "Thread identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -25126,6 +25414,8 @@ service: connection_id: type: optional docs: Connection identifier + validation: + format: uuid role: type: optional docs: Role assigned in credential exchange @@ -25135,6 +25425,8 @@ service: thread_id: type: optional docs: Thread identifier + validation: + format: uuid response: docs: '' type: root.V20CredExRecordListResult @@ -27399,6 +27691,12 @@ docs: Sign and verify json-ld data "did": { "docs": "DID of interest", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, }, }, @@ -27435,6 +27733,12 @@ docs: Sign and verify json-ld data "did": { "docs": "DID of interest", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, }, }, @@ -27510,6 +27814,12 @@ docs: Sign and verify json-ld data "did": { "docs": "DID of interest", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "endpoint_type": { "docs": "Endpoint type of interest (default 'Endpoint')", @@ -27662,6 +27972,12 @@ docs: Sign and verify json-ld data "did": { "docs": "DID to register", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "role": { "docs": "Role", @@ -27670,6 +27986,12 @@ docs: Sign and verify json-ld data "verkey": { "docs": "Verification key", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + }, }, }, }, @@ -27771,6 +28093,9 @@ service: did: type: string docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ endpoint_type: type: optional docs: Endpoint type of interest (default 'Endpoint') @@ -27796,6 +28121,9 @@ service: did: type: string docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ response: docs: '' type: root.GetDIDVerkeyResponse @@ -27818,6 +28146,9 @@ service: did: type: string docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ response: docs: '' type: root.GetNymRoleResponse @@ -27878,9 +28209,15 @@ service: did: type: string docs: DID to register + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ verkey: type: string docs: Verification key + validation: + pattern: >- + ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$ alias: type: optional docs: Alias @@ -28263,6 +28600,12 @@ docs: Interaction with ledger "conn_id": { "docs": "Connection identifier (optional)", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "role": { "docs": "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent", @@ -28343,6 +28686,12 @@ docs: Interaction with ledger "conn_id": { "docs": "Connection identifier (optional)", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "mediator_terms": { "allow-multiple": true, @@ -28898,6 +29247,8 @@ service: conn_id: type: optional docs: Connection identifier (optional) + validation: + format: uuid role: type: optional docs: >- @@ -29071,6 +29422,8 @@ service: conn_id: type: optional docs: Connection identifier (optional) + validation: + format: uuid mediator_terms: type: optional allow-multiple: true @@ -30464,6 +30817,12 @@ docs: Multitenant wallet management "mediation_id": { "docs": "Identifier for active mediation record to be used", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, "use_existing_connection": { "docs": "Use an existing connection, if possible", @@ -30662,6 +31021,9 @@ service: mediation_id: type: optional docs: Identifier for active mediation record to be used + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} use_existing_connection: type: optional docs: Use an existing connection, if possible @@ -31334,6 +31696,12 @@ docs: Out-of-band connections "connection_id": { "docs": "Connection identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "role": { "docs": "Role assigned in presentation exchange", @@ -31346,6 +31714,12 @@ docs: Out-of-band connections "thread_id": { "docs": "Thread identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -31407,10 +31781,22 @@ docs: Out-of-band connections "count": { "docs": "Maximum number to retrieve", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[1-9][0-9]*$", + }, }, "extra_query": { "docs": "(JSON) object mapping referents to extra WQL queries", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^{\s*".*?"\s*:\s*{.*?}\s*(,\s*".*?"\s*:\s*{.*?}\s*)*\s*}$", + }, }, "referent": { "docs": "Proof request referents of interest, comma-separated", @@ -31419,6 +31805,12 @@ docs: Out-of-band connections "start": { "docs": "Start index", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9]*$", + }, }, }, }, @@ -32890,6 +33282,8 @@ service: connection_id: type: optional docs: Connection identifier + validation: + format: uuid role: type: optional docs: Role assigned in presentation exchange @@ -32899,6 +33293,8 @@ service: thread_id: type: optional docs: Thread identifier + validation: + format: uuid response: docs: '' type: root.V10PresentationExchangeList @@ -33223,15 +33619,21 @@ service: count: type: optional docs: Maximum number to retrieve + validation: + pattern: ^[1-9][0-9]*$ extra_query: type: optional docs: (JSON) object mapping referents to extra WQL queries + validation: + pattern: ^{\s*".*?"\s*:\s*{.*?}\s*(,\s*".*?"\s*:\s*{.*?}\s*)*\s*}$ referent: type: optional docs: Proof request referents of interest, comma-separated start: type: optional docs: Start index + validation: + pattern: ^[0-9]*$ response: docs: '' type: list @@ -34501,6 +34903,12 @@ types: "connection_id": { "docs": "Connection identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "role": { "docs": "Role assigned in presentation exchange", @@ -34513,6 +34921,12 @@ types: "thread_id": { "docs": "Thread identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -34574,10 +34988,22 @@ types: "count": { "docs": "Maximum number to retrieve", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[1-9][0-9]*$", + }, }, "extra_query": { "docs": "(JSON) object mapping referents to extra WQL queries", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^{\s*".*?"\s*:\s*{.*?}\s*(,\s*".*?"\s*:\s*{.*?}\s*)*\s*}$", + }, }, "referent": { "docs": "Proof request referents of interest, comma-separated", @@ -34586,6 +35012,12 @@ types: "start": { "docs": "Start index", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9]*$", + }, }, }, }, @@ -35933,6 +36365,8 @@ service: connection_id: type: optional docs: Connection identifier + validation: + format: uuid role: type: optional docs: Role assigned in presentation exchange @@ -35942,6 +36376,8 @@ service: thread_id: type: optional docs: Thread identifier + validation: + format: uuid response: docs: '' type: root.V20PresExRecordList @@ -36255,15 +36691,21 @@ service: count: type: optional docs: Maximum number to retrieve + validation: + pattern: ^[1-9][0-9]*$ extra_query: type: optional docs: (JSON) object mapping referents to extra WQL queries + validation: + pattern: ^{\s*".*?"\s*:\s*{.*?}\s*(,\s*".*?"\s*:\s*{.*?}\s*)*\s*}$ referent: type: optional docs: Proof request referents of interest, comma-separated start: type: optional docs: Start index + validation: + pattern: ^[0-9]*$ response: docs: '' type: list @@ -37262,10 +37704,22 @@ docs: did resolver interface. "cred_def_id": { "docs": "Credential definition identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + }, }, "rev_reg_id": { "docs": "Revocation registry identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + }, }, }, }, @@ -37414,6 +37868,12 @@ docs: did resolver interface. "cred_def_id": { "docs": "Credential definition identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + }, }, "state": { "docs": "Revocation registry state", @@ -37461,14 +37921,32 @@ docs: did resolver interface. "cred_ex_id": { "docs": "Credential exchange identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, "cred_rev_id": { "docs": "Credential revocation identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[1-9][0-9]*$", + }, }, "rev_reg_id": { "docs": "Revocation registry identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + }, }, }, }, @@ -38503,12 +38981,20 @@ service: cred_ex_id: type: optional docs: Credential exchange identifier + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} cred_rev_id: type: optional docs: Credential revocation identifier + validation: + pattern: ^[1-9][0-9]*$ rev_reg_id: type: optional docs: Revocation registry identifier + validation: + pattern: >- + ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) response: docs: '' type: root.CredRevRecordResult @@ -38590,6 +39076,9 @@ service: cred_def_id: type: optional docs: Credential definition identifier + validation: + pattern: >- + ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ state: type: optional docs: Revocation registry state @@ -38617,9 +39106,15 @@ service: cred_def_id: type: optional docs: Credential definition identifier + validation: + pattern: >- + ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ rev_reg_id: type: optional docs: Revocation registry identifier + validation: + pattern: >- + ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) response: docs: '' type: root.TailsDeleteResponse @@ -39245,10 +39740,22 @@ types: "schema_id": { "docs": "Schema identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + }, }, "schema_issuer_did": { "docs": "Schema issuer DID", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "schema_name": { "docs": "Schema name", @@ -39257,6 +39764,12 @@ types: "schema_version": { "docs": "Schema version", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9.]+$", + }, }, }, }, @@ -39571,15 +40084,23 @@ service: schema_id: type: optional docs: Schema identifier + validation: + pattern: >- + ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$ schema_issuer_did: type: optional docs: Schema issuer DID + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ schema_name: type: optional docs: Schema name schema_version: type: optional docs: Schema version + validation: + pattern: ^[0-9.]+$ response: docs: '' type: root.SchemasCreatedResult @@ -40150,6 +40671,12 @@ docs: Trust-ping over connection "did": { "docs": "DID of interest", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, }, }, @@ -40198,6 +40725,12 @@ docs: Trust-ping over connection "did": { "docs": "DID of interest", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$", + }, }, "key_type": { "docs": "Key type to query for.", @@ -40214,6 +40747,12 @@ docs: Trust-ping over connection "verkey": { "docs": "Verification key of interest", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + }, }, }, }, @@ -40280,6 +40819,12 @@ docs: Trust-ping over connection "did": { "docs": "DID of interest", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, }, }, @@ -40402,6 +40947,12 @@ docs: Trust-ping over connection "did": { "docs": "DID of interest", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "mediation_id": { "docs": "Mediation identifier", @@ -40513,6 +41064,9 @@ service: did: type: optional docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$ key_type: type: optional docs: Key type to query for. @@ -40527,6 +41081,9 @@ service: verkey: type: optional docs: Verification key of interest + validation: + pattern: >- + ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$ response: docs: '' type: root.DIDList @@ -40596,6 +41153,9 @@ service: did: type: string docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ response: docs: '' type: root.WalletModuleResponse @@ -40637,6 +41197,9 @@ service: did: type: string docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ conn_id: type: optional docs: Connection identifier @@ -40673,6 +41236,9 @@ service: did: type: string docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ response: docs: '' type: root.DIDEndpoint 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 3dd916178db..9ec9d6991dd 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 @@ -6502,6 +6502,12 @@ docs: Real-time transcription "created_on": { "docs": "Only get transcripts created on this date", "type": "optional", + "validation": { + "format": "date", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": { "docs": "Maximum amount of transcripts to retrieve", @@ -6639,6 +6645,8 @@ service: created_on: type: optional docs: Only get transcripts created on this date + validation: + format: date before_id: type: optional docs: Get transcripts that were created before this transcript ID 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 af149dd7234..9d3bf0b1214 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 @@ -30272,6 +30272,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return accounts only for these `link.id`s.", @@ -30307,6 +30313,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "public_identification_name": { "docs": "Return information only for this type of account ID. For example, CLABE accounts.", @@ -32373,6 +32386,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -32395,6 +32411,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid balance__available: type: optional docs: >- @@ -35966,6 +35984,12 @@ client.connect() ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "account__in": { "docs": "Return balances only for these `account.id`s.", @@ -36037,6 +36061,12 @@ client.connect() ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return balances only for these `link.id`s.", @@ -36056,6 +36086,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "value_date": { "docs": "Return balances for exactly this date (`YYYY-MM-DD` or full ISO-8601 timestamp).", @@ -36597,6 +36634,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -36619,6 +36659,8 @@ service: ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. + validation: + format: uuid account: type: optional docs: > @@ -36627,6 +36669,8 @@ service: ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. + validation: + format: uuid account__in: type: optional docs: Return balances only for these `account.id`s. @@ -39994,6 +40038,13 @@ At the moment, the employment records resource is available for: ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -40167,6 +40218,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -41232,6 +41286,12 @@ client.connect() ℹ️ We highly recommend adding the `account.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "account__in": { "docs": "Return incomes for these `account.id`s.", @@ -41266,6 +41326,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -41710,6 +41777,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -41732,6 +41802,8 @@ service: ℹ️ We highly recommend adding the `account.id` filter in order to improve your performance. + validation: + format: uuid account__in: type: optional docs: Return incomes for these `account.id`s. @@ -42905,6 +42977,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "resources__allin": { "docs": "Return institutions that support these resources.", @@ -42978,6 +43057,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -43793,6 +43875,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": "optional", "omit": { @@ -43809,6 +43897,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -44200,6 +44295,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -44222,6 +44320,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid created_at__gt: optional created_at__gte: optional created_at__lt: optional @@ -47271,6 +47371,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return invoices only for these `link.id`s.", @@ -47290,6 +47396,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "status": { "docs": "Return invoices with this status. Can be either `Vigente` (valid) or `Cancelado` (cancelled).", @@ -48783,6 +48896,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -48805,6 +48921,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid created_at__gt: type: optional docs: >- @@ -52659,6 +52777,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "refresh_rate": { "docs": "Return links with this refresh rate. Choose between `6h`, `12h`, `24h`, `7d`, or `30d`.", @@ -53400,6 +53525,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -55174,6 +55302,13 @@ Cancun, COL 10447", ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -55540,6 +55675,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -58361,6 +58499,13 @@ types: ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "search": { "docs": "Return results for one or more payment links that match the description you searched for. @@ -58533,6 +58678,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 100 created_at: type: optional docs: Return results only for this date (in `YYYY-MM-DD` format). @@ -59832,6 +59980,12 @@ docs: >+ ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "account__in": { "docs": "Return receivable transactions only for these `account.id`s.", @@ -59867,6 +60021,12 @@ docs: >+ ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -59886,6 +60046,13 @@ docs: >+ ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "value_date": { "docs": "Return receivable transactions for exactly this date (`YYYY-MM-DD` or full ISO-8601 timestamp).", @@ -60088,6 +60255,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -60110,6 +60280,8 @@ service: ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. + validation: + format: uuid account: type: optional docs: > @@ -60118,6 +60290,8 @@ service: ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. + validation: + format: uuid account__in: type: optional docs: Return receivable transactions only for these `account.id`s. @@ -60930,6 +61104,12 @@ client.connect() ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "account_in": { "docs": "Return recurring expenses for these `accound.id`s.", @@ -60953,6 +61133,12 @@ client.connect() ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -60972,6 +61158,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -61454,6 +61647,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -61476,6 +61672,8 @@ service: ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. + validation: + format: uuid account: type: optional docs: > @@ -61484,6 +61682,8 @@ service: ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. + validation: + format: uuid account_in: type: optional docs: Return recurring expenses for these `accound.id`s. @@ -62875,6 +63075,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -62894,6 +63100,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -63380,6 +63593,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -63402,6 +63618,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid id: type: optional docs: Return information for this `risk-insight.id`. @@ -65012,6 +65230,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -65031,6 +65255,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -65246,6 +65477,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -65268,6 +65502,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid created_at__gt: type: optional docs: >- @@ -66402,6 +66638,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -66421,6 +66663,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "year": { "docs": "Return tax declarations for this year (`YYYY`).", @@ -66812,6 +67061,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -66834,6 +67086,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid link__in: type: optional docs: Return information for these `link.id`s. @@ -67819,6 +68073,12 @@ client.tax_retentions.list(params: { ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -67838,6 +68098,13 @@ client.tax_retentions.list(params: { ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -68023,6 +68290,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -68045,6 +68315,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid created_at__gt: type: optional docs: >- @@ -71255,6 +71527,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -71274,6 +71552,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "tipo_declaracion": { "docs": "Return tax returns with this declaration type.", @@ -73223,6 +73508,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -73245,6 +73533,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid created_at__gt: type: optional docs: >- @@ -77906,6 +78196,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -77925,6 +78221,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -78407,6 +78710,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -78429,6 +78735,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid created_at__gt: type: optional docs: >- @@ -81015,6 +81323,12 @@ client.connect() ℹ️ We highly recommend adding the `account.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "account__balance__available": { "docs": "Return transactions that have a `account.balance.available` matching exactly this value.", @@ -81186,6 +81500,12 @@ client.connect() ℹ️ We highly recommend adding the `account.id` filter as well in order to improve your performance. ", "type": "string", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "omit": { "docs": "Omit certain fields from being returned in the response. For more information, see our [Filtering responses](https://developers.belvo.com/docs/searching-and-filtering) DevPortal article.", @@ -81201,6 +81521,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "reference": { "docs": "Returns transactions with this institution-assigned reference number.", @@ -82677,6 +83004,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -82699,6 +83029,8 @@ service: ℹ️ We highly recommend adding the `account.id` filter as well in order to improve your performance. + validation: + format: uuid account: type: optional docs: > @@ -82707,6 +83039,8 @@ service: ℹ️ We highly recommend adding the `account.id` filter in order to improve your performance. + validation: + format: uuid account__balance__available: type: optional docs: >- 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 a8cba248b63..cdbf722cbf4 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 @@ -21064,6 +21064,13 @@ service: "limit": { "docs": "Return a page of results with given number of records.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 200, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Return a page of results with given number of records.", @@ -21107,6 +21114,9 @@ service: limit: type: optional docs: Return a page of results with given number of records. + validation: + min: 1 + max: 200 response: docs: Successful operation. type: root.PeopleContainer @@ -23792,6 +23802,13 @@ docs: The Contracts resource lets you create, amend and, retrieve Deel contracts "limit": { "docs": "Return a page of results with given number of records.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 10, + "min": 1, + "multipleOf": undefined, + }, }, "order_direction": { "docs": "Order direction of results; ascending or descending.", @@ -24151,6 +24168,9 @@ service: limit: type: optional docs: Return a page of results with given number of records. + validation: + min: 1 + max: 10 order_direction: type: optional docs: Order direction of results; ascending or descending. @@ -25697,6 +25717,13 @@ docs: API end-points related to HRIS data. "limit": { "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": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 99, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings", @@ -25835,6 +25862,13 @@ docs: API end-points related to HRIS data. "limit": { "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": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 99, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings", @@ -25991,6 +26025,9 @@ service: docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings + validation: + min: 1 + max: 99 offset: type: optional docs: >- @@ -26107,6 +26144,9 @@ service: docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings + validation: + min: 1 + max: 99 offset: type: optional docs: >- 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 fdfe5cc1cce..3a2bb694ed4 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 @@ -10535,10 +10535,24 @@ errors: "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "sort": { "docs": "Sort results by the specified field.", @@ -11514,11 +11528,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). + validation: + min: 1 + max: 100 sort: type: optional docs: Sort results by the specified field. @@ -13158,10 +13177,24 @@ docs: >- "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -13355,11 +13388,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 direction: type: optional docs: Set sort order. Allows "asc" (ascending) or "desc" (descending) @@ -14256,10 +14294,24 @@ docs: Endpoints relating to Carbon Calculations "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -14716,11 +14768,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.shipment.id: type: optional docs: The unique id for the shipment. @@ -15447,10 +15504,24 @@ docs: Endpoints relating to Commercial Invoice objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -15891,11 +15962,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.ref: type: optional docs: The ref for the company. @@ -16334,10 +16410,24 @@ docs: Endpoints relating to Company objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -16728,11 +16818,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.ref: type: optional docs: The ref for the company entity @@ -17139,10 +17234,24 @@ docs: Endpoints relating to CompanyEntity objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -17422,11 +17531,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.company_ref: type: optional docs: The ref for the company. @@ -17763,10 +17877,24 @@ docs: Endpoints relating to Contact objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -17973,11 +18101,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). + validation: + min: 1 + max: 100 f.shipment.id: type: optional docs: >- @@ -18239,10 +18372,24 @@ docs: Endpoints relating to Container objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -18401,11 +18548,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). + validation: + min: 1 + max: 100 f.leg.id: type: optional docs: >- @@ -18567,10 +18719,24 @@ docs: Endpoints relating to ContainerLeg objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -18723,11 +18889,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.shipment.id: type: optional docs: The unique id for the shipment. @@ -18976,10 +19147,24 @@ docs: Endpoints relating to Customs Entry objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -19161,11 +19346,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.shipment.id: type: optional docs: Filters the list for documents that belong to the given shipment @@ -20162,10 +20352,24 @@ This parameter is mutually exclusive with the f.shipment.id filter. "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "sort": { "docs": "Sort results by the specified field.", @@ -20569,11 +20773,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). + validation: + min: 1 + max: 100 sort: type: optional> docs: Sort results by the specified field. @@ -21150,10 +21359,24 @@ docs: Endpoints relating to Invoice objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -21573,11 +21796,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.ref: type: optional docs: The ref for the location. @@ -21987,10 +22215,24 @@ docs: Endpoints relating to Location objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -22091,11 +22333,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.port_type: type: optional docs: Filter by the type of port. Ports can have more than one type @@ -23598,10 +23845,24 @@ docs: Endpoints relating to Product objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "sort": { "docs": "Sort results by the specified field (only `id` is supported at this time)", @@ -24155,11 +24416,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 sort: type: optional> docs: >- @@ -25083,10 +25349,24 @@ docs: >- "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -25393,11 +25673,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 direction: type: optional docs: Set sort order. Allows "asc"(ascending) or "desc" (descending) @@ -26105,10 +26390,24 @@ docs: >- "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "sort": { "docs": "Sort results by the specified field.", @@ -27076,11 +27375,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). + validation: + min: 1 + max: 100 sort: type: optional docs: Sort results by the specified field. @@ -28222,10 +28526,24 @@ docs: Endpoints relating to Shipment objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -28535,11 +28853,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). + validation: + min: 1 + max: 100 f.shipment.id: type: optional docs: Only return legs for the shipment specified by this id. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hookdeck.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hookdeck.json index bca1e3e4ff8..8f5e82eca86 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hookdeck.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hookdeck.json @@ -7971,6 +7971,12 @@ types: "event_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "next": "optional", @@ -8033,6 +8039,8 @@ service: event_id: type: optional allow-multiple: true + validation: + maxLength: 255 order_by: optional dir: optional limit: optional @@ -8364,20 +8372,44 @@ docs: An attempt is any request that Hookdeck makes on behalf of an event. "event_data_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "label": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "last_used_at": "optional", "limit": "optional", "name": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 155, + "minLength": undefined, + "pattern": "^[A-z0-9-_]+$", + }, }, "next": "optional", "order_by": "optional", @@ -8385,6 +8417,12 @@ docs: An attempt is any request that Hookdeck makes on behalf of an event. "webhook_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -8639,18 +8677,29 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 name: type: optional allow-multiple: true + validation: + pattern: ^[A-z0-9-_]+$ + maxLength: 155 webhook_id: type: optional allow-multiple: true + validation: + maxLength: 255 event_data_id: type: optional allow-multiple: true + validation: + maxLength: 255 label: type: optional allow-multiple: true + validation: + maxLength: 255 last_used_at: optional order_by: optional dir: optional @@ -9140,6 +9189,12 @@ docs: A bookmark lets you conveniently store and replay a specific request. "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "in_progress": "optional", "limit": "optional", @@ -10164,6 +10219,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 query_partial_match: optional in_progress: optional order_by: optional @@ -10554,6 +10611,12 @@ docs: '' "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "in_progress": "optional", "limit": "optional", @@ -10774,6 +10837,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 query_partial_match: optional in_progress: optional order_by: optional @@ -11162,6 +11227,12 @@ docs: '' "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "in_progress": "optional", "limit": "optional", @@ -11926,6 +11997,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 in_progress: optional query_partial_match: optional order_by: optional @@ -12562,12 +12635,24 @@ docs: '' "destination_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "dir": "optional", "full_name": "optional", "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "name": "optional", @@ -12578,6 +12663,12 @@ docs: '' "source_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -13554,13 +13645,19 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 name: optional destination_id: type: optional allow-multiple: true + validation: + maxLength: 255 source_id: type: optional allow-multiple: true + validation: + maxLength: 255 archived: optional archived_at: optional full_name: optional @@ -14532,6 +14629,12 @@ docs: >- "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "name": "optional", @@ -14866,6 +14969,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 name: optional archived: optional archived_at: optional @@ -15305,6 +15410,12 @@ docs: A destination is any endpoint to which your webhooks can be routed. "bulk_retry_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "cli_id": "optional", "cli_user_id": { @@ -15315,25 +15426,55 @@ docs: A destination is any endpoint to which your webhooks can be routed. "destination_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "dir": "optional", "error_code": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "event_data_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "headers": "optional", "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "include": "optional>", "issue_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "last_attempt_at": "optional", "limit": "optional", @@ -15346,12 +15487,24 @@ docs: A destination is any endpoint to which your webhooks can be routed. "source_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "status": "optional", "successful_at": "optional", "webhook_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -15587,19 +15740,29 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 status: optional issue_id: type: optional allow-multiple: true + validation: + maxLength: 255 webhook_id: type: optional allow-multiple: true + validation: + maxLength: 255 destination_id: type: optional allow-multiple: true + validation: + maxLength: 255 source_id: type: optional allow-multiple: true + validation: + maxLength: 255 attempts: optional response_status: optional successful_at: optional @@ -15607,6 +15770,8 @@ service: error_code: type: optional allow-multiple: true + validation: + maxLength: 255 cli_id: optional cli_user_id: type: optional @@ -15615,12 +15780,16 @@ service: event_data_id: type: optional allow-multiple: true + validation: + maxLength: 255 headers: optional body: optional parsed_query: optional bulk_retry_id: type: optional allow-multiple: true + validation: + maxLength: 255 path: optional include: optional> order_by: optional @@ -17692,10 +17861,22 @@ docs: >- "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "issue_trigger_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "last_seen_at": "optional", "limit": "optional", @@ -17805,10 +17986,22 @@ docs: >- "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "issue_trigger_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "last_seen_at": "optional", "limit": "optional", @@ -18058,9 +18251,13 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 issue_trigger_id: type: optional allow-multiple: true + validation: + maxLength: 255 type: optional status: optional merged_with: @@ -18143,9 +18340,13 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 issue_trigger_id: type: optional allow-multiple: true + validation: + maxLength: 255 type: optional status: optional merged_with: @@ -18601,6 +18802,12 @@ docs: Notifications let your team receive alerts anytime an issue changes. "bulk_retry_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "cli_id": "optional", "cli_user_id": { @@ -18611,25 +18818,55 @@ docs: Notifications let your team receive alerts anytime an issue changes. "destination_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "dir": "optional", "error_code": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "event_data_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "headers": "optional", "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "include": "optional>", "issue_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "last_attempt_at": "optional", "limit": "optional", @@ -18642,12 +18879,24 @@ docs: Notifications let your team receive alerts anytime an issue changes. "source_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "status": "optional", "successful_at": "optional", "webhook_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -18712,6 +18961,12 @@ docs: Notifications let your team receive alerts anytime an issue changes. "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "next": "optional", @@ -18817,6 +19072,12 @@ docs: Notifications let your team receive alerts anytime an issue changes. "bulk_retry_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "created_at": "optional", "dir": "optional", @@ -18825,6 +19086,12 @@ docs: Notifications let your team receive alerts anytime an issue changes. "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "ignored_count": "optional", "include": "optional>", @@ -18839,6 +19106,12 @@ docs: Notifications let your team receive alerts anytime an issue changes. "source_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "status": "optional", "verified": "optional", @@ -19060,6 +19333,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 status: optional rejection_cause: optional ignored_count: optional @@ -19067,6 +19342,8 @@ service: source_id: type: optional allow-multiple: true + validation: + maxLength: 255 verified: optional headers: optional body: optional @@ -19077,6 +19354,8 @@ service: bulk_retry_id: type: optional allow-multiple: true + validation: + maxLength: 255 include: optional> order_by: optional dir: optional @@ -19278,19 +19557,29 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 status: optional issue_id: type: optional allow-multiple: true + validation: + maxLength: 255 webhook_id: type: optional allow-multiple: true + validation: + maxLength: 255 destination_id: type: optional allow-multiple: true + validation: + maxLength: 255 source_id: type: optional allow-multiple: true + validation: + maxLength: 255 attempts: optional response_status: optional successful_at: optional @@ -19298,6 +19587,8 @@ service: error_code: type: optional allow-multiple: true + validation: + maxLength: 255 cli_id: optional cli_user_id: type: optional @@ -19306,12 +19597,16 @@ service: event_data_id: type: optional allow-multiple: true + validation: + maxLength: 255 headers: optional body: optional parsed_query: optional bulk_retry_id: type: optional allow-multiple: true + validation: + maxLength: 255 path: optional include: optional> order_by: optional @@ -19375,6 +19670,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 order_by: optional dir: optional limit: optional @@ -19637,6 +19934,12 @@ docs: A request represent a webhook received by Hookdeck. "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "name": "optional", @@ -19890,6 +20193,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 name: optional archived: optional archived_at: optional @@ -20390,6 +20695,12 @@ docs: A ruleset defines a group of rules that can be used across many connection "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "integration_id": "optional", "limit": "optional", @@ -20643,6 +20954,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 name: optional archived: optional archived_at: optional @@ -21188,6 +21501,12 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "issue_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "log_level": "optional", @@ -21197,6 +21516,12 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "webhook_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -21254,6 +21579,12 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "name": "optional", @@ -21730,6 +22061,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 name: optional order_by: optional dir: optional @@ -22011,9 +22344,13 @@ service: webhook_id: type: optional allow-multiple: true + validation: + maxLength: 255 issue_id: type: optional allow-multiple: true + validation: + maxLength: 255 created_at: optional order_by: optional dir: optional 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 5f1793e25b7..ea63276cc26 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 @@ -7485,10 +7485,24 @@ By default the deployed version of the Dataset is returned. Use the query parame "page": { "docs": "Page offset for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Datasets to fetch.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "sort_by": { "docs": "Field to sort Datasets by", @@ -7564,10 +7578,24 @@ By default the deployed version of the Dataset is returned. Use the query parame "page": { "docs": "Page number for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Datapoints to fetch.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "version_id": { "docs": "A specific Version ID of the Dataset to retrieve.", @@ -7776,9 +7804,13 @@ service: page: type: optional docs: Page offset for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Datasets to fetch. + validation: + min: 0 name: type: optional docs: Case-insensitive filter for Dataset name. @@ -8130,9 +8162,13 @@ service: page: type: optional docs: Page number for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Datapoints to fetch. + validation: + min: 0 response: docs: Successful Response type: root.PaginatedDataDatapointResponse @@ -8868,10 +8904,24 @@ Retrieve a list of Evaluations that evaluate versions of the specified File.", "page": { "docs": "Page number for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Evaluations to fetch.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, }, }, @@ -9205,9 +9255,13 @@ service: page: type: optional docs: Page number for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Evaluations to fetch. + validation: + min: 0 response: docs: Successful Response type: root.PaginatedDataEvaluationResponse @@ -10497,6 +10551,13 @@ By default the deployed version of the Evaluator is returned. Use the query para "page": { "docs": "Page offset for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Evaluators to fetch.", @@ -10826,6 +10887,8 @@ service: page: type: optional docs: Page offset for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Evaluators to fetch. @@ -11872,6 +11935,13 @@ You can manually create Logs through the API. "page": { "docs": "Page number for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "search": { "docs": "If provided, only Logs that contain the provided string in its inputs and output will be returned.", @@ -11880,6 +11950,13 @@ You can manually create Logs through the API. "size": { "docs": "Page size for pagination. Number of Logs to fetch.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "start_date": { "docs": "If provided, only Logs created after the specified date will be returned.", @@ -11932,9 +12009,13 @@ service: page: type: optional docs: Page number for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Logs to fetch. + validation: + min: 0 version_id: type: optional docs: >- @@ -13142,10 +13223,24 @@ By default the deployed version of the Prompt is returned. Use the query paramet "page": { "docs": "Page number for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Prompts to fetch.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "sort_by": { "docs": "Field to sort Prompts by", @@ -13790,9 +13885,13 @@ service: page: type: optional docs: Page number for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Prompts to fetch. + validation: + min: 0 name: type: optional docs: Case-insensitive filter for Prompt name. @@ -15317,10 +15416,24 @@ Log is in, nested within the evaluated Log. "page": { "docs": "Page number for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Sessions to fetch.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "version_id": { "docs": "Unique identifier for Version to return Sessions for. Sessions that contain any Logs associated to this Version will be returned.", @@ -15461,9 +15574,13 @@ service: page: type: optional docs: Page number for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Sessions to fetch. + validation: + min: 0 response: docs: Successful Response type: root.PaginatedDataSessionResponse @@ -16027,6 +16144,13 @@ By default the deployed version of the Tool is returned. Use the query parameter "page": { "docs": "Page offset for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Tools to fetch.", @@ -16534,6 +16658,8 @@ service: page: type: optional docs: Page offset for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Tools to fetch. 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 1c760a22c7e..84317170678 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 @@ -26453,6 +26453,13 @@ You can optionally request the result page size and the cursor to start after to "per_page": { "docs": "How many results per page", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 150, + "min": undefined, + "multipleOf": undefined, + }, }, "starting_after": { "docs": "String used to get the next page of conversations.", @@ -30005,6 +30012,8 @@ service: per_page: type: optional docs: How many results per page + validation: + max: 150 starting_after: type: optional docs: String used to get the next page of conversations. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/merge.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/merge.json index 42c42f97b4e..ac78aea9b6e 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/merge.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/merge.json @@ -12070,6 +12070,12 @@ service: "personal_email": { "docs": "If provided, will only return Employees with this personal email", "type": "optional", + "validation": { + "format": "email", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "remote_fields": { "docs": "Deprecated. Use show_enum_origins.", @@ -12106,6 +12112,12 @@ service: "work_email": { "docs": "If provided, will only return Employees with this work email", "type": "optional", + "validation": { + "format": "email", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "work_location_id": { "docs": "If provided, will only return employees for this location.", @@ -15750,6 +15762,8 @@ service: personal_email: type: optional docs: If provided, will only return Employees with this personal email + validation: + format: email remote_fields: type: optional docs: Deprecated. Use show_enum_origins. @@ -15785,6 +15799,8 @@ service: work_email: type: optional docs: If provided, will only return Employees with this work email + validation: + format: email work_location_id: type: optional docs: If provided, will only return employees for this location. 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 236fbdfc267..bf027306997 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 @@ -25946,6 +25946,13 @@ You can optionally request the result page size and the cursor to start after to "per_page": { "docs": "How many results per page", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 150, + "min": undefined, + "multipleOf": undefined, + }, }, "starting_after": { "docs": "String used to get the next page of conversations.", @@ -29498,6 +29505,8 @@ service: per_page: type: optional docs: How many results per page + validation: + max: 150 starting_after: type: optional docs: String used to get the next page of conversations. 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 dd061517f2d..b77a3814703 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 @@ -6908,10 +6908,24 @@ If the permission is already granted, it is skipped.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "permission": { "docs": "optional permission filter, will only return condition set rules granting this permission", @@ -7068,9 +7082,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -7746,10 +7765,24 @@ This includes any permissions granted to said condition set (i.e: any matching c "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -7876,10 +7909,24 @@ This includes any permissions granted to said condition set (i.e: any matching c "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -8004,10 +8051,24 @@ This includes any permissions granted to said condition set (i.e: any matching c "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "search": { "docs": "Text search for the condition sets name or key", @@ -8265,9 +8326,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: ListConditionSetsResponse @@ -8741,9 +8807,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -8840,9 +8911,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -9280,10 +9356,24 @@ allowed.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -9654,9 +9744,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -10229,10 +10324,24 @@ authenticated actor (i.e: human team member or api key).", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -10341,9 +10450,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -10783,10 +10897,24 @@ Every project is a separate silo, and has its own unique set of environments and "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -10904,9 +11032,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -11410,10 +11543,24 @@ This includes any permissions granted to perform the action.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -11561,9 +11708,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -12148,10 +12300,24 @@ This includes any permissions granted to perform the action.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -12295,9 +12461,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -12725,10 +12896,24 @@ attribute to evaluate as `undefined`.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -12855,10 +13040,24 @@ attribute to evaluate as `undefined`.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -12984,9 +13183,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -13164,9 +13368,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 errors: - root.DeleteResourceAttributeRequestUnprocessableEntityError examples: @@ -13529,10 +13738,24 @@ and will return the existing instance object in the response body.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -13662,9 +13885,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -14479,10 +14707,24 @@ This includes any permissions granted to said role.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -14724,9 +14966,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -15742,10 +15989,24 @@ A resource may also contain: "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "search": { "docs": "Text search for the resources name or key", @@ -16117,9 +16378,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: ListResourcesResponse @@ -16928,10 +17194,24 @@ The tenant defines the scope of the assignment. In other words, the role is effe "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "role": { "docs": "optional role filter, will only return role assignments granting this role.", @@ -17065,9 +17345,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -17781,10 +18066,24 @@ This includes any permissions granted to said role.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "search": { "docs": "Text search for the roles name or key", @@ -18043,9 +18342,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: ListRolesResponse @@ -18914,10 +19218,24 @@ and will return the existing tenant object in the response body.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "role": { "docs": "Match users with a specific role", @@ -19001,10 +19319,24 @@ and will return the existing tenant object in the response body.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "search": { "docs": "Text search for the tenant name or key", @@ -19168,9 +19500,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: root.PaginatedResultUserRead @@ -19245,9 +19582,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: ListTenantsResponse @@ -19689,10 +20031,24 @@ attribute to evaluate as `undefined`.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "resource_id": "optional", }, @@ -19816,10 +20172,24 @@ attribute to evaluate as `undefined`.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "resource_id": "optional", }, @@ -19941,9 +20311,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -20109,9 +20484,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 errors: - root.DeleteUserAttributeRequestUnprocessableEntityError examples: @@ -20620,10 +21000,24 @@ and will return the existing user object in the response body.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "role": { "docs": "Match users with a specific role", @@ -20977,9 +21371,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: root.PaginatedResultUserRead diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/rightbrain.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/rightbrain.json index eddfcc146b6..27c27f17ddd 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/rightbrain.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/rightbrain.json @@ -31265,10 +31265,23 @@ service: "cursor": { "docs": "A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results.", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "page_limit": { "docs": "The maximum number of items to return per page. Defaults to `100` if not specified.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -31469,11 +31482,16 @@ service: docs: >- The maximum number of items to return per page. Defaults to `100` if not specified. + validation: + min: 1 + max: 100 cursor: type: optional docs: >- A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results. + validation: + format: uuid response: docs: Successful Response type: root.PaginatedResultSetTaskForwarder @@ -32093,6 +32111,12 @@ service: "cursor": { "docs": "A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results.", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "name": { "docs": "Filter tasks by name. Supports partial matches.", @@ -32101,6 +32125,13 @@ service: "page_limit": { "docs": "The maximum number of items to return per page. Defaults to `100` if not specified.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -32346,14 +32377,33 @@ service: "cursor": { "docs": "A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results.", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "page_limit": { "docs": "The maximum number of items to return per page. Defaults to `100` if not specified.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "task_revision_id": { "docs": "The specific Task Revision to reference.", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -32927,11 +32977,16 @@ service: docs: >- The maximum number of items to return per page. Defaults to `100` if not specified. + validation: + min: 1 + max: 100 cursor: type: optional docs: >- A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results. + validation: + format: uuid response: docs: Successful Response type: root.PaginatedResultSetTask @@ -33383,14 +33438,21 @@ service: docs: >- The maximum number of items to return per page. Defaults to `100` if not specified. + validation: + min: 1 + max: 100 cursor: type: optional docs: >- A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results. + validation: + format: uuid task_revision_id: type: optional docs: The specific Task Revision to reference. + validation: + format: uuid response: docs: Successful Response type: root.PaginatedResultSetTaskRun diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/uploadcare.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/uploadcare.json index d88cb97d6f4..0a87b4343f8 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/uploadcare.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/uploadcare.json @@ -4460,6 +4460,12 @@ Log.d("TAG", file.toString()) "file_id": { "docs": "File's unique ID.", "type": "string", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "pub_key": "root.ProjectPublicKeyType", }, @@ -5476,6 +5482,12 @@ Log.d("TAG", status.toString()) "token": { "docs": "Token returned by the `/from_url/` endpoint that identifies a request to fetch/upload a file from a URL.", "type": "string", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -7467,6 +7479,8 @@ service: docs: >- Token returned by the `/from_url/` endpoint that identifies a request to fetch/upload a file from a URL. + validation: + format: uuid response: docs: | Request was processed successfully. @@ -7998,6 +8012,8 @@ service: file_id: type: string docs: File's unique ID. + validation: + format: uuid response: docs: File information was retrieved successfully. type: root.FileUploadInfo 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 33c7611f3b4..65912287dc6 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 @@ -2075,10 +2075,24 @@ give access to details and data from the requesting user.", "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "relationship": { "docs": "Whether to get comments you have received, given, or both", @@ -2185,10 +2199,24 @@ give access to details and data from the requesting user.", "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, }, }, @@ -2242,10 +2270,24 @@ give access to details and data from the requesting user.", "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "since": { "docs": "Include items created after this date", @@ -2840,9 +2882,14 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 response: docs: A paginated result set type: MeLikesResponse @@ -2886,9 +2933,14 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 since: type: optional docs: Include items created after this date @@ -2936,9 +2988,14 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 since: type: optional docs: Include items created after this date @@ -3040,14 +3097,34 @@ imports: "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "query": { "docs": "Search query", "type": "string", + "validation": { + "format": undefined, + "maxLength": 512, + "minLength": 1, + "pattern": undefined, + }, }, }, }, @@ -3104,12 +3181,20 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 query: type: string docs: Search query + validation: + minLength: 1 + maxLength: 512 response: docs: A paginated result set type: SearchValsResponse @@ -3656,10 +3741,24 @@ docs: SQLite "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, }, }, @@ -3738,9 +3837,14 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 response: docs: A paginated result set type: UsersValsResponse @@ -4318,10 +4422,24 @@ let you get, create, and run vals.", "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, }, }, @@ -4378,10 +4496,24 @@ let you get, create, and run vals.", "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, }, }, @@ -5205,9 +5337,14 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 response: docs: A paginated result set type: ValsListResponse @@ -5325,9 +5462,14 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 response: docs: Default Response type: root.ExtendedVal diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/vellum.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/vellum.json index a321d734f1f..da6ff8ba893 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/vellum.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/vellum.json @@ -4960,6 +4960,12 @@ Used to list documents. Optionally filter on supported fields. "document_index_id": { "docs": "Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": { "docs": "Number of results to return per page.", @@ -5096,6 +5102,8 @@ service: Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation. + validation: + format: uuid limit: type: optional docs: Number of results to return per page. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ada.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ada.json index 7992d178ee8..f24f2d5ad51 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ada.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ada.json @@ -323,6 +323,13 @@ types: "limit": { "docs": "The number of end user profile records to return", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -449,6 +456,9 @@ service: limit: type: optional docs: The number of end user profile records to return + validation: + min: 1 + max: 100 response: docs: OK type: root.EndUsers 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 675062662bf..9097ed97c5f 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 @@ -5988,6 +5988,13 @@ The response may be incomplete. Given a `Retry-After` response header, the clien "retryCount": { "docs": "When retrying the operation, pass the `retryCount` from the `incompleteAccountBalances` response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 10, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -6082,6 +6089,13 @@ The response may be incomplete. Given a `Retry-After` response header, the clien "limit": { "docs": "The maximum number of items to return in this paged response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 0, + "multipleOf": undefined, + }, }, "location": { "docs": "Filter accounts to just a subset of `internal` or `external` accounts (per the `location` property on the [`accountItem`](#schema-accountItem) schema).", @@ -6095,6 +6109,12 @@ The response may be incomplete. Given a `Retry-After` response header, the clien "start": { "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": { + "format": undefined, + "maxLength": 256, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -6136,6 +6156,13 @@ Optionally, an agent can access a business customer's ACH accounts when acting o "limit": { "docs": "The maximum number of items to return in this paged response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 0, + "multipleOf": undefined, + }, }, "secCode": { "docs": "Filter the result to accounts that allow ACH transfers of the given Standard Entry Class (SEC) codes.", @@ -6144,6 +6171,12 @@ Optionally, an agent can access a business customer's ACH accounts when acting o "start": { "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": { + "format": undefined, + "maxLength": 256, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -6229,9 +6262,14 @@ service: beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`. + validation: + maxLength: 256 limit: type: optional docs: The maximum number of items to return in this paged response. + validation: + min: 0 + max: 1000 response: docs: >- OK. A page from the full list of the customer's accounts. This list @@ -6376,6 +6414,9 @@ service: docs: >- When retrying the operation, pass the `retryCount` from the `incompleteAccountBalances` response. + validation: + min: 1 + max: 10 response: docs: >- OK. The response contains the balances for all the accounts in the @@ -6453,9 +6494,14 @@ service: beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`. + validation: + maxLength: 256 limit: type: optional docs: The maximum number of items to return in this paged response. + validation: + min: 0 + max: 1000 response: docs: >- OK. A page from the full list of the customer's ACH-eligible accounts. @@ -6709,6 +6755,12 @@ This information provides hints to clients, allowing bank customers to select tr "endsOn": { "docs": "The end of the range of dates to include in the response. in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. The default is at least one year from the `startOn` date and is limited to a four year interval.", "type": "optional", + "validation": { + "format": "date", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "risk": { "docs": "The primary account's risk level. This determines what business rules and adjustments to make to the date restrictions. This parameter only applies to ACH credit transfers (funds credited to an external account) and is ignored for others.", @@ -6717,6 +6769,12 @@ This information provides hints to clients, allowing bank customers to select tr "startsOn": { "docs": "The start of the range of dates to include in the response, in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. While start dates far in the future are allowed, bank holiday schedules are only available for a small number of years ahead. The default is the current date.", "type": "optional", + "validation": { + "format": "date", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "type": { "docs": "Describes the type of transfer. This determines what business rules and adjustments to make to the date restrictions. Note ACH transfers (including CTX and PPD), that `Credit` and `Debit` here are relative to the account at the _external_ financial institution.", @@ -6801,6 +6859,13 @@ This information provides hints to clients, allowing bank customers to select tr "count": { "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": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 12, + "min": 1, + "multipleOf": undefined, + }, }, "direction": { "docs": "The direction of the transfer from the institution to the customer used for adjusting transfer dates due to banking holidays. For `debit`, dates are adjusted to the next business day. For `credit`, dates are adjusted to the previous business day.", @@ -6809,6 +6874,12 @@ This information provides hints to clients, allowing bank customers to select tr "endsOn": { "docs": "The date to use to conclude calculations of the transfer schedule in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format.", "type": "optional", + "validation": { + "format": "date", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "frequency": { "docs": "The interval at which the money movement recurs.", @@ -6817,6 +6888,12 @@ This information provides hints to clients, allowing bank customers to select tr "startsOn": { "docs": "The date to use to begin calculations of the transfer schedule in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format.", "type": "string", + "validation": { + "format": "date", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -6891,6 +6968,12 @@ This information provides hints to clients, allowing bank customers to select tr "countryCode": { "docs": "The country code in which to search for institutions. For the US, the `locatorType` must be `abaRoutingNumber`. For non-US countries, the `locatorType` must be `swiftBicCode` or `ibanAccountNumber`.", "type": "string", + "validation": { + "format": undefined, + "maxLength": 2, + "minLength": 2, + "pattern": undefined, + }, }, "includeIntermediaryInstitutions": { "docs": "If looking up a beneficiary institution for a wire transfer beneficiary institution, request the response also include a list of intermediary institutions.", @@ -6899,6 +6982,12 @@ This information provides hints to clients, allowing bank customers to select tr "locator": { "docs": "The financial institution lookup key (routing number, IBAN, or SWIFT/BIC), as indicated by the `locatorType` query parameter.", "type": "string", + "validation": { + "format": undefined, + "maxLength": 36, + "minLength": undefined, + "pattern": undefined, + }, }, "locatorType": { "docs": "Indicates what type of value the `locator` query parameter is.", @@ -6950,6 +7039,8 @@ service: docs: >- The financial institution lookup key (routing number, IBAN, or SWIFT/BIC), as indicated by the `locatorType` query parameter. + validation: + maxLength: 36 locatorType: type: root.InstitutionLocatorType docs: Indicates what type of value the `locator` query parameter is. @@ -6960,6 +7051,9 @@ service: the `locatorType` must be `abaRoutingNumber`. For non-US countries, the `locatorType` must be `swiftBicCode` or `ibanAccountNumber`. + validation: + minLength: 2 + maxLength: 2 includeIntermediaryInstitutions: type: optional docs: >- @@ -7027,12 +7121,16 @@ service: The date to use to begin calculations of the transfer schedule in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. + validation: + format: date endsOn: type: optional docs: >- The date to use to conclude calculations of the transfer schedule in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. + validation: + format: date direction: type: root.TransferScheduleDirection docs: >- @@ -7046,6 +7144,9 @@ service: 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. + validation: + min: 1 + max: 12 frequency: type: root.TransferFrequency docs: The interval at which the money movement recurs. @@ -7186,6 +7287,8 @@ service: format. While start dates far in the future are allowed, bank holiday schedules are only available for a small number of years ahead. The default is the current date. + validation: + format: date endsOn: type: optional docs: >- @@ -7193,6 +7296,8 @@ service: `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. The default is at least one year from the `startOn` date and is limited to a four year interval. + validation: + format: date type: type: optional docs: >- @@ -7558,10 +7663,23 @@ To obtain available balances for these accounts, use [`listAccountBalances`](#op "limit": { "docs": "The maximum number of items to return in this paged response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 0, + "multipleOf": undefined, + }, }, "start": { "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": { + "format": undefined, + "maxLength": 256, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -7682,9 +7800,14 @@ service: beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`. + validation: + maxLength: 256 limit: type: optional docs: The maximum number of items to return in this paged response. + validation: + min: 0 + max: 1000 response: docs: >- OK. A page from the full list of the customer's eligible overdraft @@ -8056,10 +8179,23 @@ The default response lists only recent transactions. Normally, this is transacti "limit": { "docs": "The maximum number of items to return in this paged response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 10000, + "min": 0, + "multipleOf": undefined, + }, }, "occurredOn": { "docs": "Return only transactions whose `occurredOn` date is in this date range. Dates ranges use dates expressed in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format. Each account has an implicit default transaction history range of _n_ days. This is normally 30 days but may be shorter for accounts with high activity. This _n_ day period is applied to any unbounded date ranges. The default date range is the most recent _n_ days. Example date ranges:
    • `2023-05-19` match transactions occurring on May 19, 2023.
    • `[2023-05-01,2023-05-31]` match transactions occurring between May 1 and 31, 2023, inclusive
    • `[2023-05-01,2023-06-01)` match transactions occurring in May, 2023 (on or after May 1, but before June 1)
    • `[2023-05-09,]` match transactions _n_ days on or after May 9, 2023
    • `(2023-05-09,)` match transactions _n_ days after May 9, 2023
    • `[,2023-05-09]` match transactions _n_ days on or before May 9, 2023
    • `(,2023-05-09)` match transactions _n_ days before but excluding May 9, 2023
    ", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^\d{4}-\d{2}-\d{2}|([[(](\d{4}-\d{2}-\d{2},(\d{4}-\d{2}-\d{2})?|,\d{4}-\d{2}-\d{2})[)\]])$", + }, }, "posted": { "docs": "Limit transactions in the response based on the transaction's `posted` value. If `true`, include only posted transactions. If `false`, include only non-posted transactions. If omitted, do not filter based on `posted`. Note that using this filter excludes balance transactions because the `posted` property is not set on balance transactions, so neither `true` or `false` match them.", @@ -8073,10 +8209,23 @@ The default response lists only recent transactions. Normally, this is transacti "retryCount": { "docs": "When retrying the operation, pass the `retryCount` from the `incompleteTransactions` response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 10, + "min": 1, + "multipleOf": undefined, + }, }, "start": { "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": { + "format": undefined, + "maxLength": 256, + "minLength": undefined, + "pattern": undefined, + }, }, "subtype": { "allow-multiple": true, @@ -8151,9 +8300,14 @@ service: beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`. + validation: + maxLength: 256 limit: type: optional docs: The maximum number of items to return in this paged response. + validation: + min: 0 + max: 10000 occurredOn: type: optional docs: >- @@ -8175,6 +8329,9 @@ service: match transactions _n_ days on or before May 9, 2023
  • `(,2023-05-09)` match transactions _n_ days before but excluding May 9, 2023
    • + validation: + pattern: >- + ^\d{4}-\d{2}-\d{2}|([[(](\d{4}-\d{2}-\d{2},(\d{4}-\d{2}-\d{2})?|,\d{4}-\d{2}-\d{2})[)\]])$ posted: type: optional docs: >- @@ -8258,6 +8415,9 @@ service: docs: >- When retrying the operation, pass the `retryCount` from the `incompleteTransactions` response. + validation: + min: 1 + max: 10 response: docs: OK. type: root.Transactions @@ -8652,6 +8812,13 @@ Note: This operation requires an identity challenge if the financial institution "limit": { "docs": "The maximum number of items to return in this paged response.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 0, + "multipleOf": undefined, + }, }, "scheduledOn": { "docs": "Return only transactions whose `schedule.scheduledOn` date is in this date range. Excludes any transfers that do not have a `scheduledOn` date. Dates ranges use dates expressed in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format. Example date ranges:
    • `2022-05-19` match only transfers scheduled on May 19, 2022.
    • `[2022-05-01,2022-06-01)` in May, 2022: on or after May 1, but _before_ June 1
    • `(2022-05-01,2022-06-01)` in May, 2022 (on or after May 1, but before June 1)
    • `[2022-05-09,]` on or after May 9, 2022
    • `(2022-05-09,)` after May 9, 2022
    • `[,2022-05-09]` on or before May 9, 2022
    • `(,2022-05-09)` before May 9, 2022
    ", @@ -8660,6 +8827,12 @@ Note: This operation requires an identity challenge if the financial institution "start": { "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": { + "format": undefined, + "maxLength": 256, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -8851,9 +9024,14 @@ service: beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`. + validation: + maxLength: 256 limit: type: optional docs: The maximum number of items to return in this paged response. + validation: + min: 0 + max: 1000 response: docs: OK. type: root.Transfers 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 ab8027fac96..57ac850af35 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 @@ -11886,10 +11886,22 @@ docs: Simple messaging "mediation_id": { "docs": "Identifier for active mediation record to be used", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, "my_endpoint": { "docs": "My URL endpoint", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + }, }, "my_label": { "docs": "Label for connection", @@ -11955,6 +11967,12 @@ docs: Simple messaging "my_endpoint": { "docs": "My URL endpoint", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + }, }, }, }, @@ -12431,14 +12449,32 @@ docs: Simple messaging "invitation_key": { "docs": "invitation key", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + }, }, "invitation_msg_id": { "docs": "Identifier of the associated Invitation Mesage", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "my_did": { "docs": "My DID", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "state": { "docs": "Connection state", @@ -12447,10 +12483,22 @@ docs: Simple messaging "their_did": { "docs": "Their DID", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "their_public_did": { "docs": "Their Public DID", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "their_role": { "docs": "Their role in the connection protocol", @@ -12571,6 +12619,12 @@ docs: Simple messaging "mediation_id": { "docs": "Identifier for active mediation record to be used", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, }, }, @@ -12797,21 +12851,35 @@ service: invitation_key: type: optional docs: invitation key + validation: + pattern: >- + ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$ invitation_msg_id: type: optional docs: Identifier of the associated Invitation Mesage + validation: + format: uuid my_did: type: optional docs: My DID + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ state: type: optional docs: Connection state their_did: type: optional docs: Their DID + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ their_public_did: type: optional docs: Their Public DID + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ their_role: type: optional docs: Their role in the connection protocol @@ -13046,6 +13114,9 @@ service: mediation_id: type: optional docs: Identifier for active mediation record to be used + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} body: properties: '@id': @@ -13188,9 +13259,15 @@ service: mediation_id: type: optional docs: Identifier for active mediation record to be used + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} my_endpoint: type: optional docs: My URL endpoint + validation: + pattern: >- + ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ my_label: type: optional docs: Label for connection @@ -13239,6 +13316,9 @@ service: my_endpoint: type: optional docs: My URL endpoint + validation: + pattern: >- + ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ response: docs: '' type: root.ConnRecord @@ -13409,18 +13489,42 @@ docs: Connection management "cred_def_id": { "docs": "Credential definition id", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + }, }, "issuer_did": { "docs": "Issuer DID", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "schema_id": { "docs": "Schema identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + }, }, "schema_issuer_did": { "docs": "Schema issuer DID", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "schema_name": { "docs": "Schema name", @@ -13429,6 +13533,12 @@ docs: Connection management "schema_version": { "docs": "Schema version", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9.]+$", + }, }, }, }, @@ -13776,21 +13886,35 @@ service: cred_def_id: type: optional docs: Credential definition id + validation: + pattern: >- + ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ issuer_did: type: optional docs: Issuer DID + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ schema_id: type: optional docs: Schema identifier + validation: + pattern: >- + ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$ schema_issuer_did: type: optional docs: Schema issuer DID + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ schema_name: type: optional docs: Schema name schema_version: type: optional docs: Schema version + validation: + pattern: ^[0-9.]+$ response: docs: '' type: root.CredentialDefinitionsCreatedResult @@ -14090,14 +14214,32 @@ docs: Credential definition operations "count": { "docs": "Maximum number to retrieve", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[1-9][0-9]*$", + }, }, "start": { "docs": "Start index", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9]*$", + }, }, "wql": { "docs": "(JSON) WQL query", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^{.*}$", + }, }, }, }, @@ -14140,10 +14282,22 @@ docs: Credential definition operations "from": { "docs": "Earliest epoch of revocation status interval of interest", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9]*$", + }, }, "to": { "docs": "Latest epoch of revocation status interval of interest", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9]*$", + }, }, }, }, @@ -14359,14 +14513,32 @@ docs: Credential definition operations "count": { "docs": "Maximum number to retrieve", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[1-9][0-9]*$", + }, }, "start": { "docs": "Start index", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9]*$", + }, }, "wql": { "docs": "(JSON) WQL query", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^{.*}$", + }, }, }, }, @@ -14428,9 +14600,13 @@ service: from: type: optional docs: Earliest epoch of revocation status interval of interest + validation: + pattern: ^[0-9]*$ to: type: optional docs: Latest epoch of revocation status interval of interest + validation: + pattern: ^[0-9]*$ response: docs: '' type: root.CredRevokedResult @@ -14559,12 +14735,18 @@ service: count: type: optional docs: Maximum number to retrieve + validation: + pattern: ^[1-9][0-9]*$ start: type: optional docs: Start index + validation: + pattern: ^[0-9]*$ wql: type: optional docs: (JSON) WQL query + validation: + pattern: ^{.*}$ response: docs: '' type: root.CredInfoList @@ -14601,12 +14783,18 @@ service: count: type: optional docs: Maximum number to retrieve + validation: + pattern: ^[1-9][0-9]*$ start: type: optional docs: Start index + validation: + pattern: ^[0-9]*$ wql: type: optional docs: (JSON) WQL query + validation: + pattern: ^{.*}$ body: properties: contexts: @@ -14770,6 +14958,12 @@ docs: Holder credential management "my_endpoint": { "docs": "My URL endpoint", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + }, }, "my_label": { "docs": "Label for connection request", @@ -14835,10 +15029,22 @@ docs: Holder credential management "mediation_id": { "docs": "Identifier for active mediation record to be used", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, "my_endpoint": { "docs": "My URL endpoint", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + }, }, }, }, @@ -14898,10 +15104,22 @@ docs: Holder credential management "mediation_id": { "docs": "Identifier for active mediation record to be used", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, "my_endpoint": { "docs": "My URL endpoint", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + }, }, "my_label": { "docs": "Label for connection request", @@ -14910,6 +15128,12 @@ docs: Holder credential management "their_public_did": { "docs": "Qualified public DID to which to request connection", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$", + }, }, "use_public_did": { "docs": "Use public DID for this connection", @@ -15026,10 +15250,22 @@ docs: Holder credential management "mediation_id": { "docs": "Identifier for active mediation record to be used", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, "my_endpoint": { "docs": "My URL endpoint", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + }, }, }, }, @@ -15066,15 +15302,24 @@ service: their_public_did: type: string docs: Qualified public DID to which to request connection + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$ alias: type: optional docs: Alias for connection mediation_id: type: optional docs: Identifier for active mediation record to be used + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} my_endpoint: type: optional docs: My URL endpoint + validation: + pattern: >- + ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ my_label: type: optional docs: Label for connection request @@ -15128,9 +15373,15 @@ service: mediation_id: type: optional docs: Identifier for active mediation record to be used + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} my_endpoint: type: optional docs: My URL endpoint + validation: + pattern: >- + ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ body: properties: '@id': @@ -15212,6 +15463,9 @@ service: my_endpoint: type: optional docs: My URL endpoint + validation: + pattern: >- + ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ my_label: type: optional docs: Label for connection request @@ -15260,9 +15514,15 @@ service: mediation_id: type: optional docs: Identifier for active mediation record to be used + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} my_endpoint: type: optional docs: My URL endpoint + validation: + pattern: >- + ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ response: docs: '' type: root.ConnRecord @@ -17921,6 +18181,12 @@ docs: Introduction of known parties "connection_id": { "docs": "Connection identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "role": { "docs": "Role assigned in credential exchange", @@ -17933,6 +18199,12 @@ docs: Introduction of known parties "thread_id": { "docs": "Thread identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -19848,6 +20120,8 @@ service: connection_id: type: optional docs: Connection identifier + validation: + format: uuid role: type: optional docs: Role assigned in credential exchange @@ -19857,6 +20131,8 @@ service: thread_id: type: optional docs: Thread identifier + validation: + format: uuid response: docs: '' type: root.V10CredentialExchangeListResult @@ -22557,6 +22833,12 @@ types: "connection_id": { "docs": "Connection identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "role": { "docs": "Role assigned in credential exchange", @@ -22569,6 +22851,12 @@ types: "thread_id": { "docs": "Thread identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -25126,6 +25414,8 @@ service: connection_id: type: optional docs: Connection identifier + validation: + format: uuid role: type: optional docs: Role assigned in credential exchange @@ -25135,6 +25425,8 @@ service: thread_id: type: optional docs: Thread identifier + validation: + format: uuid response: docs: '' type: root.V20CredExRecordListResult @@ -27399,6 +27691,12 @@ docs: Sign and verify json-ld data "did": { "docs": "DID of interest", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, }, }, @@ -27435,6 +27733,12 @@ docs: Sign and verify json-ld data "did": { "docs": "DID of interest", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, }, }, @@ -27510,6 +27814,12 @@ docs: Sign and verify json-ld data "did": { "docs": "DID of interest", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "endpoint_type": { "docs": "Endpoint type of interest (default 'Endpoint')", @@ -27662,6 +27972,12 @@ docs: Sign and verify json-ld data "did": { "docs": "DID to register", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "role": { "docs": "Role", @@ -27670,6 +27986,12 @@ docs: Sign and verify json-ld data "verkey": { "docs": "Verification key", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + }, }, }, }, @@ -27771,6 +28093,9 @@ service: did: type: string docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ endpoint_type: type: optional docs: Endpoint type of interest (default 'Endpoint') @@ -27796,6 +28121,9 @@ service: did: type: string docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ response: docs: '' type: root.GetDIDVerkeyResponse @@ -27818,6 +28146,9 @@ service: did: type: string docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ response: docs: '' type: root.GetNymRoleResponse @@ -27878,9 +28209,15 @@ service: did: type: string docs: DID to register + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ verkey: type: string docs: Verification key + validation: + pattern: >- + ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$ alias: type: optional docs: Alias @@ -28263,6 +28600,12 @@ docs: Interaction with ledger "conn_id": { "docs": "Connection identifier (optional)", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "role": { "docs": "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent", @@ -28343,6 +28686,12 @@ docs: Interaction with ledger "conn_id": { "docs": "Connection identifier (optional)", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "mediator_terms": { "allow-multiple": true, @@ -28898,6 +29247,8 @@ service: conn_id: type: optional docs: Connection identifier (optional) + validation: + format: uuid role: type: optional docs: >- @@ -29071,6 +29422,8 @@ service: conn_id: type: optional docs: Connection identifier (optional) + validation: + format: uuid mediator_terms: type: optional allow-multiple: true @@ -30464,6 +30817,12 @@ docs: Multitenant wallet management "mediation_id": { "docs": "Identifier for active mediation record to be used", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, "use_existing_connection": { "docs": "Use an existing connection, if possible", @@ -30662,6 +31021,9 @@ service: mediation_id: type: optional docs: Identifier for active mediation record to be used + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} use_existing_connection: type: optional docs: Use an existing connection, if possible @@ -31334,6 +31696,12 @@ docs: Out-of-band connections "connection_id": { "docs": "Connection identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "role": { "docs": "Role assigned in presentation exchange", @@ -31346,6 +31714,12 @@ docs: Out-of-band connections "thread_id": { "docs": "Thread identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -31407,10 +31781,22 @@ docs: Out-of-band connections "count": { "docs": "Maximum number to retrieve", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[1-9][0-9]*$", + }, }, "extra_query": { "docs": "(JSON) object mapping referents to extra WQL queries", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^{\s*".*?"\s*:\s*{.*?}\s*(,\s*".*?"\s*:\s*{.*?}\s*)*\s*}$", + }, }, "referent": { "docs": "Proof request referents of interest, comma-separated", @@ -31419,6 +31805,12 @@ docs: Out-of-band connections "start": { "docs": "Start index", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9]*$", + }, }, }, }, @@ -32890,6 +33282,8 @@ service: connection_id: type: optional docs: Connection identifier + validation: + format: uuid role: type: optional docs: Role assigned in presentation exchange @@ -32899,6 +33293,8 @@ service: thread_id: type: optional docs: Thread identifier + validation: + format: uuid response: docs: '' type: root.V10PresentationExchangeList @@ -33223,15 +33619,21 @@ service: count: type: optional docs: Maximum number to retrieve + validation: + pattern: ^[1-9][0-9]*$ extra_query: type: optional docs: (JSON) object mapping referents to extra WQL queries + validation: + pattern: ^{\s*".*?"\s*:\s*{.*?}\s*(,\s*".*?"\s*:\s*{.*?}\s*)*\s*}$ referent: type: optional docs: Proof request referents of interest, comma-separated start: type: optional docs: Start index + validation: + pattern: ^[0-9]*$ response: docs: '' type: list @@ -34501,6 +34903,12 @@ types: "connection_id": { "docs": "Connection identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "role": { "docs": "Role assigned in presentation exchange", @@ -34513,6 +34921,12 @@ types: "thread_id": { "docs": "Thread identifier", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -34574,10 +34988,22 @@ types: "count": { "docs": "Maximum number to retrieve", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[1-9][0-9]*$", + }, }, "extra_query": { "docs": "(JSON) object mapping referents to extra WQL queries", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^{\s*".*?"\s*:\s*{.*?}\s*(,\s*".*?"\s*:\s*{.*?}\s*)*\s*}$", + }, }, "referent": { "docs": "Proof request referents of interest, comma-separated", @@ -34586,6 +35012,12 @@ types: "start": { "docs": "Start index", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9]*$", + }, }, }, }, @@ -35933,6 +36365,8 @@ service: connection_id: type: optional docs: Connection identifier + validation: + format: uuid role: type: optional docs: Role assigned in presentation exchange @@ -35942,6 +36376,8 @@ service: thread_id: type: optional docs: Thread identifier + validation: + format: uuid response: docs: '' type: root.V20PresExRecordList @@ -36255,15 +36691,21 @@ service: count: type: optional docs: Maximum number to retrieve + validation: + pattern: ^[1-9][0-9]*$ extra_query: type: optional docs: (JSON) object mapping referents to extra WQL queries + validation: + pattern: ^{\s*".*?"\s*:\s*{.*?}\s*(,\s*".*?"\s*:\s*{.*?}\s*)*\s*}$ referent: type: optional docs: Proof request referents of interest, comma-separated start: type: optional docs: Start index + validation: + pattern: ^[0-9]*$ response: docs: '' type: list @@ -37262,10 +37704,22 @@ docs: did resolver interface. "cred_def_id": { "docs": "Credential definition identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + }, }, "rev_reg_id": { "docs": "Revocation registry identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + }, }, }, }, @@ -37414,6 +37868,12 @@ docs: did resolver interface. "cred_def_id": { "docs": "Credential definition identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + }, }, "state": { "docs": "Revocation registry state", @@ -37461,14 +37921,32 @@ docs: did resolver interface. "cred_ex_id": { "docs": "Credential exchange identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + }, }, "cred_rev_id": { "docs": "Credential revocation identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[1-9][0-9]*$", + }, }, "rev_reg_id": { "docs": "Revocation registry identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + }, }, }, }, @@ -38503,12 +38981,20 @@ service: cred_ex_id: type: optional docs: Credential exchange identifier + validation: + pattern: >- + [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} cred_rev_id: type: optional docs: Credential revocation identifier + validation: + pattern: ^[1-9][0-9]*$ rev_reg_id: type: optional docs: Revocation registry identifier + validation: + pattern: >- + ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) response: docs: '' type: root.CredRevRecordResult @@ -38590,6 +39076,9 @@ service: cred_def_id: type: optional docs: Credential definition identifier + validation: + pattern: >- + ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ state: type: optional docs: Revocation registry state @@ -38617,9 +39106,15 @@ service: cred_def_id: type: optional docs: Credential definition identifier + validation: + pattern: >- + ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ rev_reg_id: type: optional docs: Revocation registry identifier + validation: + pattern: >- + ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) response: docs: '' type: root.TailsDeleteResponse @@ -39245,10 +39740,22 @@ types: "schema_id": { "docs": "Schema identifier", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + }, }, "schema_issuer_did": { "docs": "Schema issuer DID", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "schema_name": { "docs": "Schema name", @@ -39257,6 +39764,12 @@ types: "schema_version": { "docs": "Schema version", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[0-9.]+$", + }, }, }, }, @@ -39571,15 +40084,23 @@ service: schema_id: type: optional docs: Schema identifier + validation: + pattern: >- + ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$ schema_issuer_did: type: optional docs: Schema issuer DID + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ schema_name: type: optional docs: Schema name schema_version: type: optional docs: Schema version + validation: + pattern: ^[0-9.]+$ response: docs: '' type: root.SchemasCreatedResult @@ -40150,6 +40671,12 @@ docs: Trust-ping over connection "did": { "docs": "DID of interest", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, }, }, @@ -40198,6 +40725,12 @@ docs: Trust-ping over connection "did": { "docs": "DID of interest", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$", + }, }, "key_type": { "docs": "Key type to query for.", @@ -40214,6 +40747,12 @@ docs: Trust-ping over connection "verkey": { "docs": "Verification key of interest", "type": "optional", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + }, }, }, }, @@ -40280,6 +40819,12 @@ docs: Trust-ping over connection "did": { "docs": "DID of interest", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, }, }, @@ -40402,6 +40947,12 @@ docs: Trust-ping over connection "did": { "docs": "DID of interest", "type": "string", + "validation": { + "format": undefined, + "maxLength": undefined, + "minLength": undefined, + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + }, }, "mediation_id": { "docs": "Mediation identifier", @@ -40513,6 +41064,9 @@ service: did: type: optional docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$ key_type: type: optional docs: Key type to query for. @@ -40527,6 +41081,9 @@ service: verkey: type: optional docs: Verification key of interest + validation: + pattern: >- + ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$ response: docs: '' type: root.DIDList @@ -40596,6 +41153,9 @@ service: did: type: string docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ response: docs: '' type: root.WalletModuleResponse @@ -40637,6 +41197,9 @@ service: did: type: string docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ conn_id: type: optional docs: Connection identifier @@ -40673,6 +41236,9 @@ service: did: type: string docs: DID of interest + validation: + pattern: >- + ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ response: docs: '' type: root.DIDEndpoint 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 c7cd8e6210a..85b4122c673 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 @@ -4657,6 +4657,12 @@ docs: Real-time transcription "created_on": { "docs": "Only get transcripts created on this date", "type": "optional", + "validation": { + "format": "date", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": { "docs": "Maximum amount of transcripts to retrieve", @@ -4794,6 +4800,8 @@ service: created_on: type: optional docs: Only get transcripts created on this date + validation: + format: date before_id: type: optional docs: Get transcripts that were created before this transcript ID 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 9d6e8cab187..3d29bb0e123 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 @@ -22507,6 +22507,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return accounts only for these `link.id`s.", @@ -22542,6 +22548,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "public_identification_name": { "docs": "Return information only for this type of account ID. For example, CLABE accounts.", @@ -24608,6 +24621,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -24630,6 +24646,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid balance__available: type: optional docs: >- @@ -28201,6 +28219,12 @@ client.connect() ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "account__in": { "docs": "Return balances only for these `account.id`s.", @@ -28272,6 +28296,12 @@ client.connect() ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return balances only for these `link.id`s.", @@ -28291,6 +28321,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "value_date": { "docs": "Return balances for exactly this date (`YYYY-MM-DD` or full ISO-8601 timestamp).", @@ -28832,6 +28869,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -28854,6 +28894,8 @@ service: ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. + validation: + format: uuid account: type: optional docs: > @@ -28862,6 +28904,8 @@ service: ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. + validation: + format: uuid account__in: type: optional docs: Return balances only for these `account.id`s. @@ -32229,6 +32273,13 @@ At the moment, the employment records resource is available for: ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -32402,6 +32453,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -33467,6 +33521,12 @@ client.connect() ℹ️ We highly recommend adding the `account.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "account__in": { "docs": "Return incomes for these `account.id`s.", @@ -33501,6 +33561,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -33945,6 +34012,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -33967,6 +34037,8 @@ service: ℹ️ We highly recommend adding the `account.id` filter in order to improve your performance. + validation: + format: uuid account__in: type: optional docs: Return incomes for these `account.id`s. @@ -35140,6 +35212,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "resources__allin": { "docs": "Return institutions that support these resources.", @@ -35213,6 +35292,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -36028,6 +36110,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": "optional", "omit": { @@ -36044,6 +36132,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -36435,6 +36530,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -36457,6 +36555,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid created_at__gt: optional created_at__gte: optional created_at__lt: optional @@ -39506,6 +39606,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return invoices only for these `link.id`s.", @@ -39525,6 +39631,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "status": { "docs": "Return invoices with this status. Can be either `Vigente` (valid) or `Cancelado` (cancelled).", @@ -41018,6 +41131,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -41040,6 +41156,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid created_at__gt: type: optional docs: >- @@ -44894,6 +45012,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "refresh_rate": { "docs": "Return links with this refresh rate. Choose between `6h`, `12h`, `24h`, `7d`, or `30d`.", @@ -45635,6 +45760,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -47409,6 +47537,13 @@ Cancun, COL 10447", ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -47775,6 +47910,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -50596,6 +50734,13 @@ types: ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "search": { "docs": "Return results for one or more payment links that match the description you searched for. @@ -50768,6 +50913,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 100 created_at: type: optional docs: Return results only for this date (in `YYYY-MM-DD` format). @@ -52067,6 +52215,12 @@ docs: >+ ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "account__in": { "docs": "Return receivable transactions only for these `account.id`s.", @@ -52102,6 +52256,12 @@ docs: >+ ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -52121,6 +52281,13 @@ docs: >+ ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "value_date": { "docs": "Return receivable transactions for exactly this date (`YYYY-MM-DD` or full ISO-8601 timestamp).", @@ -52323,6 +52490,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -52345,6 +52515,8 @@ service: ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. + validation: + format: uuid account: type: optional docs: > @@ -52353,6 +52525,8 @@ service: ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. + validation: + format: uuid account__in: type: optional docs: Return receivable transactions only for these `account.id`s. @@ -53165,6 +53339,12 @@ client.connect() ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "account_in": { "docs": "Return recurring expenses for these `accound.id`s.", @@ -53188,6 +53368,12 @@ client.connect() ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -53207,6 +53393,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -53689,6 +53882,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -53711,6 +53907,8 @@ service: ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. + validation: + format: uuid account: type: optional docs: > @@ -53719,6 +53917,8 @@ service: ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve your performance. + validation: + format: uuid account_in: type: optional docs: Return recurring expenses for these `accound.id`s. @@ -55110,6 +55310,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -55129,6 +55335,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -55615,6 +55828,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -55637,6 +55853,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid id: type: optional docs: Return information for this `risk-insight.id`. @@ -57247,6 +57465,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -57266,6 +57490,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -57481,6 +57712,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -57503,6 +57737,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid created_at__gt: type: optional docs: >- @@ -58637,6 +58873,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -58656,6 +58898,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "year": { "docs": "Return tax declarations for this year (`YYYY`).", @@ -59047,6 +59296,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -59069,6 +59321,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid link__in: type: optional docs: Return information for these `link.id`s. @@ -60054,6 +60308,12 @@ client.tax_retentions.list(params: { ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -60073,6 +60333,13 @@ client.tax_retentions.list(params: { ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -60258,6 +60525,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -60280,6 +60550,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid created_at__gt: type: optional docs: >- @@ -63490,6 +63762,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -63509,6 +63787,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "tipo_declaracion": { "docs": "Return tax returns with this declaration type.", @@ -65458,6 +65743,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -65480,6 +65768,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid created_at__gt: type: optional docs: >- @@ -70141,6 +70431,12 @@ client.connect() ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "link__in": { "docs": "Return information for these `link.id`s.", @@ -70160,6 +70456,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -70642,6 +70945,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -70664,6 +70970,8 @@ service: ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance. + validation: + format: uuid created_at__gt: type: optional docs: >- @@ -73250,6 +73558,12 @@ client.connect() ℹ️ We highly recommend adding the `account.id` filter in order to improve your performance. ", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "account__balance__available": { "docs": "Return transactions that have a `account.balance.available` matching exactly this value.", @@ -73421,6 +73735,12 @@ client.connect() ℹ️ We highly recommend adding the `account.id` filter as well in order to improve your performance. ", "type": "string", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "omit": { "docs": "Omit certain fields from being returned in the response. For more information, see our [Filtering responses](https://developers.belvo.com/docs/searching-and-filtering) DevPortal article.", @@ -73436,6 +73756,13 @@ client.connect() ℹ️ 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). ", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 1000, + "min": 1, + "multipleOf": undefined, + }, }, "reference": { "docs": "Returns transactions with this institution-assigned reference number.", @@ -74912,6 +75239,9 @@ service: ℹ️ 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). + validation: + min: 1 + max: 1000 omit: type: optional docs: >- @@ -74934,6 +75264,8 @@ service: ℹ️ We highly recommend adding the `account.id` filter as well in order to improve your performance. + validation: + format: uuid account: type: optional docs: > @@ -74942,6 +75274,8 @@ service: ℹ️ We highly recommend adding the `account.id` filter in order to improve your performance. + validation: + format: uuid account__balance__available: type: optional docs: >- 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 6c5d3cd9e35..39563a6b7cc 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 @@ -11434,6 +11434,13 @@ service: "limit": { "docs": "Return a page of results with given number of records.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 200, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Return a page of results with given number of records.", @@ -11477,6 +11484,9 @@ service: limit: type: optional docs: Return a page of results with given number of records. + validation: + min: 1 + max: 200 response: docs: Successful operation. type: root.PeopleContainer @@ -14162,6 +14172,13 @@ docs: The Contracts resource lets you create, amend and, retrieve Deel contracts "limit": { "docs": "Return a page of results with given number of records.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 10, + "min": 1, + "multipleOf": undefined, + }, }, "order_direction": { "docs": "Order direction of results; ascending or descending.", @@ -14521,6 +14538,9 @@ service: limit: type: optional docs: Return a page of results with given number of records. + validation: + min: 1 + max: 10 order_direction: type: optional docs: Order direction of results; ascending or descending. @@ -16067,6 +16087,13 @@ docs: API end-points related to HRIS data. "limit": { "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": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 99, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings", @@ -16205,6 +16232,13 @@ docs: API end-points related to HRIS data. "limit": { "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": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 99, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings", @@ -16361,6 +16395,9 @@ service: docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings + validation: + min: 1 + max: 99 offset: type: optional docs: >- @@ -16477,6 +16514,9 @@ service: docs: >- Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings + validation: + min: 1 + max: 99 offset: type: optional docs: >- 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 756100d712b..5ed49213db8 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 @@ -8389,10 +8389,24 @@ errors: "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "sort": { "docs": "Sort results by the specified field.", @@ -9368,11 +9382,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). + validation: + min: 1 + max: 100 sort: type: optional docs: Sort results by the specified field. @@ -11012,10 +11031,24 @@ docs: >- "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -11209,11 +11242,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 direction: type: optional docs: Set sort order. Allows "asc" (ascending) or "desc" (descending) @@ -12110,10 +12148,24 @@ docs: Endpoints relating to Carbon Calculations "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -12570,11 +12622,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.shipment.id: type: optional docs: The unique id for the shipment. @@ -13301,10 +13358,24 @@ docs: Endpoints relating to Commercial Invoice objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -13745,11 +13816,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.ref: type: optional docs: The ref for the company. @@ -14188,10 +14264,24 @@ docs: Endpoints relating to Company objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -14582,11 +14672,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.ref: type: optional docs: The ref for the company entity @@ -14993,10 +15088,24 @@ docs: Endpoints relating to CompanyEntity objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -15276,11 +15385,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.company_ref: type: optional docs: The ref for the company. @@ -15617,10 +15731,24 @@ docs: Endpoints relating to Contact objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -15827,11 +15955,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). + validation: + min: 1 + max: 100 f.shipment.id: type: optional docs: >- @@ -16093,10 +16226,24 @@ docs: Endpoints relating to Container objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -16255,11 +16402,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). + validation: + min: 1 + max: 100 f.leg.id: type: optional docs: >- @@ -16421,10 +16573,24 @@ docs: Endpoints relating to ContainerLeg objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -16577,11 +16743,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.shipment.id: type: optional docs: The unique id for the shipment. @@ -16830,10 +17001,24 @@ docs: Endpoints relating to Customs Entry objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -17015,11 +17200,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.shipment.id: type: optional docs: Filters the list for documents that belong to the given shipment @@ -18016,10 +18206,24 @@ This parameter is mutually exclusive with the f.shipment.id filter. "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "sort": { "docs": "Sort results by the specified field.", @@ -18423,11 +18627,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). + validation: + min: 1 + max: 100 sort: type: optional> docs: Sort results by the specified field. @@ -19004,10 +19213,24 @@ docs: Endpoints relating to Invoice objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -19427,11 +19650,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.ref: type: optional docs: The ref for the location. @@ -19841,10 +20069,24 @@ docs: Endpoints relating to Location objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -19945,11 +20187,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 f.port_type: type: optional docs: Filter by the type of port. Ports can have more than one type @@ -21452,10 +21699,24 @@ docs: Endpoints relating to Product objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "sort": { "docs": "Sort results by the specified field (only `id` is supported at this time)", @@ -22009,11 +22270,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 sort: type: optional> docs: >- @@ -22937,10 +23203,24 @@ docs: >- "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive)", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -23247,11 +23527,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive) + validation: + min: 1 + max: 100 direction: type: optional docs: Set sort order. Allows "asc"(ascending) or "desc" (descending) @@ -23959,10 +24244,24 @@ docs: >- "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "sort": { "docs": "Sort results by the specified field.", @@ -24930,11 +25229,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). + validation: + min: 1 + max: 100 sort: type: optional docs: Sort results by the specified field. @@ -26076,10 +26380,24 @@ docs: Endpoints relating to Shipment objects "page": { "docs": "Page number of the page to retrieve", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per": { "docs": "Count of items in each page. Should be between 1 and 100 (inclusive).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -26389,11 +26707,16 @@ service: page: type: optional docs: Page number of the page to retrieve + validation: + min: 1 per: type: optional docs: >- Count of items in each page. Should be between 1 and 100 (inclusive). + validation: + min: 1 + max: 100 f.shipment.id: type: optional docs: Only return legs for the shipment specified by this id. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hookdeck.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hookdeck.json index 6255a6cf9cb..77e5ea539bd 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hookdeck.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hookdeck.json @@ -4196,6 +4196,12 @@ types: "event_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "next": "optional", @@ -4258,6 +4264,8 @@ service: event_id: type: optional allow-multiple: true + validation: + maxLength: 255 order_by: optional dir: optional limit: optional @@ -4589,20 +4597,44 @@ docs: An attempt is any request that Hookdeck makes on behalf of an event. "event_data_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "label": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "last_used_at": "optional", "limit": "optional", "name": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 155, + "minLength": undefined, + "pattern": "^[A-z0-9-_]+$", + }, }, "next": "optional", "order_by": "optional", @@ -4610,6 +4642,12 @@ docs: An attempt is any request that Hookdeck makes on behalf of an event. "webhook_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -4864,18 +4902,29 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 name: type: optional allow-multiple: true + validation: + pattern: ^[A-z0-9-_]+$ + maxLength: 155 webhook_id: type: optional allow-multiple: true + validation: + maxLength: 255 event_data_id: type: optional allow-multiple: true + validation: + maxLength: 255 label: type: optional allow-multiple: true + validation: + maxLength: 255 last_used_at: optional order_by: optional dir: optional @@ -5365,6 +5414,12 @@ docs: A bookmark lets you conveniently store and replay a specific request. "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "in_progress": "optional", "limit": "optional", @@ -6389,6 +6444,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 query_partial_match: optional in_progress: optional order_by: optional @@ -6779,6 +6836,12 @@ docs: '' "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "in_progress": "optional", "limit": "optional", @@ -6999,6 +7062,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 query_partial_match: optional in_progress: optional order_by: optional @@ -7387,6 +7452,12 @@ docs: '' "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "in_progress": "optional", "limit": "optional", @@ -8151,6 +8222,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 in_progress: optional query_partial_match: optional order_by: optional @@ -8787,12 +8860,24 @@ docs: '' "destination_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "dir": "optional", "full_name": "optional", "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "name": "optional", @@ -8803,6 +8888,12 @@ docs: '' "source_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -9779,13 +9870,19 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 name: optional destination_id: type: optional allow-multiple: true + validation: + maxLength: 255 source_id: type: optional allow-multiple: true + validation: + maxLength: 255 archived: optional archived_at: optional full_name: optional @@ -10757,6 +10854,12 @@ docs: >- "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "name": "optional", @@ -11091,6 +11194,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 name: optional archived: optional archived_at: optional @@ -11530,6 +11635,12 @@ docs: A destination is any endpoint to which your webhooks can be routed. "bulk_retry_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "cli_id": "optional", "cli_user_id": { @@ -11540,25 +11651,55 @@ docs: A destination is any endpoint to which your webhooks can be routed. "destination_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "dir": "optional", "error_code": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "event_data_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "headers": "optional", "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "include": "optional>", "issue_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "last_attempt_at": "optional", "limit": "optional", @@ -11571,12 +11712,24 @@ docs: A destination is any endpoint to which your webhooks can be routed. "source_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "status": "optional", "successful_at": "optional", "webhook_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -11812,19 +11965,29 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 status: optional issue_id: type: optional allow-multiple: true + validation: + maxLength: 255 webhook_id: type: optional allow-multiple: true + validation: + maxLength: 255 destination_id: type: optional allow-multiple: true + validation: + maxLength: 255 source_id: type: optional allow-multiple: true + validation: + maxLength: 255 attempts: optional response_status: optional successful_at: optional @@ -11832,6 +11995,8 @@ service: error_code: type: optional allow-multiple: true + validation: + maxLength: 255 cli_id: optional cli_user_id: type: optional @@ -11840,12 +12005,16 @@ service: event_data_id: type: optional allow-multiple: true + validation: + maxLength: 255 headers: optional body: optional parsed_query: optional bulk_retry_id: type: optional allow-multiple: true + validation: + maxLength: 255 path: optional include: optional> order_by: optional @@ -13917,10 +14086,22 @@ docs: >- "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "issue_trigger_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "last_seen_at": "optional", "limit": "optional", @@ -14030,10 +14211,22 @@ docs: >- "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "issue_trigger_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "last_seen_at": "optional", "limit": "optional", @@ -14283,9 +14476,13 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 issue_trigger_id: type: optional allow-multiple: true + validation: + maxLength: 255 type: optional status: optional merged_with: @@ -14368,9 +14565,13 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 issue_trigger_id: type: optional allow-multiple: true + validation: + maxLength: 255 type: optional status: optional merged_with: @@ -14826,6 +15027,12 @@ docs: Notifications let your team receive alerts anytime an issue changes. "bulk_retry_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "cli_id": "optional", "cli_user_id": { @@ -14836,25 +15043,55 @@ docs: Notifications let your team receive alerts anytime an issue changes. "destination_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "dir": "optional", "error_code": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "event_data_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "headers": "optional", "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "include": "optional>", "issue_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "last_attempt_at": "optional", "limit": "optional", @@ -14867,12 +15104,24 @@ docs: Notifications let your team receive alerts anytime an issue changes. "source_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "status": "optional", "successful_at": "optional", "webhook_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -14937,6 +15186,12 @@ docs: Notifications let your team receive alerts anytime an issue changes. "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "next": "optional", @@ -15042,6 +15297,12 @@ docs: Notifications let your team receive alerts anytime an issue changes. "bulk_retry_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "created_at": "optional", "dir": "optional", @@ -15050,6 +15311,12 @@ docs: Notifications let your team receive alerts anytime an issue changes. "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "ignored_count": "optional", "include": "optional>", @@ -15064,6 +15331,12 @@ docs: Notifications let your team receive alerts anytime an issue changes. "source_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "status": "optional", "verified": "optional", @@ -15285,6 +15558,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 status: optional rejection_cause: optional ignored_count: optional @@ -15292,6 +15567,8 @@ service: source_id: type: optional allow-multiple: true + validation: + maxLength: 255 verified: optional headers: optional body: optional @@ -15302,6 +15579,8 @@ service: bulk_retry_id: type: optional allow-multiple: true + validation: + maxLength: 255 include: optional> order_by: optional dir: optional @@ -15503,19 +15782,29 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 status: optional issue_id: type: optional allow-multiple: true + validation: + maxLength: 255 webhook_id: type: optional allow-multiple: true + validation: + maxLength: 255 destination_id: type: optional allow-multiple: true + validation: + maxLength: 255 source_id: type: optional allow-multiple: true + validation: + maxLength: 255 attempts: optional response_status: optional successful_at: optional @@ -15523,6 +15812,8 @@ service: error_code: type: optional allow-multiple: true + validation: + maxLength: 255 cli_id: optional cli_user_id: type: optional @@ -15531,12 +15822,16 @@ service: event_data_id: type: optional allow-multiple: true + validation: + maxLength: 255 headers: optional body: optional parsed_query: optional bulk_retry_id: type: optional allow-multiple: true + validation: + maxLength: 255 path: optional include: optional> order_by: optional @@ -15600,6 +15895,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 order_by: optional dir: optional limit: optional @@ -15862,6 +16159,12 @@ docs: A request represent a webhook received by Hookdeck. "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "name": "optional", @@ -16115,6 +16418,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 name: optional archived: optional archived_at: optional @@ -16615,6 +16920,12 @@ docs: A ruleset defines a group of rules that can be used across many connection "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "integration_id": "optional", "limit": "optional", @@ -16868,6 +17179,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 name: optional archived: optional archived_at: optional @@ -17413,6 +17726,12 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "issue_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "log_level": "optional", @@ -17422,6 +17741,12 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "webhook_id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -17479,6 +17804,12 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "id": { "allow-multiple": true, "type": "optional", + "validation": { + "format": undefined, + "maxLength": 255, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": "optional", "name": "optional", @@ -17955,6 +18286,8 @@ service: id: type: optional allow-multiple: true + validation: + maxLength: 255 name: optional order_by: optional dir: optional @@ -18236,9 +18569,13 @@ service: webhook_id: type: optional allow-multiple: true + validation: + maxLength: 255 issue_id: type: optional allow-multiple: true + validation: + maxLength: 255 created_at: optional order_by: optional dir: optional 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 bf2b9b6ef97..d291e99a403 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 @@ -6531,10 +6531,24 @@ By default the deployed version of the Dataset is returned. Use the query parame "page": { "docs": "Page offset for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Datasets to fetch.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "sort_by": { "docs": "Field to sort Datasets by", @@ -6610,10 +6624,24 @@ By default the deployed version of the Dataset is returned. Use the query parame "page": { "docs": "Page number for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Datapoints to fetch.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "version_id": { "docs": "A specific Version ID of the Dataset to retrieve.", @@ -6822,9 +6850,13 @@ service: page: type: optional docs: Page offset for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Datasets to fetch. + validation: + min: 0 name: type: optional docs: Case-insensitive filter for Dataset name. @@ -7176,9 +7208,13 @@ service: page: type: optional docs: Page number for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Datapoints to fetch. + validation: + min: 0 response: docs: Successful Response type: root.PaginatedDataDatapointResponse @@ -7913,10 +7949,24 @@ Retrieve a list of Evaluations that evaluate versions of the specified File.", "page": { "docs": "Page number for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Evaluations to fetch.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, }, }, @@ -8250,9 +8300,13 @@ service: page: type: optional docs: Page number for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Evaluations to fetch. + validation: + min: 0 response: docs: Successful Response type: root.PaginatedDataEvaluationResponse @@ -9542,6 +9596,13 @@ By default the deployed version of the Evaluator is returned. Use the query para "page": { "docs": "Page offset for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Evaluators to fetch.", @@ -9871,6 +9932,8 @@ service: page: type: optional docs: Page offset for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Evaluators to fetch. @@ -10916,6 +10979,13 @@ You can manually create Logs through the API. "page": { "docs": "Page number for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "search": { "docs": "If provided, only Logs that contain the provided string in its inputs and output will be returned.", @@ -10924,6 +10994,13 @@ You can manually create Logs through the API. "size": { "docs": "Page size for pagination. Number of Logs to fetch.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "start_date": { "docs": "If provided, only Logs created after the specified date will be returned.", @@ -10976,9 +11053,13 @@ service: page: type: optional docs: Page number for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Logs to fetch. + validation: + min: 0 version_id: type: optional docs: >- @@ -12186,10 +12267,24 @@ By default the deployed version of the Prompt is returned. Use the query paramet "page": { "docs": "Page number for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Prompts to fetch.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "sort_by": { "docs": "Field to sort Prompts by", @@ -12834,9 +12929,13 @@ service: page: type: optional docs: Page number for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Prompts to fetch. + validation: + min: 0 name: type: optional docs: Case-insensitive filter for Prompt name. @@ -14359,10 +14458,24 @@ Log is in, nested within the evaluated Log. "page": { "docs": "Page number for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Sessions to fetch.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "version_id": { "docs": "Unique identifier for Version to return Sessions for. Sessions that contain any Logs associated to this Version will be returned.", @@ -14503,9 +14616,13 @@ service: page: type: optional docs: Page number for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Sessions to fetch. + validation: + min: 0 response: docs: Successful Response type: root.PaginatedDataSessionResponse @@ -15069,6 +15186,13 @@ By default the deployed version of the Tool is returned. Use the query parameter "page": { "docs": "Page offset for pagination.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "size": { "docs": "Page size for pagination. Number of Tools to fetch.", @@ -15576,6 +15700,8 @@ service: page: type: optional docs: Page offset for pagination. + validation: + min: 1 size: type: optional docs: Page size for pagination. Number of Tools to fetch. 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 2c3ecc545a3..e585a0a09f2 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 @@ -24401,6 +24401,13 @@ You can optionally request the result page size and the cursor to start after to "per_page": { "docs": "How many results per page", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 150, + "min": undefined, + "multipleOf": undefined, + }, }, "starting_after": { "docs": "String used to get the next page of conversations.", @@ -27953,6 +27960,8 @@ service: per_page: type: optional docs: How many results per page + validation: + max: 150 starting_after: type: optional docs: String used to get the next page of conversations. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/merge.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/merge.json index 42c42f97b4e..ac78aea9b6e 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/merge.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/merge.json @@ -12070,6 +12070,12 @@ service: "personal_email": { "docs": "If provided, will only return Employees with this personal email", "type": "optional", + "validation": { + "format": "email", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "remote_fields": { "docs": "Deprecated. Use show_enum_origins.", @@ -12106,6 +12112,12 @@ service: "work_email": { "docs": "If provided, will only return Employees with this work email", "type": "optional", + "validation": { + "format": "email", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "work_location_id": { "docs": "If provided, will only return employees for this location.", @@ -15750,6 +15762,8 @@ service: personal_email: type: optional docs: If provided, will only return Employees with this personal email + validation: + format: email remote_fields: type: optional docs: Deprecated. Use show_enum_origins. @@ -15785,6 +15799,8 @@ service: work_email: type: optional docs: If provided, will only return Employees with this work email + validation: + format: email work_location_id: type: optional docs: If provided, will only return employees for this location. 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 aff511b225d..3d927651404 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 @@ -23894,6 +23894,13 @@ You can optionally request the result page size and the cursor to start after to "per_page": { "docs": "How many results per page", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 150, + "min": undefined, + "multipleOf": undefined, + }, }, "starting_after": { "docs": "String used to get the next page of conversations.", @@ -27446,6 +27453,8 @@ service: per_page: type: optional docs: How many results per page + validation: + max: 150 starting_after: type: optional docs: String used to get the next page of conversations. 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 696d61fadef..e4494ad68f3 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 @@ -5090,10 +5090,24 @@ If the permission is already granted, it is skipped.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "permission": { "docs": "optional permission filter, will only return condition set rules granting this permission", @@ -5250,9 +5264,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -5928,10 +5947,24 @@ This includes any permissions granted to said condition set (i.e: any matching c "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -6058,10 +6091,24 @@ This includes any permissions granted to said condition set (i.e: any matching c "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -6186,10 +6233,24 @@ This includes any permissions granted to said condition set (i.e: any matching c "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "search": { "docs": "Text search for the condition sets name or key", @@ -6447,9 +6508,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: ListConditionSetsResponse @@ -6923,9 +6989,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -7022,9 +7093,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -7462,10 +7538,24 @@ allowed.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -7836,9 +7926,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -8411,10 +8506,24 @@ authenticated actor (i.e: human team member or api key).", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -8523,9 +8632,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -8965,10 +9079,24 @@ Every project is a separate silo, and has its own unique set of environments and "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -9086,9 +9214,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -9592,10 +9725,24 @@ This includes any permissions granted to perform the action.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -9743,9 +9890,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -10330,10 +10482,24 @@ This includes any permissions granted to perform the action.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -10477,9 +10643,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -10907,10 +11078,24 @@ attribute to evaluate as `undefined`.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -11037,10 +11222,24 @@ attribute to evaluate as `undefined`.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -11166,9 +11365,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -11346,9 +11550,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 errors: - root.UnprocessableEntityError examples: @@ -11711,10 +11920,24 @@ and will return the existing instance object in the response body.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -11844,9 +12067,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -12661,10 +12889,24 @@ This includes any permissions granted to said role.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -12906,9 +13148,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -13924,10 +14171,24 @@ A resource may also contain: "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "search": { "docs": "Text search for the resources name or key", @@ -14299,9 +14560,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: ListResourcesResponse @@ -15110,10 +15376,24 @@ The tenant defines the scope of the assignment. In other words, the role is effe "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "role": { "docs": "optional role filter, will only return role assignments granting this role.", @@ -15247,9 +15527,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -15963,10 +16248,24 @@ This includes any permissions granted to said role.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "search": { "docs": "Text search for the roles name or key", @@ -16225,9 +16524,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: ListRolesResponse @@ -17096,10 +17400,24 @@ and will return the existing tenant object in the response body.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "role": { "docs": "Match users with a specific role", @@ -17183,10 +17501,24 @@ and will return the existing tenant object in the response body.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "search": { "docs": "Text search for the tenant name or key", @@ -17350,9 +17682,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: root.PaginatedResultUserRead @@ -17427,9 +17764,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: ListTenantsResponse @@ -17871,10 +18213,24 @@ attribute to evaluate as `undefined`.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "resource_id": "optional", }, @@ -17998,10 +18354,24 @@ attribute to evaluate as `undefined`.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "resource_id": "optional", }, @@ -18123,9 +18493,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: list @@ -18291,9 +18666,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 errors: - root.UnprocessableEntityError examples: @@ -18802,10 +19182,24 @@ and will return the existing user object in the response body.", "page": { "docs": "Page number of the results to fetch, starting at 1.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 1, + "multipleOf": undefined, + }, }, "per_page": { "docs": "The number of results per page (max 100).", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "role": { "docs": "Match users with a specific role", @@ -19159,9 +19553,14 @@ service: page: type: optional docs: Page number of the results to fetch, starting at 1. + validation: + min: 1 per_page: type: optional docs: The number of results per page (max 100). + validation: + min: 1 + max: 100 response: docs: Successful Response type: root.PaginatedResultUserRead diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/rightbrain.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/rightbrain.json index bd89a3103e7..2ab2c2c70ed 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/rightbrain.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/rightbrain.json @@ -18577,10 +18577,23 @@ service: "cursor": { "docs": "A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results.", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "page_limit": { "docs": "The maximum number of items to return per page. Defaults to `100` if not specified.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -18781,11 +18794,16 @@ service: docs: >- The maximum number of items to return per page. Defaults to `100` if not specified. + validation: + min: 1 + max: 100 cursor: type: optional docs: >- A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results. + validation: + format: uuid response: docs: Successful Response type: root.PaginatedResultSetTaskForwarder @@ -19405,6 +19423,12 @@ service: "cursor": { "docs": "A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results.", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "name": { "docs": "Filter tasks by name. Supports partial matches.", @@ -19413,6 +19437,13 @@ service: "page_limit": { "docs": "The maximum number of items to return per page. Defaults to `100` if not specified.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, }, }, @@ -19658,14 +19689,33 @@ service: "cursor": { "docs": "A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results.", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "page_limit": { "docs": "The maximum number of items to return per page. Defaults to `100` if not specified.", "type": "optional", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "task_revision_id": { "docs": "The specific Task Revision to reference.", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -20239,11 +20289,16 @@ service: docs: >- The maximum number of items to return per page. Defaults to `100` if not specified. + validation: + min: 1 + max: 100 cursor: type: optional docs: >- A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results. + validation: + format: uuid response: docs: Successful Response type: root.PaginatedResultSetTask @@ -20695,14 +20750,21 @@ service: docs: >- The maximum number of items to return per page. Defaults to `100` if not specified. + validation: + min: 1 + max: 100 cursor: type: optional docs: >- A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results. + validation: + format: uuid task_revision_id: type: optional docs: The specific Task Revision to reference. + validation: + format: uuid response: docs: Successful Response type: root.PaginatedResultSetTaskRun diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/uploadcare.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/uploadcare.json index c51c2aefe45..659572e10b1 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/uploadcare.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/uploadcare.json @@ -3271,6 +3271,12 @@ Log.d("TAG", file.toString()) "file_id": { "docs": "File's unique ID.", "type": "string", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "pub_key": "root.ProjectPublicKeyType", }, @@ -4287,6 +4293,12 @@ Log.d("TAG", status.toString()) "token": { "docs": "Token returned by the `/from_url/` endpoint that identifies a request to fetch/upload a file from a URL.", "type": "string", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, }, }, @@ -6278,6 +6290,8 @@ service: docs: >- Token returned by the `/from_url/` endpoint that identifies a request to fetch/upload a file from a URL. + validation: + format: uuid response: docs: | Request was processed successfully. @@ -6809,6 +6823,8 @@ service: file_id: type: string docs: File's unique ID. + validation: + format: uuid response: docs: File information was retrieved successfully. type: root.FileUploadInfo 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 9c2313a2f3a..8e9732776dc 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 @@ -2018,10 +2018,24 @@ give access to details and data from the requesting user.", "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "relationship": { "docs": "Whether to get comments you have received, given, or both", @@ -2128,10 +2142,24 @@ give access to details and data from the requesting user.", "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, }, }, @@ -2185,10 +2213,24 @@ give access to details and data from the requesting user.", "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "since": { "docs": "Include items created after this date", @@ -2783,9 +2825,14 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 response: docs: A paginated result set type: MeLikesResponse @@ -2829,9 +2876,14 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 since: type: optional docs: Include items created after this date @@ -2879,9 +2931,14 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 since: type: optional docs: Include items created after this date @@ -2983,14 +3040,34 @@ imports: "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, "query": { "docs": "Search query", "type": "string", + "validation": { + "format": undefined, + "maxLength": 512, + "minLength": 1, + "pattern": undefined, + }, }, }, }, @@ -3047,12 +3124,20 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 query: type: string docs: Search query + validation: + minLength: 1 + maxLength: 512 response: docs: A paginated result set type: SearchValsResponse @@ -3599,10 +3684,24 @@ docs: SQLite "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, }, }, @@ -3681,9 +3780,14 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 response: docs: A paginated result set type: UsersValsResponse @@ -4261,10 +4365,24 @@ let you get, create, and run vals.", "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, }, }, @@ -4321,10 +4439,24 @@ let you get, create, and run vals.", "limit": { "docs": "Maximum items to return in each paginated response", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": 100, + "min": 1, + "multipleOf": undefined, + }, }, "offset": { "docs": "Number of items to skip in order to deliver paginated results", "type": "integer", + "validation": { + "exclusiveMax": undefined, + "exclusiveMin": undefined, + "max": undefined, + "min": 0, + "multipleOf": undefined, + }, }, }, }, @@ -5148,9 +5280,14 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 response: docs: A paginated result set type: ValsListResponse @@ -5268,9 +5405,14 @@ service: offset: type: integer docs: Number of items to skip in order to deliver paginated results + validation: + min: 0 limit: type: integer docs: Maximum items to return in each paginated response + validation: + min: 1 + max: 100 response: docs: Default Response type: root.ExtendedVal diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/vellum.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/vellum.json index 5582c87f5df..c63f6004ca5 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/vellum.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/vellum.json @@ -4687,6 +4687,12 @@ Used to list documents. Optionally filter on supported fields. "document_index_id": { "docs": "Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.", "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, }, "limit": { "docs": "Number of results to return per page.", @@ -4823,6 +4829,8 @@ service: Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation. + validation: + format: uuid limit: type: optional docs: Number of results to return per page. 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 95e592a58fb..452108871bf 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 @@ -67,6 +67,12 @@ export function buildQueryParameter({ queryParameterSchema.availability = convertAvailability(queryParameter.availability); } + if (isRawTypeReferenceDetailedSchema(typeReference.value)) { + if (typeReference.value.validation !== undefined) { + queryParameterSchema.validation = typeReference.value.validation; + } + } + return queryParameterSchema; } @@ -425,3 +431,9 @@ function hasSamePrimitiveValueType({ array, primitive }: { array: Schema; primit array.value.schema.type === primitive.schema.type ); } + +function isRawTypeReferenceDetailedSchema( + rawTypeReference: RawSchemas.TypeReferenceSchema +): rawTypeReference is RawSchemas.TypeReferenceDetailedSchema { + return (rawTypeReference as RawSchemas.TypeReferenceDetailedSchema).type != null; +} diff --git a/packages/cli/ete-tests/src/tests/update-api-v2/__snapshots__/update-api.test.ts.snap b/packages/cli/ete-tests/src/tests/update-api-v2/__snapshots__/update-api.test.ts.snap index 6abfe5e4865..f07cae27b61 100644 --- a/packages/cli/ete-tests/src/tests/update-api-v2/__snapshots__/update-api.test.ts.snap +++ b/packages/cli/ete-tests/src/tests/update-api-v2/__snapshots__/update-api.test.ts.snap @@ -1148,27 +1148,37 @@ exports[`fern api update unioned > fern api update unioned 1`] = ` "type": { "type": "string", "description": "A URI reference that identifies the problem type", - "example": "https://example.com/probs/out-of-credit" + "examples": [ + "https://example.com/probs/out-of-credit" + ] }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type", - "example": "You do not have enough credit." + "examples": [ + "You do not have enough credit." + ] }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem", - "example": "Your current balance is 30, but that costs 50." + "examples": [ + "Your current balance is 30, but that costs 50." + ] }, "instance": { "type": "string", "description": "A URI reference that identifies the specific occurrence of the problem", - "example": "/account/12345/msgs/abc" + "examples": [ + "/account/12345/msgs/abc" + ] }, "status": { "type": "integer", "description": "The HTTP status code", - "example": 400 + "examples": [ + 400 + ] } } }, diff --git a/packages/cli/ete-tests/src/tests/update-api/__snapshots__/update-api.test.ts.snap b/packages/cli/ete-tests/src/tests/update-api/__snapshots__/update-api.test.ts.snap index e78b9d9b95d..3cfedda568a 100644 --- a/packages/cli/ete-tests/src/tests/update-api/__snapshots__/update-api.test.ts.snap +++ b/packages/cli/ete-tests/src/tests/update-api/__snapshots__/update-api.test.ts.snap @@ -1148,27 +1148,37 @@ exports[`fern api update > fern api update 1`] = ` "type": { "type": "string", "description": "A URI reference that identifies the problem type", - "example": "https://example.com/probs/out-of-credit" + "examples": [ + "https://example.com/probs/out-of-credit" + ] }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type", - "example": "You do not have enough credit." + "examples": [ + "You do not have enough credit." + ] }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem", - "example": "Your current balance is 30, but that costs 50." + "examples": [ + "Your current balance is 30, but that costs 50." + ] }, "instance": { "type": "string", "description": "A URI reference that identifies the specific occurrence of the problem", - "example": "/account/12345/msgs/abc" + "examples": [ + "/account/12345/msgs/abc" + ] }, "status": { "type": "integer", "description": "The HTTP status code", - "example": 400 + "examples": [ + 400 + ] } } }, 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 591c256bf04..f8917944b6f 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 @@ -67,6 +67,8 @@ service: limit: docs: How many items to return at one time (max 100) type: optional + validation: + max: 100 response: docs: A paged array of pets type: root.Pets @@ -172,6 +174,8 @@ service: limit: docs: How many items to return at one time (max 100) type: optional + validation: + max: 100 response: docs: A paged array of pets type: root.Pets @@ -308,6 +312,8 @@ service: limit: docs: How many items to return at one time (max 100) type: optional + validation: + max: 100 response: docs: A paged array of pets type: neopetsRoot.Pets @@ -1462,12 +1468,16 @@ service: destination: docs: The ID of the destination station type: string + validation: + format: uuid dogs: docs: Only return trips where dogs are known to be allowed type: optional origin: docs: The ID of the origin station type: string + validation: + format: uuid response: docs: A list of available train trips type: GetTripsResponse diff --git a/packages/cli/ete-tests/src/tests/write-definition/fixtures/header-overrides/fern/.definition/pets.yml b/packages/cli/ete-tests/src/tests/write-definition/fixtures/header-overrides/fern/.definition/pets.yml index f25130e86d3..5560f3dd1cf 100644 --- a/packages/cli/ete-tests/src/tests/write-definition/fixtures/header-overrides/fern/.definition/pets.yml +++ b/packages/cli/ete-tests/src/tests/write-definition/fixtures/header-overrides/fern/.definition/pets.yml @@ -30,6 +30,8 @@ service: limit: docs: How many items to return at one time (max 100) type: optional + validation: + max: 100 response: docs: A paged array of pets type: root.Pets diff --git a/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/neopets/pets.yml b/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/neopets/pets.yml index e388ff71933..a4a02c84255 100644 --- a/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/neopets/pets.yml +++ b/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/neopets/pets.yml @@ -32,6 +32,8 @@ service: limit: docs: How many items to return at one time (max 100) type: optional + validation: + max: 100 response: docs: A paged array of pets type: neopetsRoot.Pets 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 d6acafb693d..8fa053dea56 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 @@ -83,12 +83,16 @@ service: destination: docs: The ID of the destination station type: string + validation: + format: uuid dogs: docs: Only return trips where dogs are known to be allowed type: optional origin: docs: The ID of the origin station type: string + validation: + format: uuid response: docs: A list of available train trips type: GetTripsResponse diff --git a/packages/cli/ete-tests/src/tests/write-definition/fixtures/petstore/fern/.definition/pets.yml b/packages/cli/ete-tests/src/tests/write-definition/fixtures/petstore/fern/.definition/pets.yml index f25130e86d3..5560f3dd1cf 100644 --- a/packages/cli/ete-tests/src/tests/write-definition/fixtures/petstore/fern/.definition/pets.yml +++ b/packages/cli/ete-tests/src/tests/write-definition/fixtures/petstore/fern/.definition/pets.yml @@ -30,6 +30,8 @@ service: limit: docs: How many items to return at one time (max 100) type: optional + validation: + max: 100 response: docs: A paged array of pets type: root.Pets