From 807b43e1a7af81ee21cca4fec3d8e3da5573374f Mon Sep 17 00:00:00 2001 From: Deep Singhvi Date: Thu, 19 Sep 2024 15:48:32 -0400 Subject: [PATCH] fix(cli): fix type reference schemas (#4701) --- fern.schema.dev.json | 416 ++-- fern.schema.json | 416 ++-- packages/cli/cli/versions.yml | 8 + .../writeDefinition.test.ts.snap | 5 - .../fern/.definition/trains/__package__.yml | 5 - .../json-schema/.depcheckrc.json | 10 - .../json-schema/.prettierrc.cjs | 1 - .../fern-definition/json-schema/package.json | 47 - .../fern-definition/json-schema/src/index.ts | 1 - .../json-schema/src/writeFernJsonSchema.ts | 13 - .../fern-definition/json-schema/tsconfig.json | 6 - .../src/schemas/HttpPathParameterSchema.ts | 4 +- .../schema/src/schemas/TypeReferenceSchema.ts | 29 +- .../src/schemas/VariableDeclarationSchema.ts | 11 +- .../schema/src/schemas/index.ts | 6 +- .../schema/src/utils/visitRawPathParameter.ts | 4 +- .../validatePropertyInRequest.ts | 2 +- .../__snapshots__/apiture.test.ts.snap | 110 - .../__test__/__snapshots__/aries.test.ts.snap | 1774 ----------------- .../__test__/__snapshots__/axle.test.ts.snap | 58 - .../__test__/__snapshots__/belvo.test.ts.snap | 422 ---- .../__test__/__snapshots__/deel.test.ts.snap | 2 - .../__snapshots__/devrev.test.ts.snap | 314 --- ...scriminated-union-value-title.test.ts.snap | 4 - .../__snapshots__/flagright.test.ts.snap | 454 ----- .../__snapshots__/humanloop.test.ts.snap | 812 -------- .../__snapshots__/intercom.test.ts.snap | 1772 ---------------- .../__snapshots__/permit.test.ts.snap | 476 ----- .../__snapshots__/rightbrain.test.ts.snap | 452 ----- .../__snapshots__/superagent.test.ts.snap | 34 - .../__snapshots__/valtown.test.ts.snap | 14 - .../src/buildQueryParameter.ts | 2 +- .../src/buildTypeDeclaration.ts | 4 +- .../src/buildTypeReference.ts | 66 +- .../src/utils/getTypeFromTypeReference.ts | 10 +- .../src/utils/wrapTypeReferenceAsOptional.ts | 4 +- packages/scripts/.env-cmdrc.cjs | 1 - packages/scripts/build.cjs | 37 - packages/scripts/package.json | 27 +- packages/scripts/src/cli.ts | 13 +- packages/scripts/tsconfig.json | 2 +- pnpm-lock.yaml | 99 +- 42 files changed, 498 insertions(+), 7449 deletions(-) delete mode 100644 packages/cli/fern-definition/json-schema/.depcheckrc.json delete mode 100644 packages/cli/fern-definition/json-schema/.prettierrc.cjs delete mode 100644 packages/cli/fern-definition/json-schema/package.json delete mode 100644 packages/cli/fern-definition/json-schema/src/index.ts delete mode 100644 packages/cli/fern-definition/json-schema/src/writeFernJsonSchema.ts delete mode 100644 packages/cli/fern-definition/json-schema/tsconfig.json delete mode 100644 packages/scripts/.env-cmdrc.cjs delete mode 100644 packages/scripts/build.cjs diff --git a/fern.schema.dev.json b/fern.schema.dev.json index 3487e9f4056..eb7240f335f 100644 --- a/fern.schema.dev.json +++ b/fern.schema.dev.json @@ -1,4 +1,5 @@ { + "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/Fern Definition", "definitions": { "Fern Definition": { @@ -27,7 +28,7 @@ "type": "object", "properties": { "status": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability/anyOf/0" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability/anyOf/0" }, "message": { "type": "string" } }, @@ -44,7 +45,7 @@ "properties": { "name": { "type": "string" }, "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "value": {} }, @@ -109,7 +110,7 @@ "type": { "type": "string" }, "default": {}, "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, "validation": { "anyOf": [ @@ -136,17 +137,17 @@ } ] }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + }, + "docs": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" } }, "required": ["type"], @@ -163,32 +164,28 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "examples": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" }, "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" - }, - "source": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, + "source": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" }, "extensions": { "type": "object", "additionalProperties": {} }, "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" } }, "extra-properties": { "type": "boolean" } @@ -201,33 +198,23 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" - }, - "examples": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" - }, - "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" - }, - "source": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, + "examples": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" }, + "encoding": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, + "source": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" }, "base-properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" } }, - "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" - }, + "extends": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "union": { "type": "object", "additionalProperties": { @@ -236,12 +223,6 @@ { "type": "object", "properties": { - "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" - }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, "type": { "anyOf": [ { "type": "string" }, @@ -255,7 +236,7 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "value": { "type": "string" } }, @@ -263,7 +244,17 @@ "additionalProperties": false } ] - } + }, + "availability": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + }, + "name": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + }, + "docs": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + }, + "display-name": { "type": "string" } }, "additionalProperties": false } @@ -277,7 +268,7 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "value": { "type": "string" } }, @@ -293,27 +284,19 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" - }, - "examples": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" - }, - "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" - }, - "source": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, + "examples": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" }, + "encoding": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, + "source": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" }, "type": { "type": "string" }, "validation": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" } }, "required": ["type"], @@ -322,24 +305,16 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" - }, - "examples": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" - }, - "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" - }, - "source": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, + "examples": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" }, + "encoding": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, + "source": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" }, "default": { "type": "string" }, "enum": { "type": "array", @@ -350,10 +325,10 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "value": { "type": "string" }, "casing": { @@ -380,24 +355,16 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" - }, - "examples": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" - }, - "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" - }, - "source": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, + "examples": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" }, + "encoding": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, + "source": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" }, "union": { "type": "array", "items": { @@ -407,7 +374,7 @@ "type": "object", "properties": { "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "type": { "type": "string" } }, @@ -429,14 +396,11 @@ "type": "object", "properties": { "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" - }, - "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, + "audiences": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "auth": { "type": "boolean" }, "url": { "type": "string" }, - "display-name": { "type": "string" }, "base-path": { "type": "string" }, "path-parameters": { "type": "object", @@ -451,17 +415,15 @@ "type": { "type": "string" }, "default": {}, "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, "validation": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - } + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" } }, "required": ["type"], "additionalProperties": false @@ -472,12 +434,10 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "variable": { "type": "string" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" } }, "required": ["variable"], @@ -498,22 +458,20 @@ "type": { "type": "string" }, "default": {}, "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, "validation": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" - }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "env": { "type": "string" } }, @@ -542,23 +500,20 @@ "additionalProperties": { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "method": { "type": "string", "enum": ["GET", "POST", "PUT", "PATCH", "DELETE"] }, - "display-name": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "path-parameters": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/path-parameters/additionalProperties" } }, "auth": { "type": "boolean" }, @@ -571,7 +526,7 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "content-type": { "type": "string" }, "query-parameters": { @@ -585,22 +540,22 @@ "type": { "type": "string" }, "default": {}, "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, "validation": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" - }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + }, + "docs": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "allow-multiple": { "type": "boolean" } }, @@ -613,7 +568,7 @@ "headers": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/headers/additionalProperties" + "$ref": "#/properties/service/properties/headers/additionalProperties" } }, "body": { @@ -623,7 +578,7 @@ "type": "object", "properties": { "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "type": { "type": "string" } }, @@ -636,12 +591,42 @@ "type": "object", "properties": { "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "anyOf": [ + { "type": "string" }, + { + "type": "object", + "properties": { + "type": { "type": "string" }, + "default": {}, + "encoding": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" + }, + "validation": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" + }, + "availability": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + }, + "docs": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + }, + "audiences": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + }, + "name": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + }, + "content-type": { "type": "string" } + }, + "required": ["type"], + "additionalProperties": false + } + ] } }, "extra-properties": { "type": "boolean" } @@ -653,12 +638,12 @@ "type": "object", "properties": { "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/request/anyOf/1/properties/body/anyOf/2/anyOf/0/properties/properties/additionalProperties" } }, "extra-properties": { "type": "boolean" } @@ -681,9 +666,7 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "type": { "type": "string" }, "property": { "type": "string" }, "status-code": { "type": "number" } @@ -699,9 +682,7 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "type": { "type": "string" }, "format": { "type": "string", "enum": ["sse", "json"] }, "terminator": { "type": "string" } @@ -720,7 +701,7 @@ "type": "object", "properties": { "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "error": { "type": "string" } }, @@ -736,27 +717,25 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" - }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "id": { "type": "string" }, "path-parameters": { "type": "object", "additionalProperties": {} }, "query-parameters": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "headers": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "request": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" }, "response": { "anyOf": [ @@ -765,7 +744,7 @@ "properties": { "error": { "type": "string" }, "body": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "additionalProperties": false @@ -776,7 +755,7 @@ "stream": { "type": "array", "items": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } } }, @@ -793,7 +772,7 @@ "properties": { "event": { "type": "string" }, "data": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "required": ["event"], @@ -814,10 +793,10 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "sdk": { "type": "string", @@ -849,10 +828,10 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "language": { "type": "string" }, "code": { "type": "string" }, @@ -918,14 +897,18 @@ }, { "type": "boolean" } ] + }, + "display-name": { + "$ref": "#/properties/types/additionalProperties/anyOf/2/properties/union/additionalProperties/anyOf/1/properties/display-name" } }, "required": ["path"], "additionalProperties": false } }, - "source": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" + "source": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" }, + "display-name": { + "$ref": "#/properties/types/additionalProperties/anyOf/2/properties/union/additionalProperties/anyOf/1/properties/display-name" } }, "required": ["auth", "base-path", "endpoints"], @@ -936,22 +919,15 @@ "additionalProperties": { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" - }, - "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, + "audiences": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "method": { "type": "string", "enum": ["GET", "POST"] }, - "display-name": { "type": "string" }, "headers": { "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/headers/additionalProperties" - } + "additionalProperties": { "$ref": "#/properties/service/properties/headers/additionalProperties" } }, "payload": { "anyOf": [ @@ -959,9 +935,7 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "type": { "type": "string" } }, "required": ["type"], @@ -974,12 +948,12 @@ "properties": { "name": { "type": "string" }, "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" } } }, @@ -991,12 +965,12 @@ "properties": { "name": { "type": "string" }, "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" } } }, @@ -1013,18 +987,19 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" - }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "id": { "type": "string" }, "payload": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "additionalProperties": false } + }, + "display-name": { + "$ref": "#/properties/types/additionalProperties/anyOf/2/properties/union/additionalProperties/anyOf/1/properties/display-name" } }, "required": ["method", "payload"], @@ -1034,34 +1009,25 @@ "channel": { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" - }, - "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, + "audiences": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "auth": { "type": "boolean" }, "path": { "type": "string" }, - "display-name": { "type": "string" }, "headers": { "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/headers/additionalProperties" - } + "additionalProperties": { "$ref": "#/properties/service/properties/headers/additionalProperties" } }, "path-parameters": { "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/path-parameters/additionalProperties" - } + "additionalProperties": { "$ref": "#/properties/service/properties/path-parameters/additionalProperties" } }, "query-parameters": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/request/anyOf/1/properties/query-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/request/anyOf/1/properties/query-parameters/additionalProperties" } }, "messages": { @@ -1069,14 +1035,12 @@ "additionalProperties": { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "origin": { "type": "string", "enum": ["client", "server"] }, "body": { @@ -1085,9 +1049,7 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "type": { "type": "string" } }, "required": ["type"], @@ -1100,12 +1062,12 @@ "properties": { "name": { "type": "string" }, "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" } } }, @@ -1117,12 +1079,12 @@ "properties": { "name": { "type": "string" }, "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" } } }, @@ -1133,7 +1095,9 @@ } ] }, - "display-name": { "type": "string" } + "display-name": { + "$ref": "#/properties/types/additionalProperties/anyOf/2/properties/union/additionalProperties/anyOf/1/properties/display-name" + } }, "required": ["origin", "body"], "additionalProperties": false @@ -1145,27 +1109,25 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" - }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "path-parameters": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "query-parameters": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "headers": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "messages": { @@ -1181,6 +1143,9 @@ "required": ["messages"], "additionalProperties": false } + }, + "display-name": { + "$ref": "#/properties/types/additionalProperties/anyOf/2/properties/union/additionalProperties/anyOf/1/properties/display-name" } }, "required": ["auth", "path"], @@ -1191,16 +1156,12 @@ "additionalProperties": { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "status-code": { "type": "number" }, "type": { "type": "string" }, "examples": { "type": "array", - "items": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items" - } + "items": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items" } } }, "required": ["status-code"], @@ -1210,6 +1171,5 @@ }, "additionalProperties": false } - }, - "$schema": "http://json-schema.org/draft-07/schema#" + } } diff --git a/fern.schema.json b/fern.schema.json index 3487e9f4056..eb7240f335f 100644 --- a/fern.schema.json +++ b/fern.schema.json @@ -1,4 +1,5 @@ { + "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/Fern Definition", "definitions": { "Fern Definition": { @@ -27,7 +28,7 @@ "type": "object", "properties": { "status": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability/anyOf/0" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability/anyOf/0" }, "message": { "type": "string" } }, @@ -44,7 +45,7 @@ "properties": { "name": { "type": "string" }, "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "value": {} }, @@ -109,7 +110,7 @@ "type": { "type": "string" }, "default": {}, "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, "validation": { "anyOf": [ @@ -136,17 +137,17 @@ } ] }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + }, + "docs": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" } }, "required": ["type"], @@ -163,32 +164,28 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "examples": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" }, "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" - }, - "source": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, + "source": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" }, "extensions": { "type": "object", "additionalProperties": {} }, "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" } }, "extra-properties": { "type": "boolean" } @@ -201,33 +198,23 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" - }, - "examples": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" - }, - "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" - }, - "source": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, + "examples": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" }, + "encoding": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, + "source": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" }, "base-properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" } }, - "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" - }, + "extends": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "union": { "type": "object", "additionalProperties": { @@ -236,12 +223,6 @@ { "type": "object", "properties": { - "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" - }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, "type": { "anyOf": [ { "type": "string" }, @@ -255,7 +236,7 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "value": { "type": "string" } }, @@ -263,7 +244,17 @@ "additionalProperties": false } ] - } + }, + "availability": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + }, + "name": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + }, + "docs": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + }, + "display-name": { "type": "string" } }, "additionalProperties": false } @@ -277,7 +268,7 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "value": { "type": "string" } }, @@ -293,27 +284,19 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" - }, - "examples": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" - }, - "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" - }, - "source": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, + "examples": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" }, + "encoding": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, + "source": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" }, "type": { "type": "string" }, "validation": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" } }, "required": ["type"], @@ -322,24 +305,16 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" - }, - "examples": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" - }, - "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" - }, - "source": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, + "examples": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" }, + "encoding": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, + "source": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" }, "default": { "type": "string" }, "enum": { "type": "array", @@ -350,10 +325,10 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "value": { "type": "string" }, "casing": { @@ -380,24 +355,16 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" - }, - "examples": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" - }, - "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" - }, - "source": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, + "examples": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples" }, + "encoding": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, + "source": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" }, "union": { "type": "array", "items": { @@ -407,7 +374,7 @@ "type": "object", "properties": { "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "type": { "type": "string" } }, @@ -429,14 +396,11 @@ "type": "object", "properties": { "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" - }, - "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, + "audiences": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "auth": { "type": "boolean" }, "url": { "type": "string" }, - "display-name": { "type": "string" }, "base-path": { "type": "string" }, "path-parameters": { "type": "object", @@ -451,17 +415,15 @@ "type": { "type": "string" }, "default": {}, "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, "validation": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - } + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" } }, "required": ["type"], "additionalProperties": false @@ -472,12 +434,10 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "variable": { "type": "string" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" } }, "required": ["variable"], @@ -498,22 +458,20 @@ "type": { "type": "string" }, "default": {}, "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, "validation": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" - }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "env": { "type": "string" } }, @@ -542,23 +500,20 @@ "additionalProperties": { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "method": { "type": "string", "enum": ["GET", "POST", "PUT", "PATCH", "DELETE"] }, - "display-name": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "path-parameters": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/path-parameters/additionalProperties" } }, "auth": { "type": "boolean" }, @@ -571,7 +526,7 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "content-type": { "type": "string" }, "query-parameters": { @@ -585,22 +540,22 @@ "type": { "type": "string" }, "default": {}, "encoding": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" }, "validation": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" - }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + }, + "docs": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "allow-multiple": { "type": "boolean" } }, @@ -613,7 +568,7 @@ "headers": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/headers/additionalProperties" + "$ref": "#/properties/service/properties/headers/additionalProperties" } }, "body": { @@ -623,7 +578,7 @@ "type": "object", "properties": { "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "type": { "type": "string" } }, @@ -636,12 +591,42 @@ "type": "object", "properties": { "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "anyOf": [ + { "type": "string" }, + { + "type": "object", + "properties": { + "type": { "type": "string" }, + "default": {}, + "encoding": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/encoding" + }, + "validation": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties/anyOf/1/properties/validation" + }, + "availability": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + }, + "docs": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + }, + "audiences": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + }, + "name": { + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + }, + "content-type": { "type": "string" } + }, + "required": ["type"], + "additionalProperties": false + } + ] } }, "extra-properties": { "type": "boolean" } @@ -653,12 +638,12 @@ "type": "object", "properties": { "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/request/anyOf/1/properties/body/anyOf/2/anyOf/0/properties/properties/additionalProperties" } }, "extra-properties": { "type": "boolean" } @@ -681,9 +666,7 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "type": { "type": "string" }, "property": { "type": "string" }, "status-code": { "type": "number" } @@ -699,9 +682,7 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "type": { "type": "string" }, "format": { "type": "string", "enum": ["sse", "json"] }, "terminator": { "type": "string" } @@ -720,7 +701,7 @@ "type": "object", "properties": { "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "error": { "type": "string" } }, @@ -736,27 +717,25 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" - }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "id": { "type": "string" }, "path-parameters": { "type": "object", "additionalProperties": {} }, "query-parameters": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "headers": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "request": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" }, "response": { "anyOf": [ @@ -765,7 +744,7 @@ "properties": { "error": { "type": "string" }, "body": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "additionalProperties": false @@ -776,7 +755,7 @@ "stream": { "type": "array", "items": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } } }, @@ -793,7 +772,7 @@ "properties": { "event": { "type": "string" }, "data": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "required": ["event"], @@ -814,10 +793,10 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "sdk": { "type": "string", @@ -849,10 +828,10 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "language": { "type": "string" }, "code": { "type": "string" }, @@ -918,14 +897,18 @@ }, { "type": "boolean" } ] + }, + "display-name": { + "$ref": "#/properties/types/additionalProperties/anyOf/2/properties/union/additionalProperties/anyOf/1/properties/display-name" } }, "required": ["path"], "additionalProperties": false } }, - "source": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" + "source": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/source" }, + "display-name": { + "$ref": "#/properties/types/additionalProperties/anyOf/2/properties/union/additionalProperties/anyOf/1/properties/display-name" } }, "required": ["auth", "base-path", "endpoints"], @@ -936,22 +919,15 @@ "additionalProperties": { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" - }, - "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, + "audiences": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "method": { "type": "string", "enum": ["GET", "POST"] }, - "display-name": { "type": "string" }, "headers": { "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/headers/additionalProperties" - } + "additionalProperties": { "$ref": "#/properties/service/properties/headers/additionalProperties" } }, "payload": { "anyOf": [ @@ -959,9 +935,7 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "type": { "type": "string" } }, "required": ["type"], @@ -974,12 +948,12 @@ "properties": { "name": { "type": "string" }, "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" } } }, @@ -991,12 +965,12 @@ "properties": { "name": { "type": "string" }, "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" } } }, @@ -1013,18 +987,19 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" - }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "id": { "type": "string" }, "payload": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "additionalProperties": false } + }, + "display-name": { + "$ref": "#/properties/types/additionalProperties/anyOf/2/properties/union/additionalProperties/anyOf/1/properties/display-name" } }, "required": ["method", "payload"], @@ -1034,34 +1009,25 @@ "channel": { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" - }, - "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, + "audiences": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "auth": { "type": "boolean" }, "path": { "type": "string" }, - "display-name": { "type": "string" }, "headers": { "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/headers/additionalProperties" - } + "additionalProperties": { "$ref": "#/properties/service/properties/headers/additionalProperties" } }, "path-parameters": { "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/path-parameters/additionalProperties" - } + "additionalProperties": { "$ref": "#/properties/service/properties/path-parameters/additionalProperties" } }, "query-parameters": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/request/anyOf/1/properties/query-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/request/anyOf/1/properties/query-parameters/additionalProperties" } }, "messages": { @@ -1069,14 +1035,12 @@ "additionalProperties": { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "availability": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/availability" }, "audiences": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/audiences" }, "origin": { "type": "string", "enum": ["client", "server"] }, "body": { @@ -1085,9 +1049,7 @@ { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "type": { "type": "string" } }, "required": ["type"], @@ -1100,12 +1062,12 @@ "properties": { "name": { "type": "string" }, "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" } } }, @@ -1117,12 +1079,12 @@ "properties": { "name": { "type": "string" }, "extends": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/extends" }, "properties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/properties/additionalProperties" } } }, @@ -1133,7 +1095,9 @@ } ] }, - "display-name": { "type": "string" } + "display-name": { + "$ref": "#/properties/types/additionalProperties/anyOf/2/properties/union/additionalProperties/anyOf/1/properties/display-name" + } }, "required": ["origin", "body"], "additionalProperties": false @@ -1145,27 +1109,25 @@ "type": "object", "properties": { "name": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" - }, - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" + "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items/properties/name" }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "path-parameters": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "query-parameters": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "headers": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/Fern Definition/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" + "$ref": "#/properties/service/properties/endpoints/additionalProperties/properties/examples/items/properties/path-parameters/additionalProperties" } }, "messages": { @@ -1181,6 +1143,9 @@ "required": ["messages"], "additionalProperties": false } + }, + "display-name": { + "$ref": "#/properties/types/additionalProperties/anyOf/2/properties/union/additionalProperties/anyOf/1/properties/display-name" } }, "required": ["auth", "path"], @@ -1191,16 +1156,12 @@ "additionalProperties": { "type": "object", "properties": { - "docs": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" - }, + "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" }, "status-code": { "type": "number" }, "type": { "type": "string" }, "examples": { "type": "array", - "items": { - "$ref": "#/definitions/Fern Definition/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items" - } + "items": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/examples/items" } } }, "required": ["status-code"], @@ -1210,6 +1171,5 @@ }, "additionalProperties": false } - }, - "$schema": "http://json-schema.org/draft-07/schema#" + } } diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml index f373b04ab93..18bdcc5d86c 100644 --- a/packages/cli/cli/versions.yml +++ b/packages/cli/cli/versions.yml @@ -1,3 +1,11 @@ +- changelogEntry: + - summary: | + Previously, the OpenAPI converter would bring over `title` on every + single property. This field is extraneous, so now we ignore it. + type: fix + irVersion: 53 + version: 0.42.10 + - changelogEntry: - summary: | Previously, the OpenAPI importer would ignore skip parsing arbitrary 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 f4cafbdd012..3eeec705a34 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 @@ -743,17 +743,13 @@ types: docs: Four-digit number representing the card's expiration year. address_line1: type: optional - display-name: Card address_line2: type: optional - display-name: Card address_city: type: optional - display-name: Card address_country: string address_post_code: type: optional - display-name: Card source: openapi: openapi/trains/openapi.yml BookingPaymentSourceBankAccountAccountType: @@ -781,7 +777,6 @@ types: docs: >- The sort code for the bank account, in string form. Must be a six-digit number. - display-name: Bank Account account_type: type: BookingPaymentSourceBankAccountAccountType docs: >- diff --git a/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/trains/__package__.yml b/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/trains/__package__.yml index 17ca8a3b966..c674f345484 100644 --- a/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/trains/__package__.yml +++ b/packages/cli/ete-tests/src/tests/write-definition/fixtures/namespaced/fern/.definition/trains/__package__.yml @@ -250,17 +250,13 @@ types: docs: Four-digit number representing the card's expiration year. address_line1: type: optional - display-name: Card address_line2: type: optional - display-name: Card address_city: type: optional - display-name: Card address_country: string address_post_code: type: optional - display-name: Card source: openapi: openapi/trains/openapi.yml BookingPaymentSourceBankAccountAccountType: @@ -288,7 +284,6 @@ types: docs: >- The sort code for the bank account, in string form. Must be a six-digit number. - display-name: Bank Account account_type: type: BookingPaymentSourceBankAccountAccountType docs: >- diff --git a/packages/cli/fern-definition/json-schema/.depcheckrc.json b/packages/cli/fern-definition/json-schema/.depcheckrc.json deleted file mode 100644 index a3a4f43188c..00000000000 --- a/packages/cli/fern-definition/json-schema/.depcheckrc.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "ignores": [ - "@types/jest", - "globals", - "@types/node" - ], - "ignore-patterns": [ - "lib" - ] -} \ No newline at end of file diff --git a/packages/cli/fern-definition/json-schema/.prettierrc.cjs b/packages/cli/fern-definition/json-schema/.prettierrc.cjs deleted file mode 100644 index 9b6214d5129..00000000000 --- a/packages/cli/fern-definition/json-schema/.prettierrc.cjs +++ /dev/null @@ -1 +0,0 @@ -module.exports = require("../../../../.prettierrc.json"); diff --git a/packages/cli/fern-definition/json-schema/package.json b/packages/cli/fern-definition/json-schema/package.json deleted file mode 100644 index abc9970507a..00000000000 --- a/packages/cli/fern-definition/json-schema/package.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "name": "@fern-api/fern-definition-json-schema", - "version": "0.0.0", - "repository": { - "type": "git", - "url": "https://github.com/fern-api/fern.git", - "directory": "packages/cli/yaml/json-schema" - }, - "private": true, - "files": [ - "lib" - ], - "type": "module", - "source": "src/index.ts", - "main": "lib/index.js", - "types": "lib/index.d.ts", - "sideEffects": false, - "scripts": { - "clean": "rm -rf ./lib && tsc --build --clean", - "compile": "tsc --build", - "test": "vitest --passWithNoTests --run", - "test:update": "vitest --passWithNoTests --run -u", - "lint:eslint": "eslint --max-warnings 0 . --ignore-path=../../../../.eslintignore", - "lint:eslint:fix": "yarn lint:eslint --fix", - "format": "prettier --write --ignore-unknown --ignore-path ../../../../shared/.prettierignore \"**\"", - "format:check": "prettier --check --ignore-unknown --ignore-path ../../../../shared/.prettierignore \"**\"", - "organize-imports": "organize-imports-cli tsconfig.json", - "depcheck": "depcheck" - }, - "dependencies": { - "@fern-api/fs-utils": "workspace:*", - "@fern-api/fern-definition-schema": "workspace:*", - "prettier": "^2.7.1", - "zod": "^3.22.3", - "zod-to-json-schema": "3.14.1" - }, - "devDependencies": { - "@types/jest": "^29.5.12", - "@types/node": "^18.7.18", - "@types/prettier": "^2.7.1", - "depcheck": "^1.4.6", - "eslint": "^8.56.0", - "vitest": "^2.0.5", - "organize-imports-cli": "^0.10.0", - "typescript": "4.6.4" - } -} \ No newline at end of file diff --git a/packages/cli/fern-definition/json-schema/src/index.ts b/packages/cli/fern-definition/json-schema/src/index.ts deleted file mode 100644 index 784bd83c656..00000000000 --- a/packages/cli/fern-definition/json-schema/src/index.ts +++ /dev/null @@ -1 +0,0 @@ -export { writeFernJsonSchema } from "./writeFernJsonSchema"; diff --git a/packages/cli/fern-definition/json-schema/src/writeFernJsonSchema.ts b/packages/cli/fern-definition/json-schema/src/writeFernJsonSchema.ts deleted file mode 100644 index 9bdcddd468a..00000000000 --- a/packages/cli/fern-definition/json-schema/src/writeFernJsonSchema.ts +++ /dev/null @@ -1,13 +0,0 @@ -import { AbsoluteFilePath } from "@fern-api/fs-utils"; -import { DefinitionFileSchema } from "@fern-api/fern-definition-schema"; -import { writeFile } from "fs/promises"; -import prettier from "prettier"; -import { zodToJsonSchema } from "zod-to-json-schema"; - -export async function writeFernJsonSchema(filepath: AbsoluteFilePath): Promise { - const jsonSchema = zodToJsonSchema(DefinitionFileSchema, "Fern Definition"); - const jsonSchemaStr = JSON.stringify(jsonSchema); - const config = (await prettier.resolveConfig(filepath)) ?? undefined; - const jsonSchemaFormatted = prettier.format(jsonSchemaStr, { ...config, filepath }); - await writeFile(filepath, jsonSchemaFormatted); -} diff --git a/packages/cli/fern-definition/json-schema/tsconfig.json b/packages/cli/fern-definition/json-schema/tsconfig.json deleted file mode 100644 index c54b03276df..00000000000 --- a/packages/cli/fern-definition/json-schema/tsconfig.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "extends": "../../../../shared/tsconfig.shared.json", - "compilerOptions": { "composite": true, "outDir": "lib", "rootDir": "src", "module": "CommonJS", "target": "es2015"}, - "include": ["./src/**/*"], - "references": [{ "path": "../../../commons/fs-utils" }, { "path": "../schema" }] -} diff --git a/packages/cli/fern-definition/schema/src/schemas/HttpPathParameterSchema.ts b/packages/cli/fern-definition/schema/src/schemas/HttpPathParameterSchema.ts index 48827dc3689..4c8914ae7fe 100644 --- a/packages/cli/fern-definition/schema/src/schemas/HttpPathParameterSchema.ts +++ b/packages/cli/fern-definition/schema/src/schemas/HttpPathParameterSchema.ts @@ -1,9 +1,9 @@ import { z } from "zod"; -import { TypeReferenceWithDocsAndAvailabilitySchema } from "./TypeReferenceSchema"; +import { TypeReferenceSchema } from "./TypeReferenceSchema"; import { VariableReferenceSchema } from "./VariableReferenceSchema"; export const HttpPathParameterSchema = z.union([ - TypeReferenceWithDocsAndAvailabilitySchema, + TypeReferenceSchema, // pathParam: $myVariable z.string(), VariableReferenceSchema diff --git a/packages/cli/fern-definition/schema/src/schemas/TypeReferenceSchema.ts b/packages/cli/fern-definition/schema/src/schemas/TypeReferenceSchema.ts index 85b1a78b859..beb3907e314 100644 --- a/packages/cli/fern-definition/schema/src/schemas/TypeReferenceSchema.ts +++ b/packages/cli/fern-definition/schema/src/schemas/TypeReferenceSchema.ts @@ -3,8 +3,7 @@ import { DeclarationSchema } from "./DeclarationSchema"; import { DeclarationWithNameSchema } from "./DeclarationWithNameSchema"; import { EncodingSchema } from "./EncodingSchema"; import { ValidationSchema } from "./ValidationSchema"; -import { WithDisplayNameSchema } from "./WithDisplayNameSchema"; -import { WithDocsAndAvailabilitySchema } from "./WithDocsAndAvailability"; +import { WithAvailabilitySchema } from "./WithAvailabilitySchema"; import { WithDocsSchema } from "./WithDocsSchema"; // This return type is too crazy to write explicitly! @@ -19,28 +18,15 @@ export function extendTypeReferenceSchema(extension: T) encoding: z.optional(EncodingSchema), validation: z.optional(ValidationSchema) }) + .extend(WithAvailabilitySchema.shape) + .extend(WithDocsSchema.shape) .extend(extension) ]); } -export const TypeReferenceSchema = extendTypeReferenceSchema({}); +export const TypeReferenceSchema = extendTypeReferenceSchema(z.object({}).shape); export type TypeReferenceSchema = z.infer; -export const TypeReferenceWithDocsSchema = extendTypeReferenceSchema(WithDocsSchema.shape); -export type TypeReferenceWithDocsSchema = z.infer; - -export const TypeReferenceWithDocsAndAvailabilitySchema = extendTypeReferenceSchema( - WithDocsAndAvailabilitySchema.shape -); -export type TypeReferenceWithDocsAndAvailabilitySchema = z.infer; - -export const TypeReferenceWithDocsAndDisplayNameAndAvailabilitySchema = extendTypeReferenceSchema( - WithDocsAndAvailabilitySchema.extend(WithDisplayNameSchema.shape).shape -); -export type TypeReferenceWithDocsAndDisplayNameAndAvailabilitySchema = z.infer< - typeof TypeReferenceWithDocsAndDisplayNameAndAvailabilitySchema ->; - export const TypeReferenceDeclarationSchema = extendTypeReferenceSchema(DeclarationSchema.shape); export type TypeReferenceDeclarationSchema = z.infer; @@ -53,10 +39,3 @@ export const TypeReferenceDeclarationWithEnvOverride = extendTypeReferenceSchema }).shape ); export type TypeReferenceDeclarationWithEnvOverride = z.infer; - -export const TypeReferenceWithDefaultAndValidationSchema = z.strictObject({ - type: z.string(), - default: z.unknown().optional(), - validation: z.optional(ValidationSchema) -}); -export type TypeReferenceWithDefaultAndValidationSchema = z.infer; diff --git a/packages/cli/fern-definition/schema/src/schemas/VariableDeclarationSchema.ts b/packages/cli/fern-definition/schema/src/schemas/VariableDeclarationSchema.ts index a3c91e2ab71..b4ae4157558 100644 --- a/packages/cli/fern-definition/schema/src/schemas/VariableDeclarationSchema.ts +++ b/packages/cli/fern-definition/schema/src/schemas/VariableDeclarationSchema.ts @@ -1,6 +1,13 @@ import { z } from "zod"; -import { TypeReferenceWithDocsSchema } from "./TypeReferenceSchema"; +import { WithDocsSchema } from "./WithDocsSchema"; -export const VariableDeclarationSchema = TypeReferenceWithDocsSchema; +export const VariableDeclarationSchema = z.union([ + z.string(), + z + .strictObject({ + type: z.string() + }) + .extend(WithDocsSchema.shape) +]); export type VariableDeclarationSchema = z.infer; diff --git a/packages/cli/fern-definition/schema/src/schemas/index.ts b/packages/cli/fern-definition/schema/src/schemas/index.ts index 9f531ed1e5d..412f30848b8 100644 --- a/packages/cli/fern-definition/schema/src/schemas/index.ts +++ b/packages/cli/fern-definition/schema/src/schemas/index.ts @@ -74,11 +74,7 @@ export { StatusCodeErrorDiscriminationSchema } from "./StatusCodeErrorDiscrimina export { StringValidationSchema } from "./StringValidationSchema"; export { TransportSchema } from "./TransportSchema"; export { TypeDeclarationSchema } from "./TypeDeclarationSchema"; -export { - TypeReferenceSchema, - TypeReferenceWithDocsSchema, - TypeReferenceWithDocsAndDisplayNameAndAvailabilitySchema -} from "./TypeReferenceSchema"; +export { TypeReferenceSchema } from "./TypeReferenceSchema"; export { UndiscriminatedUnionSchema } from "./UndiscriminatedUnionSchema"; export { ValidationSchema } from "./ValidationSchema"; export { VariableDeclarationSchema } from "./VariableDeclarationSchema"; diff --git a/packages/cli/fern-definition/schema/src/utils/visitRawPathParameter.ts b/packages/cli/fern-definition/schema/src/utils/visitRawPathParameter.ts index 6fac38f815d..34d61d4ded4 100644 --- a/packages/cli/fern-definition/schema/src/utils/visitRawPathParameter.ts +++ b/packages/cli/fern-definition/schema/src/utils/visitRawPathParameter.ts @@ -1,9 +1,9 @@ import { HttpPathParameterSchema } from "../schemas"; -import { TypeReferenceWithDocsSchema } from "../schemas/TypeReferenceSchema"; +import { TypeReferenceSchema } from "../schemas/TypeReferenceSchema"; import { VariableReferenceSchema } from "../schemas/VariableReferenceSchema"; export interface PathParameterDeclarationVisitor { - nonVariable: (pathParameter: TypeReferenceWithDocsSchema) => R; + nonVariable: (pathParameter: TypeReferenceSchema) => R; variable: (pathParameter: VariableReferenceSchema | string) => R; } diff --git a/packages/cli/fern-definition/validator/src/utils/property-validator/validatePropertyInRequest.ts b/packages/cli/fern-definition/validator/src/utils/property-validator/validatePropertyInRequest.ts index 487682c2ebc..f091488775e 100644 --- a/packages/cli/fern-definition/validator/src/utils/property-validator/validatePropertyInRequest.ts +++ b/packages/cli/fern-definition/validator/src/utils/property-validator/validatePropertyInRequest.ts @@ -85,7 +85,7 @@ export function validatePropertyInRequest({ return validatePropertyInType({ path, typeResolver, file, resolvedType: resolvedBodyPropertyType, validate }); } -function getTypeFromTypeReference(typeReference: RawSchemas.TypeReferenceWithDocsSchema): string { +function getTypeFromTypeReference(typeReference: RawSchemas.TypeReferenceSchema): string { if (typeof typeReference === "string") { return typeReference; } diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/apiture.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/apiture.test.ts.snap index 9cf0908a7c5..ea8dfe7a50f 100644 --- a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/apiture.test.ts.snap +++ b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/apiture.test.ts.snap @@ -3565,7 +3565,6 @@ This error response may have one of the following \`type\` values: }, }, "nextPage_url": { - "display-name": "Abstract Paged Body Fields (v1.1.0)", "docs": "The URL of the next page of resources. If this URL is omitted, there are no more resources in the collection.", "type": "optional", "validation": { @@ -3660,17 +3659,14 @@ This error response may have one of the following \`type\` values: "docs": "The current balances of the given account.", "properties": { "available": { - "display-name": "Account Balance (v1.0.0)", "docs": "The available balance: the funds available for use. This is the string representation of the exact decimal amount.", "type": "optional", }, "current": { - "display-name": "Account Balance (v1.0.0)", "docs": "The current balance. This is the balance at the end of the previous business day. This is the string representation of the exact decimal amount.", "type": "optional", }, "currentWithPending": { - "display-name": "Account Balance (v1.0.0)", "docs": "The current balance, with posted transactions. This is the string representation of the exact decimal amount.", "type": "optional", }, @@ -3683,7 +3679,6 @@ This error response may have one of the following \`type\` values: "type": "boolean", }, "updatedAt": { - "display-name": "Account Balance (v1.0.0)", "docs": "The time when the balance values were last updated from the banking core.", "type": "optional", }, @@ -3734,7 +3729,6 @@ This error response may have one of the following \`type\` values: "type": "MaskedAccountNumber", }, "nickname": { - "display-name": "Account Fields (v1.0.1)", "type": "optional", }, "product": { @@ -4106,7 +4100,6 @@ Account transfers are only allowed between \`internal\` and \`external\` account }, }, "address2": { - "display-name": "Address Fields (v1.1.0)", "docs": "The second line of the street address. This should only be used if it has a value. Typical values include building numbers, suite numbers, and other identifying information beyond the first line of the postal address.", "type": "optional", "validation": { @@ -4155,39 +4148,32 @@ Account transfers are only allowed between \`internal\` and \`external\` account "docs": "API problem or error, as per [RFC 7807 application/problem+json](https://tools.ietf.org/html/rfc7807).", "properties": { "attributes": { - "display-name": "API Problem (v1.1.0)", "docs": "Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.", "type": "optional>", }, "detail": { - "display-name": "API Problem (v1.1.0)", "docs": "A human-readable explanation specific to this occurrence of the problem. ", "type": "optional", }, "id": { - "display-name": "API Problem (v1.1.0)", "docs": "The unique identifier for this problem. This is an immutable opaque string.", "type": "optional", }, "instance": { - "display-name": "API Problem (v1.1.0)", "docs": "A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment ", "type": "optional", }, "occurredAt": { - "display-name": "API Problem (v1.1.0)", "docs": "The timestamp when the problem occurred, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time \`YYYY-MM-DDThh:mm:ss.sssZ\` format, UTC.", "type": "optional", }, "problems": { - "display-name": "API Problem (v1.1.0)", "docs": "Optional root-causes if there are multiple problems in the request or API call processing.", "type": "optional>", }, "status": { - "display-name": "API Problem (v1.1.0)", "docs": "The [HTTP status code](https://datatracker.ietf.org/doc/html/rfc7231#section-6) for this occurrence of the problem. ", "type": "optional", @@ -4200,13 +4186,11 @@ Account transfers are only allowed between \`internal\` and \`external\` account }, }, "title": { - "display-name": "API Problem (v1.1.0)", "docs": "A short, human-readable summary of the problem type. The title is usually the same for all problem with the same \`type\`. ", "type": "optional", }, "type": { - "display-name": "API Problem (v1.1.0)", "docs": "A [URI reference (RFC3986)](https://tools.ietf.org/html/rfc3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be \`"about:blank"\`. ", "type": "optional", @@ -4220,12 +4204,10 @@ Account transfers are only allowed between \`internal\` and \`external\` account "docs": "An challenge factor. See [\`requiredIdentityChallenge\`](#schema-requiredIdentityChallenge) for multiple examples.", "properties": { "labels": { - "display-name": "Challenge Factor (v1.0.0)", "docs": "A list of text label which identifies the channel(s) though which the user completes the challenge. For an \`sms\` or \`voice\` challenge, the only label item is the last four digits of the corresponding phone number. For an \`email\` challenge, each label is the masked email address.", "type": "optional>", }, "securityQuestions": { - "display-name": "Challenge Factor (v1.0.0)", "type": "optional", }, "type": { @@ -4721,7 +4703,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "properties": { "disallowDebitCardAccess": { "default": false, - "display-name": "Joint Owner Invitation Fields (v1.0.0)", "docs": "If \`true\`, the invitee is not allowed to order or manage debit cards for the account.", "type": "optional", }, @@ -4766,7 +4747,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "taxId": { - "display-name": "Joint Owner Invitation Fields (v1.0.0)", "docs": "The last 4 digits of the invitee's tax ID number (Social Security Number). This is not sent in the invitation email, but if the invitee enrolls in digital banking, this identification must match the last four digits of the tax ID they use to enroll.", "type": "optional", "validation": { @@ -4805,12 +4785,10 @@ The client can use this value to localize the \`items[].time\` values to the loc "docs": "Fields of an overdraft protection account, used to compose other schemas.", "properties": { "id": { - "display-name": "Overdraft Account Fields (v1.0.0)", "docs": "The unique ID of the account resource. Use this as the \`{accountId}\` in [\`getAccount\`](#op-getAccount) or [\`listAccountBalances\`](#op-listAccountBalances).", "type": "optional", }, "label": { - "display-name": "Overdraft Account Fields (v1.0.0)", "docs": "The human-readable label for this account. This is either the \`nickname\` (if assigned for the current customer), or the \`product.label\` concatenated with the \`maskedNumber\`.", "type": "optional", "validation": { @@ -4821,7 +4799,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "maskedNumber": { - "display-name": "Overdraft Account Fields (v1.0.0)", "type": "optional", }, }, @@ -4861,7 +4838,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "docs": "Fields used to compose other overdraft protection schemas.", "properties": { "accounts": { - "display-name": "Overdraft Protection Fields (v1.0.0)", "type": "optional", }, }, @@ -4989,7 +4965,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "type": "ResourceId", }, "ReadOnlyTimestamp": { - "display-name": "Read-Only Timestamp (v1.0.0)", "docs": "A readonly or derived timestamp (an instant in time) formatted in [RFC 3339](https://tools.ietf.org/html/rfc3339) \`date-time\` UTC format: \`YYYY-MM-DDThh:mm:ss.sssZ\`.
The schema \`readOnlyTimestamp\` was added on version \`0.4.0\` of the API.", "type": "datetime", }, @@ -5075,12 +5050,10 @@ The client can use this value to localize the \`items[].time\` values to the loc "docs": "Timestamps which describe when a resource was created or last updated.", "properties": { "createdAt": { - "display-name": "Timestamp Fields (v1.0.0)", "docs": "The date-time when this resource was created, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time \`YYYY-MM-DDThh:mm:ss.sssZ\` format, UTC. This is derived and immutable.", "type": "optional", }, "updatedAt": { - "display-name": "Timestamp Fields (v1.0.0)", "docs": "The date-time when the resource was last updated, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time \`YYYY-MM-DDThh:mm:ss.sssZ\` format, UTC. This is derived and immutable.", "type": "optional", }, @@ -5183,7 +5156,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "docs": "Describes a check associated with a transaction for a checking account. This object is only present if the transaction \`type\` is \`debit\` and the \`subtype\` is \`check\`.", "properties": { "imageBack_url": { - "display-name": "Transaction Check (v2.0.0)", "docs": "The URL for downloading the image of the front of the check.", "type": "optional", "validation": { @@ -5194,7 +5166,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "imageFront_url": { - "display-name": "Transaction Check (v2.0.0)", "docs": "The URL for downloading the image of the front of the check.", "type": "optional", "validation": { @@ -5229,22 +5200,18 @@ The client can use this value to localize the \`items[].time\` values to the loc "type": "CreditOrDebitValue", }, "balance": { - "display-name": "Transaction Fields (v2.1.1)", "docs": "The account's running current balance as of this transaction. The \`balance\` may be omitted if the request includes filters which preclude the inclusion of a running balance.", "type": "optional", }, "category": { - "display-name": "Transaction Fields (v2.1.1)", "docs": "The transaction category, if assigned.", "type": "optional", }, "check": { - "display-name": "Transaction Fields (v2.1.1)", "type": "optional", }, "createdOn": { "availability": "deprecated", - "display-name": "Transaction Fields (v2.1.1)", "docs": "The date when the transaction occurred in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) \`date\` format. This is derived and immutable.
**Warning**: The property \`createdOn\` was deprecated on version \`v2.1.0\` of the schema. Use the \`occurredOn\` property instead. \`createdOn\` will be removed on version \`v3.0.0\` of the schema.", "type": "optional", "validation": { @@ -5255,7 +5222,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "description": { - "display-name": "Transaction Fields (v2.1.1)", "docs": "The transaction description assigned by the transaction cleansing service.", "type": "optional", "validation": { @@ -5276,7 +5242,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "memo": { - "display-name": "Transaction Fields (v2.1.1)", "docs": "The user-settable transaction memo.", "type": "optional", "validation": { @@ -5287,7 +5252,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "merchant": { - "display-name": "Transaction Fields (v2.1.1)", "type": "optional", }, "occurredOn": { @@ -5301,13 +5265,11 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "posted": { - "display-name": "Transaction Fields (v2.1.1)", "docs": "If \`true\`, the transaction has been posted (cleared) and applied to the account. If \`false\`, the transaction is still pending and might be canceled. \`posted\` is only valid for credit and debit transactions and omitted for balance transactions.", "type": "optional", }, "postedOn": { "availability": "deprecated", - "display-name": "Transaction Fields (v2.1.1)", "docs": "The date when this transaction was posted (cleared and applied to the account balance) in [RFC 3339](https://tools.ietf.org/html/rfc3339) date \`YYYY-MM-DD\` format, UTC. This is derived and immutable and only present if \`posted\` is \`true\`.
**Warning**: The property \`postedOn\` was deprecated on version \`v2.1.0\` of the schema. Use the \`occurredOn\` property instead. \`postedOn\` will be removed on version \`v3.0.0\` of the schema.", "type": "optional", "validation": { @@ -5347,7 +5309,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "docs": "Describes the merchant associated with a transaction.", "properties": { "logo_url": { - "display-name": "Transaction Merchant (v1.0.0)", "docs": "The optional URL of the merchant's logo. This image must be an image resource (SVG, PNG, GIF, JPEG image) that does not require any authentication. The URL may contain query parameters.", "type": "optional", "validation": { @@ -5358,7 +5319,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "name": { - "display-name": "Transaction Merchant (v1.0.0)", "docs": "The merchant\\'s name.", "type": "optional", "validation": { @@ -5369,7 +5329,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "website_url": { - "display-name": "Transaction Merchant (v1.0.0)", "docs": "The merchant's website URL.", "type": "optional", "validation": { @@ -5495,7 +5454,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "type": "ResourceId", }, "label": { - "display-name": "Transfer Account Reference (v2.0.1)", "docs": "The human-readable label for this account. This is either the \`nickname\` (if assigned for the current customer), or the \`product.label\` concatenated with the \`maskedNumber\`.", "type": "optional", "validation": { @@ -5506,12 +5464,10 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "location": { - "display-name": "Transfer Account Reference (v2.0.1)", "docs": "Indicates where an account is held.", "type": "optional", }, "type": { - "display-name": "Transfer Account Reference (v2.0.1)", "docs": "The product type of the account.", "type": "optional", }, @@ -5524,7 +5480,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "docs": "A date where a transfer restriction occurs, and the \`reason\` it is restricted. If the \`reason\` is \`holiday\`, \`closure\` and the transfer is an ACH transfer, the object also contains either a \`debitOn\` or \`creditOn\` date or both.", "properties": { "creditOn": { - "display-name": "Transfer Date Restriction (v1.0.0)", "docs": "The date the local financial institution account is credited in [RFC 3339 \`YYYY-MM-DD\`](https://tools.ietf.org/html/rfc3339) date format. This is derived from the \`date\` based on the \`risk\` level. The credit-on date normally falls one business day after the restricted \`date\`. This property is only returned if the payment \`type\` is \`achDebit\` or \`ach\`.", "type": "optional", "validation": { @@ -5535,7 +5490,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "debitOn": { - "display-name": "Transfer Date Restriction (v1.0.0)", "docs": "The date the local financial institution account is debited in [RFC 3339 \`YYYY-MM-DD\`](https://tools.ietf.org/html/rfc3339) date format. This is derived from the \`date\` based on the \`risk\` level and the transfer direction (\`achDebit\` or \`achCredit\`). The debit-on date normally falls one to three business days before the restricted \`date\`. This property is only returned if the payment \`type\` is \`achCredit\` or \`ach\`.", "type": "optional", "validation": { @@ -5645,12 +5599,10 @@ The response may include dates prior to requested the start date, as that is use "docs": "Common fields of the transfer resource used to build other model schemas.", "properties": { "amount": { - "display-name": "Transfer Fields (v3.0.1)", "docs": "The amount of money to transfer between accounts.", "type": "optional", }, "memo": { - "display-name": "Transfer Fields (v3.0.1)", "docs": "A customer-defined memo to describe the transfer.", "type": "optional", "validation": { @@ -5661,12 +5613,10 @@ The response may include dates prior to requested the start date, as that is use }, }, "sourceAccount": { - "display-name": "Transfer Fields (v3.0.1)", "docs": "The source account where the funds are withdrawn.", "type": "optional", }, "targetAccount": { - "display-name": "Transfer Fields (v3.0.1)", "docs": "The target account where the funds are deposited.", "type": "optional", }, @@ -5867,13 +5817,11 @@ The response may include dates prior to requested the start date, as that is use For recurring transfer schedules, \`endsOn\`, \`count\`, and \`amountLimit\` are mutually exclusive.", "properties": { "amountLimit": { - "display-name": "Transfer Schedule (v2.0.0)", "docs": "For recurring schedules (\`frequency\` is not \`once\`), this is the total dollar amount limit including the first transfer. No transfers are scheduled if they would exceed this amount. This property is ignored if \`frequency\` is \`once\`.", "type": "optional", }, "count": { "default": 1, - "display-name": "Transfer Schedule (v2.0.0)", "docs": "For recurring schedules (\`frequency\` is not \`once\`), this is the total number of transfers to make, including the first transfer. This property is ignored if \`frequency\` is \`once\`.", "type": "optional", "validation": { @@ -5885,7 +5833,6 @@ For recurring transfer schedules, \`endsOn\`, \`count\`, and \`amountLimit\` are }, }, "endsOn": { - "display-name": "Transfer Schedule (v2.0.0)", "docs": "The optional date when the recurring transfer schedule ends, in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. Subsequent recurring transfers may be scheduled up to and including this date, but not after. This property is ignored if \`frequency\` is \`once\`.", "type": "optional", "validation": { @@ -5900,11 +5847,9 @@ For recurring transfer schedules, \`endsOn\`, \`count\`, and \`amountLimit\` are "type": "TransferFrequency", }, "recurrenceType": { - "display-name": "Transfer Schedule (v2.0.0)", "type": "optional", }, "scheduledOn": { - "display-name": "Transfer Schedule (v2.0.0)", "docs": "The date the the customer scheduled the transfer to occur in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) \`date\` format.", "type": "optional", "validation": { @@ -8053,7 +7998,6 @@ This error response may have one of the following \`type\` values: }, }, "nextPage_url": { - "display-name": "Abstract Paged Body Fields (v1.1.0)", "docs": "The URL of the next page of resources. If this URL is omitted, there are no more resources in the collection.", "type": "optional", "validation": { @@ -8148,17 +8092,14 @@ This error response may have one of the following \`type\` values: "docs": "The current balances of the given account.", "properties": { "available": { - "display-name": "Account Balance (v1.0.0)", "docs": "The available balance: the funds available for use. This is the string representation of the exact decimal amount.", "type": "optional", }, "current": { - "display-name": "Account Balance (v1.0.0)", "docs": "The current balance. This is the balance at the end of the previous business day. This is the string representation of the exact decimal amount.", "type": "optional", }, "currentWithPending": { - "display-name": "Account Balance (v1.0.0)", "docs": "The current balance, with posted transactions. This is the string representation of the exact decimal amount.", "type": "optional", }, @@ -8171,7 +8112,6 @@ This error response may have one of the following \`type\` values: "type": "boolean", }, "updatedAt": { - "display-name": "Account Balance (v1.0.0)", "docs": "The time when the balance values were last updated from the banking core.", "type": "optional", }, @@ -8222,7 +8162,6 @@ This error response may have one of the following \`type\` values: "type": "MaskedAccountNumber", }, "nickname": { - "display-name": "Account Fields (v1.0.1)", "type": "optional", }, "product": { @@ -8594,7 +8533,6 @@ Account transfers are only allowed between \`internal\` and \`external\` account }, }, "address2": { - "display-name": "Address Fields (v1.1.0)", "docs": "The second line of the street address. This should only be used if it has a value. Typical values include building numbers, suite numbers, and other identifying information beyond the first line of the postal address.", "type": "optional", "validation": { @@ -8643,39 +8581,32 @@ Account transfers are only allowed between \`internal\` and \`external\` account "docs": "API problem or error, as per [RFC 7807 application/problem+json](https://tools.ietf.org/html/rfc7807).", "properties": { "attributes": { - "display-name": "API Problem (v1.1.0)", "docs": "Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.", "type": "optional>", }, "detail": { - "display-name": "API Problem (v1.1.0)", "docs": "A human-readable explanation specific to this occurrence of the problem. ", "type": "optional", }, "id": { - "display-name": "API Problem (v1.1.0)", "docs": "The unique identifier for this problem. This is an immutable opaque string.", "type": "optional", }, "instance": { - "display-name": "API Problem (v1.1.0)", "docs": "A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment ", "type": "optional", }, "occurredAt": { - "display-name": "API Problem (v1.1.0)", "docs": "The timestamp when the problem occurred, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time \`YYYY-MM-DDThh:mm:ss.sssZ\` format, UTC.", "type": "optional", }, "problems": { - "display-name": "API Problem (v1.1.0)", "docs": "Optional root-causes if there are multiple problems in the request or API call processing.", "type": "optional>", }, "status": { - "display-name": "API Problem (v1.1.0)", "docs": "The [HTTP status code](https://datatracker.ietf.org/doc/html/rfc7231#section-6) for this occurrence of the problem. ", "type": "optional", @@ -8688,13 +8619,11 @@ Account transfers are only allowed between \`internal\` and \`external\` account }, }, "title": { - "display-name": "API Problem (v1.1.0)", "docs": "A short, human-readable summary of the problem type. The title is usually the same for all problem with the same \`type\`. ", "type": "optional", }, "type": { - "display-name": "API Problem (v1.1.0)", "docs": "A [URI reference (RFC3986)](https://tools.ietf.org/html/rfc3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be \`"about:blank"\`. ", "type": "optional", @@ -8708,12 +8637,10 @@ Account transfers are only allowed between \`internal\` and \`external\` account "docs": "An challenge factor. See [\`requiredIdentityChallenge\`](#schema-requiredIdentityChallenge) for multiple examples.", "properties": { "labels": { - "display-name": "Challenge Factor (v1.0.0)", "docs": "A list of text label which identifies the channel(s) though which the user completes the challenge. For an \`sms\` or \`voice\` challenge, the only label item is the last four digits of the corresponding phone number. For an \`email\` challenge, each label is the masked email address.", "type": "optional>", }, "securityQuestions": { - "display-name": "Challenge Factor (v1.0.0)", "type": "optional", }, "type": { @@ -9209,7 +9136,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "properties": { "disallowDebitCardAccess": { "default": false, - "display-name": "Joint Owner Invitation Fields (v1.0.0)", "docs": "If \`true\`, the invitee is not allowed to order or manage debit cards for the account.", "type": "optional", }, @@ -9254,7 +9180,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "taxId": { - "display-name": "Joint Owner Invitation Fields (v1.0.0)", "docs": "The last 4 digits of the invitee's tax ID number (Social Security Number). This is not sent in the invitation email, but if the invitee enrolls in digital banking, this identification must match the last four digits of the tax ID they use to enroll.", "type": "optional", "validation": { @@ -9293,12 +9218,10 @@ The client can use this value to localize the \`items[].time\` values to the loc "docs": "Fields of an overdraft protection account, used to compose other schemas.", "properties": { "id": { - "display-name": "Overdraft Account Fields (v1.0.0)", "docs": "The unique ID of the account resource. Use this as the \`{accountId}\` in [\`getAccount\`](#op-getAccount) or [\`listAccountBalances\`](#op-listAccountBalances).", "type": "optional", }, "label": { - "display-name": "Overdraft Account Fields (v1.0.0)", "docs": "The human-readable label for this account. This is either the \`nickname\` (if assigned for the current customer), or the \`product.label\` concatenated with the \`maskedNumber\`.", "type": "optional", "validation": { @@ -9309,7 +9232,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "maskedNumber": { - "display-name": "Overdraft Account Fields (v1.0.0)", "type": "optional", }, }, @@ -9349,7 +9271,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "docs": "Fields used to compose other overdraft protection schemas.", "properties": { "accounts": { - "display-name": "Overdraft Protection Fields (v1.0.0)", "type": "optional", }, }, @@ -9477,7 +9398,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "type": "ResourceId", }, "ReadOnlyTimestamp": { - "display-name": "Read-Only Timestamp (v1.0.0)", "docs": "A readonly or derived timestamp (an instant in time) formatted in [RFC 3339](https://tools.ietf.org/html/rfc3339) \`date-time\` UTC format: \`YYYY-MM-DDThh:mm:ss.sssZ\`.
The schema \`readOnlyTimestamp\` was added on version \`0.4.0\` of the API.", "type": "datetime", }, @@ -9563,12 +9483,10 @@ The client can use this value to localize the \`items[].time\` values to the loc "docs": "Timestamps which describe when a resource was created or last updated.", "properties": { "createdAt": { - "display-name": "Timestamp Fields (v1.0.0)", "docs": "The date-time when this resource was created, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time \`YYYY-MM-DDThh:mm:ss.sssZ\` format, UTC. This is derived and immutable.", "type": "optional", }, "updatedAt": { - "display-name": "Timestamp Fields (v1.0.0)", "docs": "The date-time when the resource was last updated, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time \`YYYY-MM-DDThh:mm:ss.sssZ\` format, UTC. This is derived and immutable.", "type": "optional", }, @@ -9671,7 +9589,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "docs": "Describes a check associated with a transaction for a checking account. This object is only present if the transaction \`type\` is \`debit\` and the \`subtype\` is \`check\`.", "properties": { "imageBack_url": { - "display-name": "Transaction Check (v2.0.0)", "docs": "The URL for downloading the image of the front of the check.", "type": "optional", "validation": { @@ -9682,7 +9599,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "imageFront_url": { - "display-name": "Transaction Check (v2.0.0)", "docs": "The URL for downloading the image of the front of the check.", "type": "optional", "validation": { @@ -9717,22 +9633,18 @@ The client can use this value to localize the \`items[].time\` values to the loc "type": "CreditOrDebitValue", }, "balance": { - "display-name": "Transaction Fields (v2.1.1)", "docs": "The account's running current balance as of this transaction. The \`balance\` may be omitted if the request includes filters which preclude the inclusion of a running balance.", "type": "optional", }, "category": { - "display-name": "Transaction Fields (v2.1.1)", "docs": "The transaction category, if assigned.", "type": "optional", }, "check": { - "display-name": "Transaction Fields (v2.1.1)", "type": "optional", }, "createdOn": { "availability": "deprecated", - "display-name": "Transaction Fields (v2.1.1)", "docs": "The date when the transaction occurred in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) \`date\` format. This is derived and immutable.
**Warning**: The property \`createdOn\` was deprecated on version \`v2.1.0\` of the schema. Use the \`occurredOn\` property instead. \`createdOn\` will be removed on version \`v3.0.0\` of the schema.", "type": "optional", "validation": { @@ -9743,7 +9655,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "description": { - "display-name": "Transaction Fields (v2.1.1)", "docs": "The transaction description assigned by the transaction cleansing service.", "type": "optional", "validation": { @@ -9764,7 +9675,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "memo": { - "display-name": "Transaction Fields (v2.1.1)", "docs": "The user-settable transaction memo.", "type": "optional", "validation": { @@ -9775,7 +9685,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "merchant": { - "display-name": "Transaction Fields (v2.1.1)", "type": "optional", }, "occurredOn": { @@ -9789,13 +9698,11 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "posted": { - "display-name": "Transaction Fields (v2.1.1)", "docs": "If \`true\`, the transaction has been posted (cleared) and applied to the account. If \`false\`, the transaction is still pending and might be canceled. \`posted\` is only valid for credit and debit transactions and omitted for balance transactions.", "type": "optional", }, "postedOn": { "availability": "deprecated", - "display-name": "Transaction Fields (v2.1.1)", "docs": "The date when this transaction was posted (cleared and applied to the account balance) in [RFC 3339](https://tools.ietf.org/html/rfc3339) date \`YYYY-MM-DD\` format, UTC. This is derived and immutable and only present if \`posted\` is \`true\`.
**Warning**: The property \`postedOn\` was deprecated on version \`v2.1.0\` of the schema. Use the \`occurredOn\` property instead. \`postedOn\` will be removed on version \`v3.0.0\` of the schema.", "type": "optional", "validation": { @@ -9835,7 +9742,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "docs": "Describes the merchant associated with a transaction.", "properties": { "logo_url": { - "display-name": "Transaction Merchant (v1.0.0)", "docs": "The optional URL of the merchant's logo. This image must be an image resource (SVG, PNG, GIF, JPEG image) that does not require any authentication. The URL may contain query parameters.", "type": "optional", "validation": { @@ -9846,7 +9752,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "name": { - "display-name": "Transaction Merchant (v1.0.0)", "docs": "The merchant\\'s name.", "type": "optional", "validation": { @@ -9857,7 +9762,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "website_url": { - "display-name": "Transaction Merchant (v1.0.0)", "docs": "The merchant's website URL.", "type": "optional", "validation": { @@ -9983,7 +9887,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "type": "ResourceId", }, "label": { - "display-name": "Transfer Account Reference (v2.0.1)", "docs": "The human-readable label for this account. This is either the \`nickname\` (if assigned for the current customer), or the \`product.label\` concatenated with the \`maskedNumber\`.", "type": "optional", "validation": { @@ -9994,12 +9897,10 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "location": { - "display-name": "Transfer Account Reference (v2.0.1)", "docs": "Indicates where an account is held.", "type": "optional", }, "type": { - "display-name": "Transfer Account Reference (v2.0.1)", "docs": "The product type of the account.", "type": "optional", }, @@ -10012,7 +9913,6 @@ The client can use this value to localize the \`items[].time\` values to the loc "docs": "A date where a transfer restriction occurs, and the \`reason\` it is restricted. If the \`reason\` is \`holiday\`, \`closure\` and the transfer is an ACH transfer, the object also contains either a \`debitOn\` or \`creditOn\` date or both.", "properties": { "creditOn": { - "display-name": "Transfer Date Restriction (v1.0.0)", "docs": "The date the local financial institution account is credited in [RFC 3339 \`YYYY-MM-DD\`](https://tools.ietf.org/html/rfc3339) date format. This is derived from the \`date\` based on the \`risk\` level. The credit-on date normally falls one business day after the restricted \`date\`. This property is only returned if the payment \`type\` is \`achDebit\` or \`ach\`.", "type": "optional", "validation": { @@ -10023,7 +9923,6 @@ The client can use this value to localize the \`items[].time\` values to the loc }, }, "debitOn": { - "display-name": "Transfer Date Restriction (v1.0.0)", "docs": "The date the local financial institution account is debited in [RFC 3339 \`YYYY-MM-DD\`](https://tools.ietf.org/html/rfc3339) date format. This is derived from the \`date\` based on the \`risk\` level and the transfer direction (\`achDebit\` or \`achCredit\`). The debit-on date normally falls one to three business days before the restricted \`date\`. This property is only returned if the payment \`type\` is \`achCredit\` or \`ach\`.", "type": "optional", "validation": { @@ -10133,12 +10032,10 @@ The response may include dates prior to requested the start date, as that is use "docs": "Common fields of the transfer resource used to build other model schemas.", "properties": { "amount": { - "display-name": "Transfer Fields (v3.0.1)", "docs": "The amount of money to transfer between accounts.", "type": "optional", }, "memo": { - "display-name": "Transfer Fields (v3.0.1)", "docs": "A customer-defined memo to describe the transfer.", "type": "optional", "validation": { @@ -10149,12 +10046,10 @@ The response may include dates prior to requested the start date, as that is use }, }, "sourceAccount": { - "display-name": "Transfer Fields (v3.0.1)", "docs": "The source account where the funds are withdrawn.", "type": "optional", }, "targetAccount": { - "display-name": "Transfer Fields (v3.0.1)", "docs": "The target account where the funds are deposited.", "type": "optional", }, @@ -10355,13 +10250,11 @@ The response may include dates prior to requested the start date, as that is use For recurring transfer schedules, \`endsOn\`, \`count\`, and \`amountLimit\` are mutually exclusive.", "properties": { "amountLimit": { - "display-name": "Transfer Schedule (v2.0.0)", "docs": "For recurring schedules (\`frequency\` is not \`once\`), this is the total dollar amount limit including the first transfer. No transfers are scheduled if they would exceed this amount. This property is ignored if \`frequency\` is \`once\`.", "type": "optional", }, "count": { "default": 1, - "display-name": "Transfer Schedule (v2.0.0)", "docs": "For recurring schedules (\`frequency\` is not \`once\`), this is the total number of transfers to make, including the first transfer. This property is ignored if \`frequency\` is \`once\`.", "type": "optional", "validation": { @@ -10373,7 +10266,6 @@ For recurring transfer schedules, \`endsOn\`, \`count\`, and \`amountLimit\` are }, }, "endsOn": { - "display-name": "Transfer Schedule (v2.0.0)", "docs": "The optional date when the recurring transfer schedule ends, in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. Subsequent recurring transfers may be scheduled up to and including this date, but not after. This property is ignored if \`frequency\` is \`once\`.", "type": "optional", "validation": { @@ -10388,11 +10280,9 @@ For recurring transfer schedules, \`endsOn\`, \`count\`, and \`amountLimit\` are "type": "TransferFrequency", }, "recurrenceType": { - "display-name": "Transfer Schedule (v2.0.0)", "type": "optional", }, "scheduledOn": { - "display-name": "Transfer Schedule (v2.0.0)", "docs": "The date the the customer scheduled the transfer to occur in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) \`date\` format.", "type": "optional", "validation": { diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/aries.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/aries.test.ts.snap index 50b5f207c57..a906166f975 100644 --- a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/aries.test.ts.snap +++ b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/aries.test.ts.snap @@ -122,12 +122,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "name": { - "display-name": "PerformRequest", "docs": "Menu option name", "type": "optional", }, "params": { - "display-name": "PerformRequest", "docs": "Input parameter values", "type": "optional>", }, @@ -270,7 +268,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "content": { - "display-name": "SendMessage", "docs": "Message content", "type": "optional", }, @@ -475,7 +472,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "mediation_id": { - "display-name": "CreateInvitationRequest", "docs": "Identifier for active mediation record to be used", "type": "optional", "validation": { @@ -486,27 +482,22 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "metadata": { - "display-name": "CreateInvitationRequest", "docs": "Optional metadata to attach to the connection created with the invitation", "type": "optional", }, "my_label": { - "display-name": "CreateInvitationRequest", "docs": "Optional label for connection invitation", "type": "optional", }, "recipient_keys": { - "display-name": "CreateInvitationRequest", "docs": "List of recipient keys", "type": "optional>", }, "routing_keys": { - "display-name": "CreateInvitationRequest", "docs": "List of routing keys", "type": "optional>", }, "service_endpoint": { - "display-name": "CreateInvitationRequest", "docs": "Connection endpoint", "type": "optional", }, @@ -594,12 +585,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "alias": { - "display-name": "ConnectionStaticRequest", "docs": "Alias to assign to this connection", "type": "optional", }, "my_did": { - "display-name": "ConnectionStaticRequest", "docs": "Local DID", "type": "optional", "validation": { @@ -610,12 +599,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "my_seed": { - "display-name": "ConnectionStaticRequest", "docs": "Seed to use for the local DID", "type": "optional", }, "their_did": { - "display-name": "ConnectionStaticRequest", "docs": "Remote DID", "type": "optional", "validation": { @@ -626,7 +613,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "their_endpoint": { - "display-name": "ConnectionStaticRequest", "docs": "URL endpoint for other party", "type": "optional", "validation": { @@ -637,17 +623,14 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "their_label": { - "display-name": "ConnectionStaticRequest", "docs": "Other party's label for this connection", "type": "optional", }, "their_seed": { - "display-name": "ConnectionStaticRequest", "docs": "Seed to use for the remote DID", "type": "optional", }, "their_verkey": { - "display-name": "ConnectionStaticRequest", "docs": "Remote verification key", "type": "optional", }, @@ -971,17 +954,14 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "@id": { - "display-name": "ReceiveInvitationRequest", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "ReceiveInvitationRequest", "docs": "Message type", "type": "optional", }, "did": { - "display-name": "ReceiveInvitationRequest", "docs": "DID for connection invitation", "type": "optional", "validation": { @@ -992,27 +972,22 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "imageUrl": { - "display-name": "ReceiveInvitationRequest", "docs": "Optional image URL for connection invitation", "type": "optional", }, "label": { - "display-name": "ReceiveInvitationRequest", "docs": "Optional label for connection invitation", "type": "optional", }, "recipientKeys": { - "display-name": "ReceiveInvitationRequest", "docs": "List of recipient keys", "type": "optional>", }, "routingKeys": { - "display-name": "ReceiveInvitationRequest", "docs": "List of routing keys", "type": "optional>", }, "serviceEndpoint": { - "display-name": "ReceiveInvitationRequest", "docs": "Service endpoint at which to reach this agent", "type": "optional", }, @@ -1366,7 +1341,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "revocation_registry_size": { - "display-name": "CredentialDefinitionSendRequest", "docs": "Revocation registry size", "type": "optional", "validation": { @@ -1378,7 +1352,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_id": { - "display-name": "CredentialDefinitionSendRequest", "docs": "Schema identifier", "type": "optional", "validation": { @@ -1389,12 +1362,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "support_revocation": { - "display-name": "CredentialDefinitionSendRequest", "docs": "Revocation supported flag", "type": "optional", }, "tag": { - "display-name": "CredentialDefinitionSendRequest", "docs": "Credential definition identifier tag", "type": "optional", }, @@ -1884,45 +1855,36 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "contexts": { - "display-name": "W3CCredentialsListRequest", "type": "optional>", }, "given_id": { - "display-name": "W3CCredentialsListRequest", "docs": "Given credential id to match", "type": "optional", }, "issuer_id": { - "display-name": "W3CCredentialsListRequest", "docs": "Credential issuer identifier to match", "type": "optional", }, "max_results": { - "display-name": "W3CCredentialsListRequest", "docs": "Maximum number of results to return", "type": "optional", }, "proof_types": { - "display-name": "W3CCredentialsListRequest", "type": "optional>", }, "schema_ids": { - "display-name": "W3CCredentialsListRequest", "docs": "Schema identifiers, all of which to match", "type": "optional>", }, "subject_ids": { - "display-name": "W3CCredentialsListRequest", "docs": "Subject identifiers, all of which to match", "type": "optional>", }, "tag_query": { - "display-name": "W3CCredentialsListRequest", "docs": "Tag filter", "type": "optional>", }, "types": { - "display-name": "W3CCredentialsListRequest", "type": "optional>", }, }, @@ -2225,17 +2187,14 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "@id": { - "display-name": "DIDXRequest", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "DIDXRequest", "docs": "Message type", "type": "optional", }, "did": { - "display-name": "DIDXRequest", "docs": "DID of exchange", "type": "optional", "validation": { @@ -2246,7 +2205,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "did_doc~attach": { - "display-name": "DIDXRequest", "type": "optional", }, "label": { @@ -3424,17 +3382,14 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_remove": { - "display-name": "V10CredentialCreate", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V10CredentialCreate", "docs": "Human-readable comment", "type": "optional", }, "cred_def_id": { - "display-name": "V10CredentialCreate", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -3449,7 +3404,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "root.CredentialPreview", }, "issuer_did": { - "display-name": "V10CredentialCreate", "docs": "Credential issuer DID", "type": "optional", "validation": { @@ -3460,7 +3414,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_id": { - "display-name": "V10CredentialCreate", "docs": "Schema identifier", "type": "optional", "validation": { @@ -3471,7 +3424,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_issuer_did": { - "display-name": "V10CredentialCreate", "docs": "Schema issuer DID", "type": "optional", "validation": { @@ -3482,12 +3434,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_name": { - "display-name": "V10CredentialCreate", "docs": "Schema name", "type": "optional", }, "schema_version": { - "display-name": "V10CredentialCreate", "docs": "Schema version", "type": "optional", "validation": { @@ -3498,7 +3448,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "trace": { - "display-name": "V10CredentialCreate", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -3684,17 +3633,14 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_issue": { - "display-name": "V10CredentialConnFreeOfferRequest", "docs": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "optional", }, "auto_remove": { - "display-name": "V10CredentialConnFreeOfferRequest", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V10CredentialConnFreeOfferRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -3713,7 +3659,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "root.CredentialPreview", }, "trace": { - "display-name": "V10CredentialConnFreeOfferRequest", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -4377,7 +4322,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "comment": { - "display-name": "V10CredentialIssueRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -4594,7 +4538,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "counter_proposal": { - "display-name": "V10CredentialBoundOfferRequest", "type": "optional", }, }, @@ -4943,12 +4886,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_remove": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Human-readable comment", "type": "optional", }, @@ -4963,7 +4904,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "cred_def_id": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -4978,7 +4918,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "root.CredentialPreview", }, "issuer_did": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Credential issuer DID", "type": "optional", "validation": { @@ -4989,7 +4928,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_id": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Schema identifier", "type": "optional", "validation": { @@ -5000,7 +4938,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_issuer_did": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Schema issuer DID", "type": "optional", "validation": { @@ -5011,12 +4948,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_name": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Schema name", "type": "optional", }, "schema_version": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Schema version", "type": "optional", "validation": { @@ -5027,7 +4962,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "trace": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -5214,17 +5148,14 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_issue": { - "display-name": "V10CredentialFreeOfferRequest", "docs": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "optional", }, "auto_remove": { - "display-name": "V10CredentialFreeOfferRequest", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V10CredentialFreeOfferRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -5253,7 +5184,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "root.CredentialPreview", }, "trace": { - "display-name": "V10CredentialFreeOfferRequest", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -5444,12 +5374,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_remove": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Human-readable comment", "type": "optional", }, @@ -5464,7 +5392,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "cred_def_id": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -5475,11 +5402,9 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "credential_proposal": { - "display-name": "V10CredentialProposalRequestOpt", "type": "optional", }, "issuer_did": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Credential issuer DID", "type": "optional", "validation": { @@ -5490,7 +5415,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_id": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Schema identifier", "type": "optional", "validation": { @@ -5501,7 +5425,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_issuer_did": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Schema issuer DID", "type": "optional", "validation": { @@ -5512,12 +5435,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_name": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Schema name", "type": "optional", }, "schema_version": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Schema version", "type": "optional", "validation": { @@ -5528,7 +5449,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "trace": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -5704,7 +5624,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "credential_id": { - "display-name": "V10CredentialStoreRequest", "type": "optional", }, }, @@ -5992,22 +5911,18 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_remove": { - "display-name": "V20IssueCredSchemaCore", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V20IssueCredSchemaCore", "docs": "Human-readable comment", "type": "optional", }, "credential_preview": { - "display-name": "V20IssueCredSchemaCore", "type": "optional", }, "filter": "root.V20CredBoundOfferRequestFilter", "trace": { - "display-name": "V20IssueCredSchemaCore", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -6252,27 +6167,22 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_issue": { - "display-name": "V20CredOfferConnFreeRequest", "docs": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "optional", }, "auto_remove": { - "display-name": "V20CredOfferConnFreeRequest", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V20CredOfferConnFreeRequest", "docs": "Human-readable comment", "type": "optional", }, "credential_preview": { - "display-name": "V20CredOfferConnFreeRequest", "type": "optional", }, "filter": "root.V20CredBoundOfferRequestFilter", "trace": { - "display-name": "V20CredOfferConnFreeRequest", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -7252,7 +7162,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "comment": { - "display-name": "V20CredIssueRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -7544,11 +7453,9 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "counter_preview": { - "display-name": "V20CredBoundOfferRequest", "type": "optional", }, "filter": { - "display-name": "V20CredBoundOfferRequest", "type": "optional", }, }, @@ -7782,7 +7689,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "holder_did": { - "display-name": "V20CredRequestRequest", "docs": "Holder DID to substitute for the credentialSubject.id", "type": "optional", }, @@ -8266,17 +8172,14 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_issue": { - "display-name": "V20CredOfferRequest", "docs": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "optional", }, "auto_remove": { - "display-name": "V20CredOfferRequest", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V20CredOfferRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -8291,12 +8194,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "credential_preview": { - "display-name": "V20CredOfferRequest", "type": "optional", }, "filter": "root.V20CredBoundOfferRequestFilter", "trace": { - "display-name": "V20CredOfferRequest", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -8792,12 +8693,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_remove": { - "display-name": "V20CredRequestFree", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V20CredRequestFree", "docs": "Human-readable comment", "type": "optional", }, @@ -8813,12 +8712,10 @@ exports[`open api parser > aries > docs 1`] = ` }, "filter": "root.V20CredRequestFreeFilter", "holder_did": { - "display-name": "V20CredRequestFree", "docs": "Holder DID to substitute for the credentialSubject.id", "type": "optional", }, "trace": { - "display-name": "V20CredRequestFree", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -9073,7 +8970,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "credential_id": { - "display-name": "V20CredStoreRequest", "type": "optional", }, }, @@ -9238,7 +9134,6 @@ exports[`open api parser > aries > docs 1`] = ` "properties": { "doc": "root.VerifyRequestDoc", "verkey": { - "display-name": "VerifyRequest", "docs": "Verkey to use for doc verification", "type": "optional", }, @@ -9294,15 +9189,12 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "mechanism": { - "display-name": "TAAAccept", "type": "optional", }, "text": { - "display-name": "TAAAccept", "type": "optional", }, "version": { - "display-name": "TAAAccept", "type": "optional", }, }, @@ -9798,12 +9690,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "mediator_terms": { - "display-name": "AdminMediationDeny", "docs": "List of mediator rules for recipient", "type": "optional>", }, "recipient_terms": { - "display-name": "AdminMediationDeny", "docs": "List of recipient rules for mediation", "type": "optional>", }, @@ -10140,12 +10030,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "mediator_terms": { - "display-name": "MediationCreateRequest", "docs": "List of mediator rules for recipient", "type": "optional>", }, "recipient_terms": { - "display-name": "MediationCreateRequest", "docs": "List of recipient rules for mediation", "type": "optional>", }, @@ -10195,7 +10083,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "filter": { - "display-name": "KeylistQueryFilterRequest", "docs": "Filter for keylist query", "type": "optional", }, @@ -10271,7 +10158,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "updates": { - "display-name": "KeylistUpdateRequest", "type": "optional>", }, }, @@ -10376,7 +10262,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "mediation_id": { - "display-name": "MediationIdMatchInfo", "docs": "Mediation record identifier", "type": "optional", "validation": { @@ -10481,47 +10366,38 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "image_url": { - "display-name": "CreateWalletRequest", "docs": "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", "type": "optional", }, "key_management_mode": { - "display-name": "CreateWalletRequest", "docs": "Key management method to use for this wallet.", "type": "optional>", }, "label": { - "display-name": "CreateWalletRequest", "docs": "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", "type": "optional", }, "wallet_dispatch_type": { - "display-name": "CreateWalletRequest", "docs": "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", "type": "optional", }, "wallet_key": { - "display-name": "CreateWalletRequest", "docs": "Master key used for key derivation.", "type": "optional", }, "wallet_key_derivation": { - "display-name": "CreateWalletRequest", "docs": "Key derivation", "type": "optional", }, "wallet_name": { - "display-name": "CreateWalletRequest", "docs": "Wallet name", "type": "optional", }, "wallet_type": { - "display-name": "CreateWalletRequest", "docs": "Type of the wallet to create", "type": "optional", }, "wallet_webhook_urls": { - "display-name": "CreateWalletRequest", "docs": "List of Webhook URLs associated with this subwallet", "type": "optional>", }, @@ -10568,7 +10444,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "wallet_key": { - "display-name": "RemoveWalletRequest", "docs": "Master key used for key derivation. Only required for unmanaged wallets.", "type": "optional", }, @@ -10612,7 +10487,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "wallet_key": { - "display-name": "CreateWalletTokenRequest", "docs": "Master key used for key derivation. Only required for unamanged wallets.", "type": "optional", }, @@ -10748,22 +10622,18 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "image_url": { - "display-name": "UpdateWalletRequest", "docs": "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", "type": "optional", }, "label": { - "display-name": "UpdateWalletRequest", "docs": "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", "type": "optional", }, "wallet_dispatch_type": { - "display-name": "UpdateWalletRequest", "docs": "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", "type": "optional", }, "wallet_webhook_urls": { - "display-name": "UpdateWalletRequest", "docs": "List of Webhook URLs associated with this subwallet", "type": "optional>", }, @@ -10963,26 +10833,21 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "accept": { - "display-name": "InvitationCreateRequest", "docs": "List of mime type in order of preference that should be use in responding to the message", "type": "optional>", }, "alias": { - "display-name": "InvitationCreateRequest", "docs": "Alias for connection", "type": "optional", }, "attachments": { - "display-name": "InvitationCreateRequest", "docs": "Optional invitation attachments", "type": "optional>", }, "handshake_protocols": { - "display-name": "InvitationCreateRequest", "type": "optional>", }, "mediation_id": { - "display-name": "InvitationCreateRequest", "docs": "Identifier for active mediation record to be used", "type": "optional", "validation": { @@ -10993,22 +10858,18 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "metadata": { - "display-name": "InvitationCreateRequest", "docs": "Optional metadata to attach to the connection created with the invitation", "type": "optional", }, "my_label": { - "display-name": "InvitationCreateRequest", "docs": "Label for connection invitation", "type": "optional", }, "protocol_version": { - "display-name": "InvitationCreateRequest", "docs": "OOB protocol version", "type": "optional", }, "use_public_did": { - "display-name": "InvitationCreateRequest", "docs": "Whether to use public DID in invitation", "type": "optional", }, @@ -11466,12 +11327,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_verify": { - "display-name": "V10PresentationCreateRequestRequest", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "comment": { - "display-name": "V10PresentationCreateRequestRequest", "type": "optional", }, "proof_request": { @@ -11479,7 +11338,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "root.IndyProofRequest", }, "trace": { - "display-name": "V10PresentationCreateRequestRequest", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -12287,12 +12145,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_verify": { - "display-name": "V10PresentationSendRequestRequest", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "comment": { - "display-name": "V10PresentationSendRequestRequest", "type": "optional", }, "connection_id": { @@ -12310,7 +12166,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "root.IndyProofRequest", }, "trace": { - "display-name": "V10PresentationSendRequestRequest", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -12523,12 +12378,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_present": { - "display-name": "V10PresentationProposalRequest", "docs": "Whether to respond automatically to presentation requests, building and presenting requested proof", "type": "optional", }, "comment": { - "display-name": "V10PresentationProposalRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -12547,7 +12400,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "root.IndyPresPreview", }, "trace": { - "display-name": "V10PresentationProposalRequest", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -12927,12 +12779,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_verify": { - "display-name": "V10PresentationSendRequestToProposal", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "trace": { - "display-name": "V10PresentationSendRequestToProposal", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -13336,12 +13186,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_verify": { - "display-name": "V20PresCreateRequestRequest", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "comment": { - "display-name": "V20PresCreateRequestRequest", "type": "optional", }, "presentation_request": { @@ -13349,7 +13197,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "root.V20PresRequestByFormat", }, "trace": { - "display-name": "V20PresCreateRequestRequest", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -14095,12 +13942,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_verify": { - "display-name": "V20PresSendRequestRequest", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "comment": { - "display-name": "V20PresSendRequestRequest", "type": "optional", }, "connection_id": { @@ -14118,7 +13963,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "root.V20PresRequestByFormat", }, "trace": { - "display-name": "V20PresSendRequestRequest", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -14311,12 +14155,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_present": { - "display-name": "V20PresProposalRequest", "docs": "Whether to respond automatically to presentation requests, building and presenting requested proof", "type": "optional", }, "comment": { - "display-name": "V20PresProposalRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -14335,7 +14177,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "root.V20PresProposalByFormat", }, "trace": { - "display-name": "V20PresProposalRequest", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -14513,15 +14354,12 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "dif": { - "display-name": "V20PresSpecByFormatRequest", "type": "optional", }, "indy": { - "display-name": "V20PresSpecByFormatRequest", "type": "optional", }, "trace": { - "display-name": "V20PresSpecByFormatRequest", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -14682,12 +14520,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "auto_verify": { - "display-name": "V20PresentationSendRequestToProposal", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "trace": { - "display-name": "V20PresentationSendRequestToProposal", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -14985,7 +14821,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "purge": { - "display-name": "ClearPendingRevocationsRequest", "docs": "Credential revocation ids by revocation registry id: omit for all, specify null or empty list for all pending per revocation registry", "type": "optional>>", }, @@ -15061,7 +14896,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "credential_definition_id": { - "display-name": "RevRegCreateRequest", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -15072,7 +14906,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "max_cred_num": { - "display-name": "RevRegCreateRequest", "docs": "Revocation registry size", "type": "optional", "validation": { @@ -15785,12 +15618,10 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "comment": { - "display-name": "RevokeRequest", "docs": "Optional comment to include in revocation notification", "type": "optional", }, "connection_id": { - "display-name": "RevokeRequest", "docs": "Connection ID to which the revocation notification will be sent; required if notify is true", "type": "optional", "validation": { @@ -15801,7 +15632,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "cred_ex_id": { - "display-name": "RevokeRequest", "docs": "Credential exchange identifier", "type": "optional", "validation": { @@ -15812,7 +15642,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "cred_rev_id": { - "display-name": "RevokeRequest", "docs": "Credential revocation identifier", "type": "optional", "validation": { @@ -15823,22 +15652,18 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "notify": { - "display-name": "RevokeRequest", "docs": "Send a notification to the credential recipient", "type": "optional", }, "notify_version": { - "display-name": "RevokeRequest", "docs": "Specify which version of the revocation notification should be sent", "type": "optional", }, "publish": { - "display-name": "RevokeRequest", "docs": "(True) publish revocation to ledger immediately, or (default, False) mark it pending", "type": "optional", }, "rev_reg_id": { - "display-name": "RevokeRequest", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -15849,7 +15674,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "thread_id": { - "display-name": "RevokeRequest", "docs": "Thread ID of the credential exchange message thread resulting in the credential now being revoked; required if notify is true", "type": "optional", }, @@ -16595,7 +16419,6 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "comment": { - "display-name": "PingRequest", "docs": "Comment for the ping message", "type": "optional", }, @@ -16656,16 +16479,13 @@ exports[`open api parser > aries > docs 1`] = ` "body": { "properties": { "method": { - "display-name": "DIDCreate", "docs": "Method for the requested DID.Supported methods are 'key', 'sov', and any other registered method.", "type": "optional", }, "options": { - "display-name": "DIDCreate", "type": "optional", }, "seed": { - "display-name": "DIDCreate", "docs": "Optional seed to use for DID, Must beenabled in configuration before use.", "type": "optional", }, @@ -16870,7 +16690,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "endpoint": { - "display-name": "DIDEndpointWithType", "docs": "Endpoint to set (omit to delete)", "type": "optional", "validation": { @@ -16881,7 +16700,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "endpoint_type": { - "display-name": "DIDEndpointWithType", "docs": "Endpoint type to set (default 'Endpoint'); affects only public or posted DIDs", "type": "optional", }, @@ -17088,15 +16906,12 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "aml": { - "display-name": "AMLRecord", "type": "optional>", }, "amlContext": { - "display-name": "AMLRecord", "type": "optional", }, "version": { - "display-name": "AMLRecord", "type": "optional", }, }, @@ -17108,7 +16923,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "ActionMenuFetchResult", "type": "optional", }, }, @@ -17126,7 +16940,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "config": { - "display-name": "AdminConfig", "docs": "Configuration settings", "type": "optional", }, @@ -17146,7 +16959,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "AdminModules", "docs": "List of admin modules", "type": "optional>", }, @@ -17161,22 +16973,18 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "conductor": { - "display-name": "AdminStatus", "docs": "Conductor statistics", "type": "optional", }, "label": { - "display-name": "AdminStatus", "docs": "Default label", "type": "optional", }, "timing": { - "display-name": "AdminStatus", "docs": "Timing results", "type": "optional", }, "version": { - "display-name": "AdminStatus", "docs": "Version code", "type": "optional", }, @@ -17196,7 +17004,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "alive": { - "display-name": "AdminStatusLiveliness", "docs": "Liveliness status", "type": "optional", }, @@ -17209,7 +17016,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "ready": { - "display-name": "AdminStatusReadiness", "docs": "Readiness status", "type": "optional", }, @@ -17229,12 +17035,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "AttachDecorator", "docs": "Attachment identifier", "type": "optional", }, "byte_count": { - "display-name": "AttachDecorator", "docs": "Byte count of data included by reference", "type": "optional", }, @@ -17243,17 +17047,14 @@ exports[`open api parser > aries > docs 1`] = ` "type": "AttachDecoratorData", }, "description": { - "display-name": "AttachDecorator", "docs": "Human-readable description of content", "type": "optional", }, "filename": { - "display-name": "AttachDecorator", "docs": "File name", "type": "optional", }, "lastmod_time": { - "display-name": "AttachDecorator", "docs": "Hint regarding last modification datetime, in ISO-8601 format", "type": "optional", "validation": { @@ -17264,7 +17065,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "mime-type": { - "display-name": "AttachDecorator", "docs": "MIME type", "type": "optional", }, @@ -17277,7 +17077,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "base64": { - "display-name": "AttachDecoratorData", "docs": "Base64-encoded data", "type": "optional", "validation": { @@ -17288,21 +17087,17 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "json": { - "display-name": "AttachDecoratorData", "docs": "JSON-serialized data", "type": "optional>", }, "jws": { - "display-name": "AttachDecoratorData", "type": "optional", }, "links": { - "display-name": "AttachDecoratorData", "docs": "List of hypertext links to data", "type": "optional>", }, "sha256": { - "display-name": "AttachDecoratorData", "docs": "SHA256 hash (binhex encoded) of content", "type": "optional", "validation": { @@ -17325,7 +17120,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "AttachDecoratorDataJWSHeader", }, "protected": { - "display-name": "AttachDecoratorData1JWS", "docs": "protected JWS header", "type": "optional", "validation": { @@ -17354,11 +17148,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "header": { - "display-name": "AttachDecoratorDataJWS", "type": "optional", }, "protected": { - "display-name": "AttachDecoratorDataJWS", "docs": "protected JWS header", "type": "optional", "validation": { @@ -17369,7 +17161,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "signature": { - "display-name": "AttachDecoratorDataJWS", "docs": "signature", "type": "optional", "validation": { @@ -17380,7 +17171,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "signatures": { - "display-name": "AttachDecoratorDataJWS", "docs": "List of signatures", "type": "optional>", }, @@ -17416,12 +17206,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "id": { - "display-name": "AttachmentDef", "docs": "Attachment identifier", "type": "optional", }, "type": { - "display-name": "AttachmentDef", "docs": "Attachment type", "type": "optional", }, @@ -17450,7 +17238,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "AttributeMimeTypesResult", "type": "optional>>", }, }, @@ -17463,27 +17250,21 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "jwt": { - "display-name": "ClaimFormat", "type": "optional", }, "jwt_vc": { - "display-name": "ClaimFormat", "type": "optional", }, "jwt_vp": { - "display-name": "ClaimFormat", "type": "optional", }, "ldp": { - "display-name": "ClaimFormat", "type": "optional", }, "ldp_vc": { - "display-name": "ClaimFormat", "type": "optional", }, "ldp_vp": { - "display-name": "ClaimFormat", "type": "optional", }, }, @@ -17523,27 +17304,22 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "accept": { - "display-name": "ConnRecord", "docs": "Connection acceptance: manual or auto", "type": "optional", }, "alias": { - "display-name": "ConnRecord", "docs": "Optional alias to apply to connection for later use", "type": "optional", }, "connection_id": { - "display-name": "ConnRecord", "docs": "Connection identifier", "type": "optional", }, "connection_protocol": { - "display-name": "ConnRecord", "docs": "Connection protocol used", "type": "optional", }, "created_at": { - "display-name": "ConnRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -17554,17 +17330,14 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "error_msg": { - "display-name": "ConnRecord", "docs": "Error message", "type": "optional", }, "inbound_connection_id": { - "display-name": "ConnRecord", "docs": "Inbound routing connection id to use", "type": "optional", }, "invitation_key": { - "display-name": "ConnRecord", "docs": "Public key for connection", "type": "optional", "validation": { @@ -17575,17 +17348,14 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "invitation_mode": { - "display-name": "ConnRecord", "docs": "Invitation mode", "type": "optional", }, "invitation_msg_id": { - "display-name": "ConnRecord", "docs": "ID of out-of-band invitation message", "type": "optional", }, "my_did": { - "display-name": "ConnRecord", "docs": "Our DID for connection", "type": "optional", "validation": { @@ -17596,27 +17366,22 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "request_id": { - "display-name": "ConnRecord", "docs": "Connection request identifier", "type": "optional", }, "rfc23_state": { - "display-name": "ConnRecord", "docs": "State per RFC 23", "type": "optional", }, "routing_state": { - "display-name": "ConnRecord", "docs": "Routing state of connection", "type": "optional", }, "state": { - "display-name": "ConnRecord", "docs": "Current record state", "type": "optional", }, "their_did": { - "display-name": "ConnRecord", "docs": "Their DID for connection", "type": "optional", "validation": { @@ -17627,22 +17392,18 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "their_label": { - "display-name": "ConnRecord", "docs": "Their label for connection", "type": "optional", }, "their_public_did": { - "display-name": "ConnRecord", "docs": "Other agent's public DID for connection", "type": "optional", }, "their_role": { - "display-name": "ConnRecord", "docs": "Their role in the connection protocol", "type": "optional", }, "updated_at": { - "display-name": "ConnRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -17722,17 +17483,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "ConnectionInvitation", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "ConnectionInvitation", "docs": "Message type", "type": "optional", }, "did": { - "display-name": "ConnectionInvitation", "docs": "DID for connection invitation", "type": "optional", "validation": { @@ -17743,27 +17501,22 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "imageUrl": { - "display-name": "ConnectionInvitation", "docs": "Optional image URL for connection invitation", "type": "optional", }, "label": { - "display-name": "ConnectionInvitation", "docs": "Optional label for connection invitation", "type": "optional", }, "recipientKeys": { - "display-name": "ConnectionInvitation", "docs": "List of recipient keys", "type": "optional>", }, "routingKeys": { - "display-name": "ConnectionInvitation", "docs": "List of routing keys", "type": "optional>", }, "serviceEndpoint": { - "display-name": "ConnectionInvitation", "docs": "Service endpoint at which to reach this agent", "type": "optional", }, @@ -17776,7 +17529,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "ConnectionList", "docs": "List of connection records", "type": "optional>", }, @@ -17789,7 +17541,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "ConnectionMetadata", "docs": "Dictionary of metadata associated with connection.", "type": "optional", }, @@ -17872,32 +17623,25 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "fields": { - "display-name": "Constraints", "type": "optional>", }, "is_holder": { - "display-name": "Constraints", "type": "optional>", }, "limit_disclosure": { - "display-name": "Constraints", "docs": "LimitDisclosure", "type": "optional", }, "status_active": { - "display-name": "Constraints", "type": "optional", }, "status_revoked": { - "display-name": "Constraints", "type": "optional", }, "status_suspended": { - "display-name": "Constraints", "type": "optional", }, "subject_is_issuer": { - "display-name": "Constraints", "docs": "SubjectIsIssuer", "type": "optional", }, @@ -17950,7 +17694,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "CreateWalletResponse", "docs": "Time of record creation", "type": "optional", "validation": { @@ -17965,22 +17708,18 @@ exports[`open api parser > aries > docs 1`] = ` "type": "CreateWalletResponseKeyManagementMode", }, "settings": { - "display-name": "CreateWalletResponse", "docs": "Settings for this wallet.", "type": "optional", }, "state": { - "display-name": "CreateWalletResponse", "docs": "Current record state", "type": "optional", }, "token": { - "display-name": "CreateWalletResponse", "docs": "Authorization token to authenticate wallet requests", "type": "optional", }, "updated_at": { - "display-name": "CreateWalletResponse", "docs": "Time of last record update", "type": "optional", "validation": { @@ -18020,7 +17759,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "token": { - "display-name": "CreateWalletTokenResponse", "docs": "Authorization token to authenticate wallet requests", "type": "optional", }, @@ -18033,7 +17771,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "mime-type": { - "display-name": "CredAttrSpec", "docs": "MIME type: omit for (null) default", "type": "optional", }, @@ -18054,11 +17791,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "primary": { - "display-name": "CredDefValue", "type": "optional", }, "revocation": { - "display-name": "CredDefValue", "type": "optional", }, }, @@ -18070,7 +17805,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "n": { - "display-name": "CredDefValuePrimary", "type": "optional", "validation": { "format": undefined, @@ -18080,11 +17814,9 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "r": { - "display-name": "CredDefValuePrimary", "type": "optional", }, "rctxt": { - "display-name": "CredDefValuePrimary", "type": "optional", "validation": { "format": undefined, @@ -18094,7 +17826,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "s": { - "display-name": "CredDefValuePrimary", "type": "optional", "validation": { "format": undefined, @@ -18104,7 +17835,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "z": { - "display-name": "CredDefValuePrimary", "type": "optional", "validation": { "format": undefined, @@ -18122,47 +17852,36 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "g": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "g_dash": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "h": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "h0": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "h1": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "h2": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "h_cap": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "htilde": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "pk": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "u": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "y": { - "display-name": "CredDefValueRevocation", "type": "optional", }, }, @@ -18174,7 +17893,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "CredInfoList", "type": "optional>", }, }, @@ -18186,7 +17904,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "rev_reg_delta": { - "display-name": "CredRevIndyRecordsResult", "docs": "Indy revocation registry delta", "type": "optional", }, @@ -18206,7 +17923,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "CredRevRecordDetailsResult", "type": "optional>", }, }, @@ -18218,7 +17934,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "CredRevRecordResult", "type": "optional", }, }, @@ -18230,7 +17945,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "revoked": { - "display-name": "CredRevokedResult", "docs": "Whether credential is revoked on the ledger", "type": "optional", }, @@ -18248,11 +17962,9 @@ exports[`open api parser > aries > docs 1`] = ` "type": "list>", }, "credentialSubject": { - "display-name": "credentialSubject", "type": "map", }, "expirationDate": { - "display-name": "Credential", "docs": "The expiration date", "type": "optional", "validation": { @@ -18263,7 +17975,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "id": { - "display-name": "Credential", "type": "optional", "validation": { "format": undefined, @@ -18283,12 +17994,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "issuer": { - "display-name": "issuer", "docs": "The JSON-LD Verifiable Credential Issuer. Either string of object with id field.", "type": "map", }, "proof": { - "display-name": "Credential", "type": "optional", }, "type": { @@ -18305,7 +18014,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "id": { - "display-name": "CredentialDefinition", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -18316,26 +18024,21 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schemaId": { - "display-name": "CredentialDefinition", "docs": "Schema identifier within credential definition identifier", "type": "optional", }, "tag": { - "display-name": "CredentialDefinition", "docs": "Tag within credential definition identifier", "type": "optional", }, "type": { - "display-name": "CredentialDefinition", "docs": "Signature type: CL for Camenisch-Lysyanskaya", "type": "optional>", }, "value": { - "display-name": "CredentialDefinition", "type": "optional", }, "ver": { - "display-name": "CredentialDefinition", "docs": "Node protocol version", "type": "optional", "validation": { @@ -18354,7 +18057,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "credential_definition": { - "display-name": "CredentialDefinitionGetResult", "type": "optional", }, }, @@ -18366,7 +18068,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "credential_definition_id": { - "display-name": "CredentialDefinitionSendResult", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -18390,7 +18091,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "credential_definition_ids": { - "display-name": "CredentialDefinitionsCreatedResult", "type": "optional>", }, }, @@ -18402,22 +18102,18 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "CredentialOffer", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "CredentialOffer", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "CredentialOffer", "docs": "Human-readable comment", "type": "optional", }, "credential_preview": { - "display-name": "CredentialOffer", "type": "optional", }, "offers~attach": { @@ -18433,7 +18129,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@type": { - "display-name": "CredentialPreview", "docs": "Message type identifier", "type": "optional", }, @@ -18452,22 +18147,18 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "CredentialProposal", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "CredentialProposal", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "CredentialProposal", "docs": "Human-readable comment", "type": "optional", }, "cred_def_id": { - "display-name": "CredentialProposal", "type": "optional", "validation": { "format": undefined, @@ -18477,11 +18168,9 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "credential_proposal": { - "display-name": "CredentialProposal", "type": "optional", }, "issuer_did": { - "display-name": "CredentialProposal", "type": "optional", "validation": { "format": undefined, @@ -18491,7 +18180,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_id": { - "display-name": "CredentialProposal", "type": "optional", "validation": { "format": undefined, @@ -18501,7 +18189,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_issuer_did": { - "display-name": "CredentialProposal", "type": "optional", "validation": { "format": undefined, @@ -18511,11 +18198,9 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_name": { - "display-name": "CredentialProposal", "type": "optional", }, "schema_version": { - "display-name": "CredentialProposal", "type": "optional", "validation": { "format": undefined, @@ -18545,7 +18230,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "did": { - "display-name": "DID", "docs": "DID of interest", "type": "optional", "validation": { @@ -18556,22 +18240,18 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "key_type": { - "display-name": "DID", "docs": "Key type associated with the DID", "type": "optional", }, "method": { - "display-name": "DID", "docs": "Did method associated with the DID", "type": "optional", }, "posture": { - "display-name": "DID", "docs": "Whether DID is current public DID, posted to ledger but not current public DID, or local to the wallet", "type": "optional", }, "verkey": { - "display-name": "DID", "docs": "Public verification key", "type": "optional", "validation": { @@ -18590,7 +18270,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "did": { - "display-name": "DIDCreateOptions", "docs": "Specify final value of the did (including did:: prefix)if the method supports or requires so.", "type": "optional", "validation": { @@ -18601,7 +18280,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "key_type": { - "display-name": "key_type", "docs": "Key type to use for the DID keypair. Validated with the chosen DID method's supported key types.", "type": "DidCreateOptionsKeyType", }, @@ -18624,7 +18302,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "endpoint": { - "display-name": "DIDEndpoint", "docs": "Endpoint to set (omit to delete)", "type": "optional", "validation": { @@ -18643,7 +18320,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "DIDList", "docs": "DID list", "type": "optional>", }, @@ -18656,7 +18332,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "DIDResult", "type": "optional", }, }, @@ -18668,25 +18343,20 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "filter": { - "display-name": "DIFField", "type": "optional", }, "id": { - "display-name": "DIFField", "docs": "ID", "type": "optional", }, "path": { - "display-name": "DIFField", "type": "optional>", }, "predicate": { - "display-name": "DIFField", "docs": "Preference", "type": "optional", }, "purpose": { - "display-name": "DIFField", "docs": "Purpose", "type": "optional", }, @@ -18699,12 +18369,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "directive": { - "display-name": "DIFHolder", "docs": "Preference", "type": "optional", }, "field_id": { - "display-name": "DIFHolder", "type": "optional>", }, }, @@ -18716,7 +18384,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "challenge": { - "display-name": "DIFOptions", "docs": "Challenge protect against replay attack", "type": "optional", "validation": { @@ -18727,7 +18394,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "domain": { - "display-name": "DIFOptions", "docs": "Domain protect against replay attack", "type": "optional", }, @@ -18740,21 +18406,17 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "issuer_id": { - "display-name": "DIFPresSpec", "docs": "Issuer identifier to sign the presentation, if different from current public DID", "type": "optional", }, "presentation_definition": { - "display-name": "DIFPresSpec", "type": "optional", }, "record_ids": { - "display-name": "DIFPresSpec", "docs": "Mapping of input_descriptor id to list of stored W3C credential record_id", "type": "optional", }, "reveal_doc": { - "display-name": "DIFPresSpec", "docs": "reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required", "type": "optional", }, @@ -18767,11 +18429,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "input_descriptors": { - "display-name": "DIFProofProposal", "type": "optional>", }, "options": { - "display-name": "DIFProofProposal", "type": "optional", }, }, @@ -18783,7 +18443,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "options": { - "display-name": "DIFProofRequest", "type": "optional", }, "presentation_definition": { @@ -18854,12 +18513,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "Disclose", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "Disclose", "docs": "Message type", "type": "optional", }, @@ -18877,12 +18534,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "Disclosures", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "Disclosures", "docs": "Message type", "type": "optional", }, @@ -18929,7 +18584,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "string", }, "endorser_name": { - "display-name": "EndorserInfo", "docs": "Endorser Name", "type": "optional", }, @@ -18942,7 +18596,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "my_endpoint": { - "display-name": "EndpointsResult", "docs": "My endpoint", "type": "optional", "validation": { @@ -18953,7 +18606,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "their_endpoint": { - "display-name": "EndpointsResult", "docs": "Their endpoint", "type": "optional", "validation": { @@ -18972,61 +18624,49 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "const": { - "display-name": "Filter", "docs": "Const", "type": "optional>", }, "enum": { - "display-name": "Filter", "type": "optional>>", }, "exclusiveMaximum": { - "display-name": "Filter", "docs": "ExclusiveMaximum", "type": "optional>", }, "exclusiveMinimum": { - "display-name": "Filter", "docs": "ExclusiveMinimum", "type": "optional>", }, "format": { - "display-name": "Filter", "docs": "Format", "type": "optional", }, "maxLength": { - "display-name": "Filter", "docs": "Max Length", "type": "optional", }, "maximum": { - "display-name": "Filter", "docs": "Maximum", "type": "optional>", }, "minLength": { - "display-name": "Filter", "docs": "Min Length", "type": "optional", }, "minimum": { - "display-name": "Filter", "docs": "Minimum", "type": "optional>", }, "not": { - "display-name": "Filter", "docs": "Not", "type": "optional", }, "pattern": { - "display-name": "Filter", "docs": "Pattern", "type": "optional", }, "type": { - "display-name": "Filter", "docs": "Type", "type": "optional", }, @@ -19039,7 +18679,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "master_secret": { - "display-name": "Generated", "type": "optional", "validation": { "format": undefined, @@ -19049,7 +18688,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "number": { - "display-name": "Generated", "type": "optional", "validation": { "format": undefined, @@ -19059,7 +18697,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "remainder": { - "display-name": "Generated", "type": "optional", "validation": { "format": undefined, @@ -19077,7 +18714,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "endpoint": { - "display-name": "GetDIDEndpointResponse", "docs": "Full verification key", "type": "optional", "validation": { @@ -19096,7 +18732,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "verkey": { - "display-name": "GetDIDVerkeyResponse", "docs": "Full verification key", "type": "optional", "validation": { @@ -19115,7 +18750,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "role": { - "display-name": "GetNymRoleResponse", "docs": "Ledger role", "type": "optional", }, @@ -19209,12 +18843,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "attrs": { - "display-name": "IndyCredInfo", "docs": "Attribute names and value", "type": "optional>", }, "cred_def_id": { - "display-name": "IndyCredInfo", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -19225,7 +18857,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "cred_rev_id": { - "display-name": "IndyCredInfo", "docs": "Credential revocation identifier", "type": "optional", "validation": { @@ -19236,12 +18867,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "referent": { - "display-name": "IndyCredInfo", "docs": "Wallet referent", "type": "optional", }, "rev_reg_id": { - "display-name": "IndyCredInfo", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -19252,7 +18881,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_id": { - "display-name": "IndyCredInfo", "docs": "Schema identifier", "type": "optional", "validation": { @@ -19271,15 +18899,12 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "cred_info": { - "display-name": "IndyCredPrecis", "type": "optional", }, "interval": { - "display-name": "IndyCredPrecis", "type": "optional", }, "presentation_referents": { - "display-name": "IndyCredPrecis", "type": "optional>", }, }, @@ -19373,12 +18998,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "rev_reg": { - "display-name": "IndyCredential", "docs": "Revocation registry state", "type": "optional", }, "rev_reg_id": { - "display-name": "IndyCredential", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -19409,12 +19032,10 @@ exports[`open api parser > aries > docs 1`] = ` "type": "IndyCredentialSignatureCorrectnessProof", }, "values": { - "display-name": "values", "docs": "Credential attributes", "type": "map", }, "witness": { - "display-name": "IndyCredential", "docs": "Witness for revocation proof", "type": "optional", }, @@ -19446,7 +19067,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "a_prime": { - "display-name": "IndyEQProof", "type": "optional", "validation": { "format": undefined, @@ -19456,7 +19076,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "e": { - "display-name": "IndyEQProof", "type": "optional", "validation": { "format": undefined, @@ -19466,11 +19085,9 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "m": { - "display-name": "IndyEQProof", "type": "optional>", }, "m2": { - "display-name": "IndyEQProof", "type": "optional", "validation": { "format": undefined, @@ -19480,11 +19097,9 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "revealed_attrs": { - "display-name": "IndyEQProof", "type": "optional>", }, "v": { - "display-name": "IndyEQProof", "type": "optional", "validation": { "format": undefined, @@ -19502,7 +19117,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "alpha": { - "display-name": "IndyGEProof", "type": "optional", "validation": { "format": undefined, @@ -19512,7 +19126,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "mj": { - "display-name": "IndyGEProof", "type": "optional", "validation": { "format": undefined, @@ -19522,19 +19135,15 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "predicate": { - "display-name": "IndyGEProof", "type": "optional", }, "r": { - "display-name": "IndyGEProof", "type": "optional>", }, "t": { - "display-name": "IndyGEProof", "type": "optional>", }, "u": { - "display-name": "IndyGEProof", "type": "optional>", }, }, @@ -19546,17 +19155,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "attr_name": { - "display-name": "IndyGEProofPred", "docs": "Attribute name, indy-canonicalized", "type": "optional", }, "p_type": { - "display-name": "IndyGEProofPred", "docs": "Predicate type", "type": "optional", }, "value": { - "display-name": "IndyGEProofPred", "docs": "Predicate threshold value", "type": "optional", }, @@ -19614,11 +19220,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "c_list": { - "display-name": "IndyNonRevocProof", "type": "optional>", }, "x_list": { - "display-name": "IndyNonRevocProof", "type": "optional>", }, }, @@ -19630,7 +19234,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "from": { - "display-name": "IndyNonRevocationInterval", "docs": "Earliest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -19642,7 +19245,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "to": { - "display-name": "IndyNonRevocationInterval", "docs": "Latest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -19662,7 +19264,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "cred_def_id": { - "display-name": "IndyPresAttrSpec", "type": "optional", "validation": { "format": undefined, @@ -19672,7 +19273,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "mime-type": { - "display-name": "IndyPresAttrSpec", "docs": "MIME type (default null)", "type": "optional", }, @@ -19681,12 +19281,10 @@ exports[`open api parser > aries > docs 1`] = ` "type": "string", }, "referent": { - "display-name": "IndyPresAttrSpec", "docs": "Credential referent", "type": "optional", }, "value": { - "display-name": "IndyPresAttrSpec", "docs": "Attribute value", "type": "optional", }, @@ -19699,7 +19297,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "cred_def_id": { - "display-name": "IndyPresPredSpec", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -19754,7 +19351,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@type": { - "display-name": "IndyPresPreview", "docs": "Message type identifier", "type": "optional", }, @@ -19781,7 +19377,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "map", }, "trace": { - "display-name": "IndyPresSpec", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -19794,11 +19389,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "eq_proof": { - "display-name": "IndyPrimaryProof", "type": "optional", }, "ge_proofs": { - "display-name": "IndyPrimaryProof", "docs": "Indy GE proofs", "type": "optional>", }, @@ -19815,16 +19408,13 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "identifiers": { - "display-name": "IndyProof", "docs": "Indy proof.identifiers content", "type": "optional>", }, "proof": { - "display-name": "IndyProof", "type": "optional", }, "requested_proof": { - "display-name": "IndyProof", "type": "optional", }, }, @@ -19836,7 +19426,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "cred_def_id": { - "display-name": "IndyProofIdentifier", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -19847,7 +19436,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "rev_reg_id": { - "display-name": "IndyProofIdentifier", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -19858,7 +19446,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_id": { - "display-name": "IndyProofIdentifier", "docs": "Schema identifier", "type": "optional", "validation": { @@ -19869,7 +19456,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "timestamp": { - "display-name": "IndyProofIdentifier", "docs": "Timestamp epoch", "type": "optional", "validation": { @@ -19889,11 +19475,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "aggregated_proof": { - "display-name": "IndyProofProof", "type": "optional", }, "proofs": { - "display-name": "IndyProofProof", "docs": "Indy proof proofs", "type": "optional>", }, @@ -19906,12 +19490,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "c_hash": { - "display-name": "IndyProofProofAggregatedProof", "docs": "c_hash value", "type": "optional", }, "c_list": { - "display-name": "IndyProofProofAggregatedProof", "docs": "c_list value", "type": "optional>>", }, @@ -19924,11 +19506,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "non_revoc_proof": { - "display-name": "IndyProofProofProofsProof", "type": "optional", }, "primary_proof": { - "display-name": "IndyProofProofProofsProof", "type": "optional", }, }, @@ -19949,21 +19529,17 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "name": { - "display-name": "IndyProofReqAttrSpec", "docs": "Attribute name", "type": "optional", }, "names": { - "display-name": "IndyProofReqAttrSpec", "docs": "Attribute name group", "type": "optional>", }, "non_revoked": { - "display-name": "IndyProofReqAttrSpec", "type": "optional", }, "restrictions": { - "display-name": "IndyProofReqAttrSpec", "docs": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", "type": "optional>>", }, @@ -19976,7 +19552,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "from": { - "display-name": "IndyProofReqAttrSpecNonRevoked", "docs": "Earliest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -19988,7 +19563,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "to": { - "display-name": "IndyProofReqAttrSpecNonRevoked", "docs": "Latest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -20012,7 +19586,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "string", }, "non_revoked": { - "display-name": "IndyProofReqPredSpec", "type": "optional", }, "p_type": { @@ -20024,7 +19597,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "integer", }, "restrictions": { - "display-name": "IndyProofReqPredSpec", "docs": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", "type": "optional>>", }, @@ -20037,7 +19609,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "from": { - "display-name": "IndyProofReqPredSpecNonRevoked", "docs": "Earliest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -20049,7 +19620,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "to": { - "display-name": "IndyProofReqPredSpecNonRevoked", "docs": "Latest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -20093,16 +19663,13 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "name": { - "display-name": "IndyProofRequest", "docs": "Proof request name", "type": "optional", }, "non_revoked": { - "display-name": "IndyProofRequest", "type": "optional", }, "nonce": { - "display-name": "IndyProofRequest", "docs": "Nonce", "type": "optional", "validation": { @@ -20121,7 +19688,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "map", }, "version": { - "display-name": "IndyProofRequest", "docs": "Proof request version", "type": "optional", "validation": { @@ -20140,7 +19706,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "from": { - "display-name": "IndyProofRequestNonRevoked", "docs": "Earliest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -20152,7 +19717,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "to": { - "display-name": "IndyProofRequestNonRevoked", "docs": "Latest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -20172,27 +19736,22 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "predicates": { - "display-name": "IndyProofRequestedProof", "docs": "Proof requested proof predicates.", "type": "optional>", }, "revealed_attr_groups": { - "display-name": "IndyProofRequestedProof", "docs": "Proof requested proof revealed attribute groups", "type": "optional>>", }, "revealed_attrs": { - "display-name": "IndyProofRequestedProof", "docs": "Proof requested proof revealed attributes", "type": "optional>>", }, "self_attested_attrs": { - "display-name": "IndyProofRequestedProof", "docs": "Proof requested proof self-attested attributes", "type": "optional", }, "unrevealed_attrs": { - "display-name": "IndyProofRequestedProof", "docs": "Unrevealed attributes", "type": "optional", }, @@ -20205,7 +19764,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "sub_proof_index": { - "display-name": "IndyProofRequestedProofPredicate", "docs": "Sub-proof index", "type": "optional", }, @@ -20218,7 +19776,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "encoded": { - "display-name": "IndyProofRequestedProofRevealedAttr", "docs": "Encoded value", "type": "optional", "validation": { @@ -20229,12 +19786,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "raw": { - "display-name": "IndyProofRequestedProofRevealedAttr", "docs": "Raw value", "type": "optional", }, "sub_proof_index": { - "display-name": "IndyProofRequestedProofRevealedAttr", "docs": "Sub-proof index", "type": "optional", }, @@ -20247,12 +19802,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "sub_proof_index": { - "display-name": "IndyProofRequestedProofRevealedAttrGroup", "docs": "Sub-proof index", "type": "optional", }, "values": { - "display-name": "IndyProofRequestedProofRevealedAttrGroup", "docs": "Indy proof requested proof revealed attr groups group value", "type": "optional>", }, @@ -20283,7 +19836,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "string", }, "revealed": { - "display-name": "IndyRequestedCredsRequestedAttr", "docs": "Whether to reveal attribute in proof (default true)", "type": "optional", }, @@ -20300,7 +19852,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "string", }, "timestamp": { - "display-name": "IndyRequestedCredsRequestedPred", "docs": "Epoch timestamp of interest for non-revocation proof", "type": "optional", "validation": { @@ -20320,7 +19871,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "credDefId": { - "display-name": "IndyRevRegDef", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -20331,7 +19881,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "id": { - "display-name": "IndyRevRegDef", "docs": "Indy revocation registry identifier", "type": "optional", "validation": { @@ -20342,21 +19891,17 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "revocDefType": { - "display-name": "IndyRevRegDef", "docs": "Revocation registry type (specify CL_ACCUM)", "type": "optional>", }, "tag": { - "display-name": "IndyRevRegDef", "docs": "Revocation registry tag", "type": "optional", }, "value": { - "display-name": "IndyRevRegDef", "type": "optional", }, "ver": { - "display-name": "IndyRevRegDef", "docs": "Version of revocation registry definition", "type": "optional", "validation": { @@ -20375,12 +19920,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "issuanceType": { - "display-name": "IndyRevRegDefValue", "docs": "Issuance type", "type": "optional", }, "maxCredNum": { - "display-name": "IndyRevRegDefValue", "docs": "Maximum number of credentials; registry size", "type": "optional", "validation": { @@ -20392,11 +19935,9 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "publicKeys": { - "display-name": "IndyRevRegDefValue", "type": "optional", }, "tailsHash": { - "display-name": "IndyRevRegDefValue", "docs": "Tails hash value", "type": "optional", "validation": { @@ -20407,7 +19948,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "tailsLocation": { - "display-name": "IndyRevRegDefValue", "docs": "Tails file location", "type": "optional", }, @@ -20420,7 +19960,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "accumKey": { - "display-name": "IndyRevRegDefValuePublicKeys", "type": "optional", }, }, @@ -20432,7 +19971,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "z": { - "display-name": "IndyRevRegDefValuePublicKeysAccumKey", "docs": "Value for z", "type": "optional", }, @@ -20445,11 +19983,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "value": { - "display-name": "IndyRevRegEntry", "type": "optional", }, "ver": { - "display-name": "IndyRevRegEntry", "docs": "Version of revocation registry entry", "type": "optional", "validation": { @@ -20468,17 +20004,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "accum": { - "display-name": "IndyRevRegEntryValue", "docs": "Accumulator value", "type": "optional", }, "prevAccum": { - "display-name": "IndyRevRegEntryValue", "docs": "Previous accumulator value", "type": "optional", }, "revoked": { - "display-name": "IndyRevRegEntryValue", "docs": "Revoked credential revocation identifiers", "type": "optional>", }, @@ -20491,35 +20024,28 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "constraints": { - "display-name": "InputDescriptors", "type": "optional", }, "group": { - "display-name": "InputDescriptors", "type": "optional>", }, "id": { - "display-name": "InputDescriptors", "docs": "ID", "type": "optional", }, "metadata": { - "display-name": "InputDescriptors", "docs": "Metadata dictionary", "type": "optional", }, "name": { - "display-name": "InputDescriptors", "docs": "Name", "type": "optional", }, "purpose": { - "display-name": "InputDescriptors", "docs": "Purpose", "type": "optional", }, "schema": { - "display-name": "InputDescriptors", "type": "optional", }, }, @@ -20537,41 +20063,33 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "InvitationMessage", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "InvitationMessage", "docs": "Message type", "type": "optional", }, "accept": { - "display-name": "InvitationMessage", "docs": "List of mime type in order of preference", "type": "optional>", }, "handshake_protocols": { - "display-name": "InvitationMessage", "type": "optional>", }, "imageUrl": { - "display-name": "InvitationMessage", "docs": "Optional image URL for out-of-band invitation", "type": "optional", }, "label": { - "display-name": "InvitationMessage", "docs": "Optional label", "type": "optional", }, "requests~attach": { - "display-name": "InvitationMessage", "docs": "Optional request attachment", "type": "optional>", }, "services": { - "display-name": "InvitationMessage", "type": "optional>>", }, }, @@ -20583,7 +20101,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "InvitationRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -20594,41 +20111,33 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "invi_msg_id": { - "display-name": "InvitationRecord", "docs": "Invitation message identifier", "type": "optional", }, "invitation": { - "display-name": "InvitationRecord", "type": "optional", }, "invitation_id": { - "display-name": "InvitationRecord", "docs": "Invitation record identifier", "type": "optional", }, "invitation_url": { - "display-name": "InvitationRecord", "docs": "Invitation message URL", "type": "optional", }, "oob_id": { - "display-name": "InvitationRecord", "docs": "Out of band record identifier", "type": "optional", }, "state": { - "display-name": "InvitationRecord", "docs": "Out of band message exchange state", "type": "optional", }, "trace": { - "display-name": "InvitationRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "InvitationRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -20652,16 +20161,13 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "connection_id": { - "display-name": "InvitationResult", "docs": "Connection identifier", "type": "optional", }, "invitation": { - "display-name": "InvitationResult", "type": "optional", }, "invitation_url": { - "display-name": "InvitationResult", "docs": "Invitation URL", "type": "optional", }, @@ -20675,7 +20181,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "IssuerCredRevRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -20686,7 +20191,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "cred_def_id": { - "display-name": "IssuerCredRevRecord", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -20697,17 +20201,14 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "cred_ex_id": { - "display-name": "IssuerCredRevRecord", "docs": "Credential exchange record identifier at credential issue", "type": "optional", }, "cred_ex_version": { - "display-name": "IssuerCredRevRecord", "docs": "Credential exchange version", "type": "optional", }, "cred_rev_id": { - "display-name": "IssuerCredRevRecord", "docs": "Credential revocation identifier", "type": "optional", "validation": { @@ -20718,12 +20219,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "record_id": { - "display-name": "IssuerCredRevRecord", "docs": "Issuer credential revocation record identifier", "type": "optional", }, "rev_reg_id": { - "display-name": "IssuerCredRevRecord", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -20734,12 +20233,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "state": { - "display-name": "IssuerCredRevRecord", "docs": "Issue credential revocation record state", "type": "optional", }, "updated_at": { - "display-name": "IssuerCredRevRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -20758,7 +20255,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "IssuerRevRegRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -20769,7 +20265,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "cred_def_id": { - "display-name": "IssuerRevRegRecord", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -20780,12 +20275,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "error_msg": { - "display-name": "IssuerRevRegRecord", "docs": "Error message", "type": "optional", }, "issuer_did": { - "display-name": "IssuerRevRegRecord", "docs": "Issuer DID", "type": "optional", "validation": { @@ -20796,35 +20289,28 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "max_cred_num": { - "display-name": "IssuerRevRegRecord", "docs": "Maximum number of credentials for revocation registry", "type": "optional", }, "pending_pub": { - "display-name": "IssuerRevRegRecord", "docs": "Credential revocation identifier for credential revoked and pending publication to ledger", "type": "optional>", }, "record_id": { - "display-name": "IssuerRevRegRecord", "docs": "Issuer revocation registry record identifier", "type": "optional", }, "revoc_def_type": { - "display-name": "IssuerRevRegRecord", "docs": "Revocation registry type (specify CL_ACCUM)", "type": "optional>", }, "revoc_reg_def": { - "display-name": "IssuerRevRegRecord", "type": "optional", }, "revoc_reg_entry": { - "display-name": "IssuerRevRegRecord", "type": "optional", }, "revoc_reg_id": { - "display-name": "IssuerRevRegRecord", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -20835,17 +20321,14 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "state": { - "display-name": "IssuerRevRegRecord", "docs": "Issue revocation registry record state", "type": "optional", }, "tag": { - "display-name": "IssuerRevRegRecord", "docs": "Tag within issuer revocation registry identifier", "type": "optional", }, "tails_hash": { - "display-name": "IssuerRevRegRecord", "docs": "Tails hash", "type": "optional", "validation": { @@ -20856,17 +20339,14 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "tails_local_path": { - "display-name": "IssuerRevRegRecord", "docs": "Local path to tails file", "type": "optional", }, "tails_public_uri": { - "display-name": "IssuerRevRegRecord", "docs": "Public URI for tails file", "type": "optional", }, "updated_at": { - "display-name": "IssuerRevRegRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -20895,7 +20375,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "Keylist", "docs": "List of keylist records", "type": "optional>", }, @@ -20908,22 +20387,18 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "KeylistQuery", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "KeylistQuery", "docs": "Message type", "type": "optional", }, "filter": { - "display-name": "KeylistQuery", "docs": "Query dictionary object", "type": "optional", }, "paginate": { - "display-name": "KeylistQuery", "type": "optional", }, }, @@ -20942,12 +20417,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "limit": { - "display-name": "KeylistQueryPaginate", "docs": "Limit for keylist query", "type": "optional", }, "offset": { - "display-name": "KeylistQueryPaginate", "docs": "Offset value for query", "type": "optional", }, @@ -20960,17 +20433,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "KeylistUpdate", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "KeylistUpdate", "docs": "Message type", "type": "optional", }, "updates": { - "display-name": "KeylistUpdate", "docs": "List of update rules", "type": "optional>", }, @@ -21025,12 +20495,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "challenge": { - "display-name": "LDProofVCDetailOptions", "docs": "A challenge to include in the proof. SHOULD be provided by the requesting party of the credential (=holder)", "type": "optional", }, "created": { - "display-name": "LDProofVCDetailOptions", "docs": "The date and time of the proof (with a maximum accuracy in seconds). Defaults to current system time", "type": "optional", "validation": { @@ -21041,16 +20509,13 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "credentialStatus": { - "display-name": "LDProofVCDetailOptions", "type": "optional", }, "domain": { - "display-name": "LDProofVCDetailOptions", "docs": "The intended domain of validity for the proof", "type": "optional", }, "proofPurpose": { - "display-name": "LDProofVCDetailOptions", "docs": "The proof purpose used for the proof. Should match proof purposes registered in the Linked Data Proofs Specification", "type": "optional", }, @@ -21082,27 +20547,22 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "genesis_file": { - "display-name": "LedgerConfigInstance", "docs": "genesis_file", "type": "optional", }, "genesis_transactions": { - "display-name": "LedgerConfigInstance", "docs": "genesis_transactions", "type": "optional", }, "genesis_url": { - "display-name": "LedgerConfigInstance", "docs": "genesis_url", "type": "optional", }, "id": { - "display-name": "LedgerConfigInstance", "docs": "ledger_id", "type": "optional", }, "is_production": { - "display-name": "LedgerConfigInstance", "docs": "is_production", "type": "optional", }, @@ -21125,7 +20585,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "challenge": { - "display-name": "LinkedDataProof", "docs": "Associates a challenge with a proof, for use with a proofPurpose such as authentication", "type": "optional", }, @@ -21140,7 +20599,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "domain": { - "display-name": "LinkedDataProof", "docs": "A string value specifying the restricted domain of the signature.", "type": "optional", "validation": { @@ -21151,12 +20609,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "jws": { - "display-name": "LinkedDataProof", "docs": "Associates a Detached Json Web Signature with a proof", "type": "optional", }, "nonce": { - "display-name": "LinkedDataProof", "docs": "The nonce", "type": "optional", }, @@ -21165,7 +20621,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "string", }, "proofValue": { - "display-name": "LinkedDataProof", "docs": "The proof value of a proof", "type": "optional", }, @@ -21192,21 +20647,17 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "MediationDeny", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "MediationDeny", "docs": "Message type", "type": "optional", }, "mediator_terms": { - "display-name": "MediationDeny", "type": "optional>", }, "recipient_terms": { - "display-name": "MediationDeny", "type": "optional>", }, }, @@ -21218,22 +20669,18 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "MediationGrant", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "MediationGrant", "docs": "Message type", "type": "optional", }, "endpoint": { - "display-name": "MediationGrant", "docs": "endpoint on which messages destined for the recipient are received.", "type": "optional", }, "routing_keys": { - "display-name": "MediationGrant", "type": "optional>", }, }, @@ -21245,7 +20692,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "MediationList", "docs": "List of mediation records", "type": "optional>", }, @@ -21259,7 +20705,6 @@ exports[`open api parser > aries > docs 1`] = ` "properties": { "connection_id": "string", "created_at": { - "display-name": "MediationRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -21270,33 +20715,26 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "endpoint": { - "display-name": "MediationRecord", "type": "optional", }, "mediation_id": { - "display-name": "MediationRecord", "type": "optional", }, "mediator_terms": { - "display-name": "MediationRecord", "type": "optional>", }, "recipient_terms": { - "display-name": "MediationRecord", "type": "optional>", }, "role": "string", "routing_keys": { - "display-name": "MediationRecord", "type": "optional>", }, "state": { - "display-name": "MediationRecord", "docs": "Current record state", "type": "optional", }, "updated_at": { - "display-name": "MediationRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -21315,22 +20753,18 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "Menu", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "Menu", "docs": "Message type", "type": "optional", }, "description": { - "display-name": "Menu", "docs": "Introductory text for the menu", "type": "optional", }, "errormsg": { - "display-name": "Menu", "docs": "An optional error message to display in menu header", "type": "optional", }, @@ -21340,7 +20774,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "list", }, "title": { - "display-name": "Menu", "docs": "Menu title", "type": "optional", }, @@ -21353,22 +20786,18 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "description": { - "display-name": "MenuForm", "docs": "Additional descriptive text for menu form", "type": "optional", }, "params": { - "display-name": "MenuForm", "docs": "List of form parameters", "type": "optional>", }, "submit-label": { - "display-name": "MenuForm", "docs": "Alternative label for form submit button", "type": "optional", }, "title": { - "display-name": "MenuForm", "docs": "Menu form title", "type": "optional", }, @@ -21381,12 +20810,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "default": { - "display-name": "MenuFormParam", "docs": "Default parameter value", "type": "optional", }, "description": { - "display-name": "MenuFormParam", "docs": "Additional descriptive text for menu form parameter", "type": "optional", }, @@ -21395,7 +20822,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "string", }, "required": { - "display-name": "MenuFormParam", "docs": "Whether parameter is required", "type": "optional", }, @@ -21404,7 +20830,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "string", }, "type": { - "display-name": "MenuFormParam", "docs": "Menu form parameter input type", "type": "optional", }, @@ -21417,12 +20842,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "description": { - "display-name": "MenuJson", "docs": "Introductory text for the menu", "type": "optional", }, "errormsg": { - "display-name": "MenuJson", "docs": "Optional error message to display in menu header", "type": "optional", }, @@ -21432,7 +20855,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "list", }, "title": { - "display-name": "MenuJson", "docs": "Menu title", "type": "optional", }, @@ -21445,17 +20867,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "description": { - "display-name": "MenuOption", "docs": "Additional descriptive text for menu option", "type": "optional", }, "disabled": { - "display-name": "MenuOption", "docs": "Whether to show option as disabled", "type": "optional", }, "form": { - "display-name": "MenuOption", "type": "optional", }, "name": { @@ -21476,17 +20895,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "attach_thread_id": { - "display-name": "OobRecord", "docs": "Connection record identifier", "type": "optional", }, "connection_id": { - "display-name": "OobRecord", "docs": "Connection record identifier", "type": "optional", }, "created_at": { - "display-name": "OobRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -21506,12 +20922,10 @@ exports[`open api parser > aries > docs 1`] = ` "type": "string", }, "our_recipient_key": { - "display-name": "OobRecord", "docs": "Recipient key used for oob invitation", "type": "optional", }, "role": { - "display-name": "OobRecord", "docs": "OOB Role", "type": "optional", }, @@ -21520,16 +20934,13 @@ exports[`open api parser > aries > docs 1`] = ` "type": "OobRecordState", }, "their_service": { - "display-name": "OobRecord", "type": "optional", }, "trace": { - "display-name": "OobRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "OobRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -21585,7 +20996,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "thread_id": { - "display-name": "PingRequestResponse", "docs": "Thread ID of the ping message", "type": "optional", }, @@ -21598,11 +21008,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "format": { - "display-name": "PresentationDefinition", "type": "optional", }, "id": { - "display-name": "PresentationDefinition", "docs": "Unique Resource Identifier", "type": "optional", "validation": { @@ -21613,21 +21021,17 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "input_descriptors": { - "display-name": "PresentationDefinition", "type": "optional>", }, "name": { - "display-name": "PresentationDefinition", "docs": "Human-friendly name that describes what the presentation definition pertains to", "type": "optional", }, "purpose": { - "display-name": "PresentationDefinition", "docs": "Describes the purpose for which the Presentation Definition's inputs are being requested", "type": "optional", }, "submission_requirements": { - "display-name": "PresentationDefinition", "type": "optional>", }, }, @@ -21639,17 +21043,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "PresentationProposal", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "PresentationProposal", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "PresentationProposal", "docs": "Human-readable comment", "type": "optional", }, @@ -21666,17 +21067,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "PresentationRequest", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "PresentationRequest", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "PresentationRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -21694,7 +21092,6 @@ exports[`open api parser > aries > docs 1`] = ` "properties": { "pid": "string", "roles": { - "display-name": "ProtocolDescriptor", "docs": "List of roles", "type": "optional>", }, @@ -21707,7 +21104,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "rrid2crid": { - "display-name": "PublishRevocations", "docs": "Credential revocation ids by revocation registry id", "type": "optional>>", }, @@ -21720,17 +21116,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "Queries", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "Queries", "docs": "Message type", "type": "optional", }, "queries": { - "display-name": "Queries", "type": "optional>", }, }, @@ -21742,17 +21135,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "Query", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "Query", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "Query", "type": "optional", }, "query": "string", @@ -21765,7 +21155,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "feature-type": { - "display-name": "feature-type", "docs": "feature type", "type": "QueryItemFeatureType", }, @@ -21795,7 +21184,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "encoded": { - "display-name": "RawEncoded", "docs": "Encoded value", "type": "optional", "validation": { @@ -21806,7 +21194,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "raw": { - "display-name": "RawEncoded", "docs": "Raw value", "type": "optional", }, @@ -21849,7 +21236,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "RevRegIssuedResult", "docs": "Number of credentials issued against revocation registry", "type": "optional", "validation": { @@ -21869,7 +21255,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "RevRegResult", "type": "optional", }, }, @@ -21881,17 +21266,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "accum_calculated": { - "display-name": "RevRegWalletUpdatedResult", "docs": "Calculated accumulator for phantom revocations", "type": "optional", }, "accum_fixed": { - "display-name": "RevRegWalletUpdatedResult", "docs": "Applied ledger transaction to fix revocations", "type": "optional", }, "rev_reg_delta": { - "display-name": "RevRegWalletUpdatedResult", "docs": "Indy revocation registry delta", "type": "optional", }, @@ -21925,7 +21307,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "rev_reg_ids": { - "display-name": "RevRegsCreated", "type": "optional>", }, }, @@ -21938,11 +21319,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "connection_id": { - "display-name": "RouteRecord", "type": "optional", }, "created_at": { - "display-name": "RouteRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -21954,20 +21333,16 @@ exports[`open api parser > aries > docs 1`] = ` }, "recipient_key": "string", "record_id": { - "display-name": "RouteRecord", "type": "optional", }, "role": { - "display-name": "RouteRecord", "type": "optional", }, "state": { - "display-name": "RouteRecord", "docs": "Current record state", "type": "optional", }, "updated_at": { - "display-name": "RouteRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -21978,7 +21353,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "wallet_id": { - "display-name": "RouteRecord", "type": "optional", }, }, @@ -21990,12 +21364,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "attrNames": { - "display-name": "Schema", "docs": "Schema attribute names", "type": "optional>", }, "id": { - "display-name": "Schema", "docs": "Schema identifier", "type": "optional", "validation": { @@ -22006,12 +21378,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "name": { - "display-name": "Schema", "docs": "Schema name", "type": "optional", }, "seqNo": { - "display-name": "Schema", "docs": "Schema sequence number", "type": "optional", "validation": { @@ -22023,7 +21393,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "ver": { - "display-name": "Schema", "docs": "Node protocol version", "type": "optional", "validation": { @@ -22034,7 +21403,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "version": { - "display-name": "Schema", "docs": "Schema version", "type": "optional", "validation": { @@ -22053,7 +21421,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "schema": { - "display-name": "SchemaGetResult", "type": "optional", }, }, @@ -22065,12 +21432,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "required": { - "display-name": "SchemaInputDescriptor", "docs": "Required", "type": "optional", }, "uri": { - "display-name": "SchemaInputDescriptor", "docs": "URI", "type": "optional", }, @@ -22083,7 +21448,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "schema": { - "display-name": "SchemaSendResult", "type": "optional", }, "schema_id": { @@ -22110,7 +21474,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "schema_ids": { - "display-name": "SchemasCreatedResult", "type": "optional>", }, }, @@ -22122,12 +21485,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "oneof_filter": { - "display-name": "SchemasInputDescriptorFilter", "docs": "oneOf", "type": "optional", }, "uri_groups": { - "display-name": "SchemasInputDescriptorFilter", "type": "optional>>", }, }, @@ -22148,7 +21509,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "list", }, "routingKeys": { - "display-name": "ServiceDecorator", "docs": "List of routing keys", "type": "optional>", }, @@ -22165,12 +21525,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "error": { - "display-name": "SignResponse", "docs": "Error text", "type": "optional", }, "signed_doc": { - "display-name": "SignResponse", "docs": "Signed document", "type": "optional", }, @@ -22190,16 +21548,13 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "challenge": { - "display-name": "SignatureOptions", "type": "optional", }, "domain": { - "display-name": "SignatureOptions", "type": "optional", }, "proofPurpose": "string", "type": { - "display-name": "SignatureOptions", "type": "optional", }, "verificationMethod": "string", @@ -22226,41 +21581,33 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "count": { - "display-name": "SubmissionRequirements", "docs": "Count Value", "type": "optional", }, "from": { - "display-name": "SubmissionRequirements", "docs": "From", "type": "optional", }, "from_nested": { - "display-name": "SubmissionRequirements", "type": "optional>", }, "max": { - "display-name": "SubmissionRequirements", "docs": "Max Value", "type": "optional", }, "min": { - "display-name": "SubmissionRequirements", "docs": "Min Value", "type": "optional", }, "name": { - "display-name": "SubmissionRequirements", "docs": "Name", "type": "optional", }, "purpose": { - "display-name": "SubmissionRequirements", "docs": "Purpose", "type": "optional", }, "rule": { - "display-name": "SubmissionRequirements", "docs": "Selection", "type": "optional", }, @@ -22273,11 +21620,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "mechanism": { - "display-name": "TAAAcceptance", "type": "optional", }, "time": { - "display-name": "TAAAcceptance", "type": "optional", "validation": { "exclusiveMax": undefined, @@ -22296,19 +21641,15 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "aml_record": { - "display-name": "TAAInfo", "type": "optional", }, "taa_accepted": { - "display-name": "TAAInfo", "type": "optional", }, "taa_record": { - "display-name": "TAAInfo", "type": "optional", }, "taa_required": { - "display-name": "TAAInfo", "type": "optional", }, }, @@ -22320,15 +21661,12 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "digest": { - "display-name": "TAARecord", "type": "optional", }, "text": { - "display-name": "TAARecord", "type": "optional", }, "version": { - "display-name": "TAARecord", "type": "optional", }, }, @@ -22340,7 +21678,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "TAAResult", "type": "optional", }, }, @@ -22352,7 +21689,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "message": { - "display-name": "TailsDeleteResponse", "type": "optional", }, }, @@ -22364,12 +21700,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "transaction_my_job": { - "display-name": "TransactionJobs", "docs": "My transaction related job", "type": "optional", }, "transaction_their_job": { - "display-name": "TransactionJobs", "docs": "Their transaction related job", "type": "optional", }, @@ -22404,7 +21738,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "TransactionList", "docs": "List of transaction records", "type": "optional>", }, @@ -22417,17 +21750,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "_type": { - "display-name": "TransactionRecord", "docs": "Transaction type", "type": "optional", }, "connection_id": { - "display-name": "TransactionRecord", "docs": "The connection identifier for thie particular transaction record", "type": "optional", }, "created_at": { - "display-name": "TransactionRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -22438,56 +21768,44 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "endorser_write_txn": { - "display-name": "TransactionRecord", "docs": "If True, Endorser will write the transaction after endorsing it", "type": "optional", }, "formats": { - "display-name": "TransactionRecord", "type": "optional>>", }, "messages_attach": { - "display-name": "TransactionRecord", "type": "optional>", }, "meta_data": { - "display-name": "TransactionRecord", "type": "optional", }, "signature_request": { - "display-name": "TransactionRecord", "type": "optional>", }, "signature_response": { - "display-name": "TransactionRecord", "type": "optional>", }, "state": { - "display-name": "TransactionRecord", "docs": "Current record state", "type": "optional", }, "thread_id": { - "display-name": "TransactionRecord", "docs": "Thread Identifier", "type": "optional", }, "timing": { - "display-name": "TransactionRecord", "type": "optional", }, "trace": { - "display-name": "TransactionRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "transaction_id": { - "display-name": "TransactionRecord", "docs": "Transaction identifier", "type": "optional", }, "updated_at": { - "display-name": "TransactionRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -22541,11 +21859,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "sent": { - "display-name": "TxnOrCredentialDefinitionSendResult", "type": "optional", }, "txn": { - "display-name": "TxnOrCredentialDefinitionSendResult", "type": "optional", }, }, @@ -22562,11 +21878,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "sent": { - "display-name": "TxnOrPublishRevocationsResult", "type": "optional", }, "txn": { - "display-name": "TxnOrPublishRevocationsResult", "type": "optional", }, }, @@ -22583,12 +21897,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "success": { - "display-name": "TxnOrRegisterLedgerNymResponse", "docs": "Success of nym registration operation", "type": "optional", }, "txn": { - "display-name": "TxnOrRegisterLedgerNymResponse", "type": "optional", }, }, @@ -22605,11 +21917,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "sent": { - "display-name": "TxnOrRevRegResult", "type": "optional", }, "txn": { - "display-name": "TxnOrRevRegResult", "type": "optional", }, }, @@ -22626,11 +21936,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "sent": { - "display-name": "TxnOrSchemaSendResult", "type": "optional", }, "txn": { - "display-name": "TxnOrSchemaSendResult", "type": "optional", }, }, @@ -22657,27 +21965,22 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "auto_issue": { - "display-name": "V10CredentialExchange", "docs": "Issuer choice to issue to request in this credential exchange", "type": "optional", }, "auto_offer": { - "display-name": "V10CredentialExchange", "docs": "Holder choice to accept offer in this credential exchange", "type": "optional", }, "auto_remove": { - "display-name": "V10CredentialExchange", "docs": "Issuer choice to remove this credential exchange record when complete", "type": "optional", }, "connection_id": { - "display-name": "V10CredentialExchange", "docs": "Connection identifier", "type": "optional", }, "created_at": { - "display-name": "V10CredentialExchange", "docs": "Time of record creation", "type": "optional", "validation": { @@ -22688,11 +21991,9 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "credential": { - "display-name": "V10CredentialExchange", "type": "optional", }, "credential_definition_id": { - "display-name": "V10CredentialExchange", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -22703,72 +22004,57 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "credential_exchange_id": { - "display-name": "V10CredentialExchange", "docs": "Credential exchange identifier", "type": "optional", }, "credential_id": { - "display-name": "V10CredentialExchange", "docs": "Credential identifier", "type": "optional", }, "credential_offer": { - "display-name": "V10CredentialExchange", "type": "optional", }, "credential_offer_dict": { - "display-name": "V10CredentialExchange", "type": "optional", }, "credential_proposal_dict": { - "display-name": "V10CredentialExchange", "type": "optional", }, "credential_request": { - "display-name": "V10CredentialExchange", "type": "optional", }, "credential_request_metadata": { - "display-name": "V10CredentialExchange", "docs": "(Indy) credential request metadata", "type": "optional", }, "error_msg": { - "display-name": "V10CredentialExchange", "docs": "Error message", "type": "optional", }, "initiator": { - "display-name": "V10CredentialExchange", "docs": "Issue-credential exchange initiator: self or external", "type": "optional", }, "parent_thread_id": { - "display-name": "V10CredentialExchange", "docs": "Parent thread identifier", "type": "optional", }, "raw_credential": { - "display-name": "V10CredentialExchange", "type": "optional", }, "revoc_reg_id": { - "display-name": "V10CredentialExchange", "docs": "Revocation registry identifier", "type": "optional", }, "revocation_id": { - "display-name": "V10CredentialExchange", "docs": "Credential identifier within revocation registry", "type": "optional", }, "role": { - "display-name": "V10CredentialExchange", "docs": "Issue-credential exchange role: holder or issuer", "type": "optional", }, "schema_id": { - "display-name": "V10CredentialExchange", "docs": "Schema identifier", "type": "optional", "validation": { @@ -22779,22 +22065,18 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "state": { - "display-name": "V10CredentialExchange", "docs": "Issue-credential exchange state", "type": "optional", }, "thread_id": { - "display-name": "V10CredentialExchange", "docs": "Thread identifier", "type": "optional", }, "trace": { - "display-name": "V10CredentialExchange", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "V10CredentialExchange", "docs": "Time of last record update", "type": "optional", "validation": { @@ -22855,7 +22137,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V10CredentialExchangeListResult", "docs": "Aries#0036 v1.0 credential exchange records", "type": "optional>", }, @@ -22883,7 +22164,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V10DiscoveryExchangeListResult", "type": "optional>", }, }, @@ -22900,12 +22180,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "connection_id": { - "display-name": "V10DiscoveryRecord", "docs": "Connection identifier", "type": "optional", }, "created_at": { - "display-name": "V10DiscoveryRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -22916,35 +22194,28 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "disclose": { - "display-name": "V10DiscoveryRecord", "type": "optional", }, "discovery_exchange_id": { - "display-name": "V10DiscoveryRecord", "docs": "Credential exchange identifier", "type": "optional", }, "query_msg": { - "display-name": "V10DiscoveryRecord", "type": "optional", }, "state": { - "display-name": "V10DiscoveryRecord", "docs": "Current record state", "type": "optional", }, "thread_id": { - "display-name": "V10DiscoveryRecord", "docs": "Thread identifier", "type": "optional", }, "trace": { - "display-name": "V10DiscoveryRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "V10DiscoveryRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -22974,22 +22245,18 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "auto_present": { - "display-name": "V10PresentationExchange", "docs": "Prover choice to auto-present proof as verifier requests", "type": "optional", }, "auto_verify": { - "display-name": "V10PresentationExchange", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "connection_id": { - "display-name": "V10PresentationExchange", "docs": "Connection identifier", "type": "optional", }, "created_at": { - "display-name": "V10PresentationExchange", "docs": "Time of record creation", "type": "optional", "validation": { @@ -23000,58 +22267,46 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "error_msg": { - "display-name": "V10PresentationExchange", "docs": "Error message", "type": "optional", }, "initiator": { - "display-name": "V10PresentationExchange", "docs": "Present-proof exchange initiator: self or external", "type": "optional", }, "presentation": { - "display-name": "V10PresentationExchange", "type": "optional", }, "presentation_exchange_id": { - "display-name": "V10PresentationExchange", "docs": "Presentation exchange identifier", "type": "optional", }, "presentation_proposal_dict": { - "display-name": "V10PresentationExchange", "type": "optional", }, "presentation_request": { - "display-name": "V10PresentationExchange", "type": "optional", }, "presentation_request_dict": { - "display-name": "V10PresentationExchange", "type": "optional", }, "role": { - "display-name": "V10PresentationExchange", "docs": "Present-proof exchange role: prover or verifier", "type": "optional", }, "state": { - "display-name": "V10PresentationExchange", "docs": "Present-proof exchange state", "type": "optional", }, "thread_id": { - "display-name": "V10PresentationExchange", "docs": "Thread identifier", "type": "optional", }, "trace": { - "display-name": "V10PresentationExchange", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "V10PresentationExchange", "docs": "Time of last record update", "type": "optional", "validation": { @@ -23062,12 +22317,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "verified": { - "display-name": "V10PresentationExchange", "docs": "Whether presentation is verified: true or false", "type": "optional", }, "verified_msgs": { - "display-name": "V10PresentationExchange", "type": "optional>", }, }, @@ -23089,7 +22342,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V10PresentationExchangeList", "docs": "Aries RFC 37 v1.0 presentation exchange records", "type": "optional>", }, @@ -23142,7 +22394,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "mime-type": { - "display-name": "V20CredAttrSpec", "docs": "MIME type: omit for (null) default", "type": "optional", }, @@ -23173,12 +22424,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "auto_remove": { - "display-name": "V20CredExFree", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V20CredExFree", "docs": "Human-readable comment", "type": "optional", }, @@ -23193,17 +22442,14 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "credential_preview": { - "display-name": "V20CredExFree", "type": "optional", }, "filter": "V20CredBoundOfferRequestFilter", "trace": { - "display-name": "V20CredExFree", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "verification_method": { - "display-name": "V20CredExFree", "docs": "For ld-proofs. Verification method for signing.", "type": "optional", }, @@ -23216,31 +22462,25 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "auto_issue": { - "display-name": "V20CredExRecord", "docs": "Issuer choice to issue to request in this credential exchange", "type": "optional", }, "auto_offer": { - "display-name": "V20CredExRecord", "docs": "Holder choice to accept offer in this credential exchange", "type": "optional", }, "auto_remove": { - "display-name": "V20CredExRecord", "docs": "Issuer choice to remove this credential exchange record when complete", "type": "optional", }, "by_format": { - "display-name": "V20CredExRecord", "type": "optional", }, "connection_id": { - "display-name": "V20CredExRecord", "docs": "Connection identifier", "type": "optional", }, "created_at": { - "display-name": "V20CredExRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -23251,67 +22491,53 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "cred_ex_id": { - "display-name": "V20CredExRecord", "docs": "Credential exchange identifier", "type": "optional", }, "cred_issue": { - "display-name": "V20CredExRecord", "type": "optional", }, "cred_offer": { - "display-name": "V20CredExRecord", "type": "optional", }, "cred_preview": { - "display-name": "V20CredExRecord", "type": "optional", }, "cred_proposal": { - "display-name": "V20CredExRecord", "type": "optional", }, "cred_request": { - "display-name": "V20CredExRecord", "type": "optional", }, "error_msg": { - "display-name": "V20CredExRecord", "docs": "Error message", "type": "optional", }, "initiator": { - "display-name": "V20CredExRecord", "docs": "Issue-credential exchange initiator: self or external", "type": "optional", }, "parent_thread_id": { - "display-name": "V20CredExRecord", "docs": "Parent thread identifier", "type": "optional", }, "role": { - "display-name": "V20CredExRecord", "docs": "Issue-credential exchange role: holder or issuer", "type": "optional", }, "state": { - "display-name": "V20CredExRecord", "docs": "Issue-credential exchange state", "type": "optional", }, "thread_id": { - "display-name": "V20CredExRecord", "docs": "Thread identifier", "type": "optional", }, "trace": { - "display-name": "V20CredExRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "V20CredExRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -23330,19 +22556,15 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "cred_issue": { - "display-name": "V20CredExRecordByFormat", "type": "optional", }, "cred_offer": { - "display-name": "V20CredExRecordByFormat", "type": "optional", }, "cred_proposal": { - "display-name": "V20CredExRecordByFormat", "type": "optional", }, "cred_request": { - "display-name": "V20CredExRecordByFormat", "type": "optional", }, }, @@ -23407,15 +22629,12 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "cred_ex_record": { - "display-name": "V20CredExRecordDetail", "type": "optional", }, "indy": { - "display-name": "V20CredExRecordDetail", "type": "optional", }, "ld_proof": { - "display-name": "V20CredExRecordDetail", "type": "optional", }, }, @@ -23432,7 +22651,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "V20CredExRecordIndy", "docs": "Time of record creation", "type": "optional", "validation": { @@ -23443,27 +22661,22 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "cred_ex_id": { - "display-name": "V20CredExRecordIndy", "docs": "Corresponding v2.0 credential exchange record identifier", "type": "optional", }, "cred_ex_indy_id": { - "display-name": "V20CredExRecordIndy", "docs": "Record identifier", "type": "optional", }, "cred_id_stored": { - "display-name": "V20CredExRecordIndy", "docs": "Credential identifier stored in wallet", "type": "optional", }, "cred_request_metadata": { - "display-name": "V20CredExRecordIndy", "docs": "Credential request metadata for indy holder", "type": "optional", }, "cred_rev_id": { - "display-name": "V20CredExRecordIndy", "docs": "Credential revocation identifier within revocation registry", "type": "optional", "validation": { @@ -23474,7 +22687,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "rev_reg_id": { - "display-name": "V20CredExRecordIndy", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -23485,12 +22697,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "state": { - "display-name": "V20CredExRecordIndy", "docs": "Current record state", "type": "optional", }, "updated_at": { - "display-name": "V20CredExRecordIndy", "docs": "Time of last record update", "type": "optional", "validation": { @@ -23526,7 +22736,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "V20CredExRecordLDProof", "docs": "Time of record creation", "type": "optional", "validation": { @@ -23537,27 +22746,22 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "cred_ex_id": { - "display-name": "V20CredExRecordLDProof", "docs": "Corresponding v2.0 credential exchange record identifier", "type": "optional", }, "cred_ex_ld_proof_id": { - "display-name": "V20CredExRecordLDProof", "docs": "Record identifier", "type": "optional", }, "cred_id_stored": { - "display-name": "V20CredExRecordLDProof", "docs": "Credential identifier stored in wallet", "type": "optional", }, "state": { - "display-name": "V20CredExRecordLDProof", "docs": "Current record state", "type": "optional", }, "updated_at": { - "display-name": "V20CredExRecordLDProof", "docs": "Time of last record update", "type": "optional", "validation": { @@ -23576,7 +22780,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V20CredExRecordListResult", "docs": "Credential exchange records and corresponding detail records", "type": "optional>", }, @@ -23646,11 +22849,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "indy": { - "display-name": "V20CredFilter", "type": "optional", }, "ld_proof": { - "display-name": "V20CredFilter", "type": "optional", }, }, @@ -23662,7 +22863,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "cred_def_id": { - "display-name": "V20CredFilterIndy", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -23673,7 +22873,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "issuer_did": { - "display-name": "V20CredFilterIndy", "docs": "Credential issuer DID", "type": "optional", "validation": { @@ -23684,7 +22883,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_id": { - "display-name": "V20CredFilterIndy", "docs": "Schema identifier", "type": "optional", "validation": { @@ -23695,7 +22893,6 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_issuer_did": { - "display-name": "V20CredFilterIndy", "docs": "Schema issuer DID", "type": "optional", "validation": { @@ -23706,12 +22903,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "schema_name": { - "display-name": "V20CredFilterIndy", "docs": "Schema name", "type": "optional", }, "schema_version": { - "display-name": "V20CredFilterIndy", "docs": "Schema version", "type": "optional", "validation": { @@ -23751,17 +22946,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20CredIssue", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20CredIssue", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20CredIssue", "docs": "Human-readable comment", "type": "optional", }, @@ -23776,7 +22968,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "list", }, "replacement_id": { - "display-name": "V20CredIssue", "docs": "Issuer-unique identifier to coordinate credential replacement", "type": "optional", }, @@ -23789,22 +22980,18 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20CredOffer", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20CredOffer", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20CredOffer", "docs": "Human-readable comment", "type": "optional", }, "credential_preview": { - "display-name": "V20CredOffer", "type": "optional", }, "formats": { @@ -23818,7 +23005,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "list", }, "replacement_id": { - "display-name": "V20CredOffer", "docs": "Issuer-unique identifier to coordinate credential replacement", "type": "optional", }, @@ -23831,7 +23017,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@type": { - "display-name": "V20CredPreview", "docs": "Message type identifier", "type": "optional", }, @@ -23845,22 +23030,18 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20CredProposal", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20CredProposal", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20CredProposal", "docs": "Human-readable comment", "type": "optional", }, "credential_preview": { - "display-name": "V20CredProposal", "type": "optional", }, "filters~attach": { @@ -23887,17 +23068,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20CredRequest", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20CredRequest", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20CredRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -23925,7 +23103,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V20DiscoveryExchangeListResult", "type": "optional>", }, }, @@ -23942,7 +23119,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V20DiscoveryExchangeResult", "type": "optional", }, }, @@ -23954,12 +23130,10 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "connection_id": { - "display-name": "V20DiscoveryRecord", "docs": "Connection identifier", "type": "optional", }, "created_at": { - "display-name": "V20DiscoveryRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -23970,35 +23144,28 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "disclosures": { - "display-name": "V20DiscoveryRecord", "type": "optional", }, "discovery_exchange_id": { - "display-name": "V20DiscoveryRecord", "docs": "Credential exchange identifier", "type": "optional", }, "queries_msg": { - "display-name": "V20DiscoveryRecord", "type": "optional", }, "state": { - "display-name": "V20DiscoveryRecord", "docs": "Current record state", "type": "optional", }, "thread_id": { - "display-name": "V20DiscoveryRecord", "docs": "Thread identifier", "type": "optional", }, "trace": { - "display-name": "V20DiscoveryRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "V20DiscoveryRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -24028,17 +23195,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20Pres", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20Pres", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20Pres", "docs": "Human-readable comment", "type": "optional", }, @@ -24060,26 +23224,21 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "auto_present": { - "display-name": "V20PresExRecord", "docs": "Prover choice to auto-present proof as verifier requests", "type": "optional", }, "auto_verify": { - "display-name": "V20PresExRecord", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "by_format": { - "display-name": "V20PresExRecord", "type": "optional", }, "connection_id": { - "display-name": "V20PresExRecord", "docs": "Connection identifier", "type": "optional", }, "created_at": { - "display-name": "V20PresExRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -24090,54 +23249,43 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "error_msg": { - "display-name": "V20PresExRecord", "docs": "Error message", "type": "optional", }, "initiator": { - "display-name": "V20PresExRecord", "docs": "Present-proof exchange initiator: self or external", "type": "optional", }, "pres": { - "display-name": "V20PresExRecord", "type": "optional", }, "pres_ex_id": { - "display-name": "V20PresExRecord", "docs": "Presentation exchange identifier", "type": "optional", }, "pres_proposal": { - "display-name": "V20PresExRecord", "type": "optional", }, "pres_request": { - "display-name": "V20PresExRecord", "type": "optional", }, "role": { - "display-name": "V20PresExRecord", "docs": "Present-proof exchange role: prover or verifier", "type": "optional", }, "state": { - "display-name": "V20PresExRecord", "docs": "Present-proof exchange state", "type": "optional", }, "thread_id": { - "display-name": "V20PresExRecord", "docs": "Thread identifier", "type": "optional", }, "trace": { - "display-name": "V20PresExRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "V20PresExRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -24148,12 +23296,10 @@ exports[`open api parser > aries > docs 1`] = ` }, }, "verified": { - "display-name": "V20PresExRecord", "docs": "Whether presentation is verified: 'true' or 'false'", "type": "optional", }, "verified_msgs": { - "display-name": "V20PresExRecord", "type": "optional>", }, }, @@ -24165,15 +23311,12 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "pres": { - "display-name": "V20PresExRecordByFormat", "type": "optional", }, "pres_proposal": { - "display-name": "V20PresExRecordByFormat", "type": "optional", }, "pres_request": { - "display-name": "V20PresExRecordByFormat", "type": "optional", }, }, @@ -24209,7 +23352,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V20PresExRecordList", "docs": "Presentation exchange records", "type": "optional>", }, @@ -24308,17 +23450,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20PresProposal", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20PresProposal", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20PresProposal", "docs": "Human-readable comment", "type": "optional", }, @@ -24340,11 +23479,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "dif": { - "display-name": "V20PresProposalByFormat", "type": "optional", }, "indy": { - "display-name": "V20PresProposalByFormat", "type": "optional", }, }, @@ -24366,17 +23503,14 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20PresRequest", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20PresRequest", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20PresRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -24390,7 +23524,6 @@ exports[`open api parser > aries > docs 1`] = ` "type": "list", }, "will_confirm": { - "display-name": "V20PresRequest", "docs": "Whether verifier will send confirmation ack", "type": "optional", }, @@ -24403,11 +23536,9 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "dif": { - "display-name": "V20PresRequestByFormat", "type": "optional", }, "indy": { - "display-name": "V20PresRequestByFormat", "type": "optional", }, }, @@ -24440,47 +23571,37 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "contexts": { - "display-name": "VCRecord", "type": "optional>", }, "cred_tags": { - "display-name": "VCRecord", "type": "optional>", }, "cred_value": { - "display-name": "VCRecord", "docs": "(JSON-serializable) credential value", "type": "optional", }, "expanded_types": { - "display-name": "VCRecord", "type": "optional>", }, "given_id": { - "display-name": "VCRecord", "docs": "Credential identifier", "type": "optional", }, "issuer_id": { - "display-name": "VCRecord", "docs": "Issuer identifier", "type": "optional", }, "proof_types": { - "display-name": "VCRecord", "type": "optional>", }, "record_id": { - "display-name": "VCRecord", "docs": "Record identifier", "type": "optional", }, "schema_ids": { - "display-name": "VCRecord", "type": "optional>", }, "subject_ids": { - "display-name": "VCRecord", "type": "optional>", }, }, @@ -24492,7 +23613,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "VCRecordList", "type": "optional>", }, }, @@ -24516,7 +23636,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "error": { - "display-name": "VerifyResponse", "docs": "Error text", "type": "optional", }, @@ -24530,7 +23649,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "WalletList", "docs": "List of wallet records", "type": "optional>", }, @@ -24544,7 +23662,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "WalletRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -24559,17 +23676,14 @@ exports[`open api parser > aries > docs 1`] = ` "type": "WalletRecordKeyManagementMode", }, "settings": { - "display-name": "WalletRecord", "docs": "Settings for this wallet.", "type": "optional", }, "state": { - "display-name": "WalletRecord", "docs": "Current record state", "type": "optional", }, "updated_at": { - "display-name": "WalletRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -24609,7 +23723,6 @@ exports[`open api parser > aries > docs 1`] = ` "docs": undefined, "properties": { "ledger_id": { - "display-name": "WriteLedgerRequest", "type": "optional", }, }, @@ -24845,12 +23958,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "name": { - "display-name": "PerformRequest", "docs": "Menu option name", "type": "optional", }, "params": { - "display-name": "PerformRequest", "docs": "Input parameter values", "type": "optional>", }, @@ -24993,7 +24104,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "content": { - "display-name": "SendMessage", "docs": "Message content", "type": "optional", }, @@ -25198,7 +24308,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "mediation_id": { - "display-name": "CreateInvitationRequest", "docs": "Identifier for active mediation record to be used", "type": "optional", "validation": { @@ -25209,27 +24318,22 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "metadata": { - "display-name": "CreateInvitationRequest", "docs": "Optional metadata to attach to the connection created with the invitation", "type": "optional", }, "my_label": { - "display-name": "CreateInvitationRequest", "docs": "Optional label for connection invitation", "type": "optional", }, "recipient_keys": { - "display-name": "CreateInvitationRequest", "docs": "List of recipient keys", "type": "optional>", }, "routing_keys": { - "display-name": "CreateInvitationRequest", "docs": "List of routing keys", "type": "optional>", }, "service_endpoint": { - "display-name": "CreateInvitationRequest", "docs": "Connection endpoint", "type": "optional", }, @@ -25317,12 +24421,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "alias": { - "display-name": "ConnectionStaticRequest", "docs": "Alias to assign to this connection", "type": "optional", }, "my_did": { - "display-name": "ConnectionStaticRequest", "docs": "Local DID", "type": "optional", "validation": { @@ -25333,12 +24435,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "my_seed": { - "display-name": "ConnectionStaticRequest", "docs": "Seed to use for the local DID", "type": "optional", }, "their_did": { - "display-name": "ConnectionStaticRequest", "docs": "Remote DID", "type": "optional", "validation": { @@ -25349,7 +24449,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "their_endpoint": { - "display-name": "ConnectionStaticRequest", "docs": "URL endpoint for other party", "type": "optional", "validation": { @@ -25360,17 +24459,14 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "their_label": { - "display-name": "ConnectionStaticRequest", "docs": "Other party's label for this connection", "type": "optional", }, "their_seed": { - "display-name": "ConnectionStaticRequest", "docs": "Seed to use for the remote DID", "type": "optional", }, "their_verkey": { - "display-name": "ConnectionStaticRequest", "docs": "Remote verification key", "type": "optional", }, @@ -25694,17 +24790,14 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "@id": { - "display-name": "ReceiveInvitationRequest", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "ReceiveInvitationRequest", "docs": "Message type", "type": "optional", }, "did": { - "display-name": "ReceiveInvitationRequest", "docs": "DID for connection invitation", "type": "optional", "validation": { @@ -25715,27 +24808,22 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "imageUrl": { - "display-name": "ReceiveInvitationRequest", "docs": "Optional image URL for connection invitation", "type": "optional", }, "label": { - "display-name": "ReceiveInvitationRequest", "docs": "Optional label for connection invitation", "type": "optional", }, "recipientKeys": { - "display-name": "ReceiveInvitationRequest", "docs": "List of recipient keys", "type": "optional>", }, "routingKeys": { - "display-name": "ReceiveInvitationRequest", "docs": "List of routing keys", "type": "optional>", }, "serviceEndpoint": { - "display-name": "ReceiveInvitationRequest", "docs": "Service endpoint at which to reach this agent", "type": "optional", }, @@ -26089,7 +25177,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "revocation_registry_size": { - "display-name": "CredentialDefinitionSendRequest", "docs": "Revocation registry size", "type": "optional", "validation": { @@ -26101,7 +25188,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_id": { - "display-name": "CredentialDefinitionSendRequest", "docs": "Schema identifier", "type": "optional", "validation": { @@ -26112,12 +25198,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "support_revocation": { - "display-name": "CredentialDefinitionSendRequest", "docs": "Revocation supported flag", "type": "optional", }, "tag": { - "display-name": "CredentialDefinitionSendRequest", "docs": "Credential definition identifier tag", "type": "optional", }, @@ -26607,45 +25691,36 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "contexts": { - "display-name": "W3CCredentialsListRequest", "type": "optional>", }, "given_id": { - "display-name": "W3CCredentialsListRequest", "docs": "Given credential id to match", "type": "optional", }, "issuer_id": { - "display-name": "W3CCredentialsListRequest", "docs": "Credential issuer identifier to match", "type": "optional", }, "max_results": { - "display-name": "W3CCredentialsListRequest", "docs": "Maximum number of results to return", "type": "optional", }, "proof_types": { - "display-name": "W3CCredentialsListRequest", "type": "optional>", }, "schema_ids": { - "display-name": "W3CCredentialsListRequest", "docs": "Schema identifiers, all of which to match", "type": "optional>", }, "subject_ids": { - "display-name": "W3CCredentialsListRequest", "docs": "Subject identifiers, all of which to match", "type": "optional>", }, "tag_query": { - "display-name": "W3CCredentialsListRequest", "docs": "Tag filter", "type": "optional>", }, "types": { - "display-name": "W3CCredentialsListRequest", "type": "optional>", }, }, @@ -26948,17 +26023,14 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "@id": { - "display-name": "DIDXRequest", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "DIDXRequest", "docs": "Message type", "type": "optional", }, "did": { - "display-name": "DIDXRequest", "docs": "DID of exchange", "type": "optional", "validation": { @@ -26969,7 +26041,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "did_doc~attach": { - "display-name": "DIDXRequest", "type": "optional", }, "label": { @@ -28147,17 +27218,14 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_remove": { - "display-name": "V10CredentialCreate", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V10CredentialCreate", "docs": "Human-readable comment", "type": "optional", }, "cred_def_id": { - "display-name": "V10CredentialCreate", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -28172,7 +27240,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "root.CredentialPreview", }, "issuer_did": { - "display-name": "V10CredentialCreate", "docs": "Credential issuer DID", "type": "optional", "validation": { @@ -28183,7 +27250,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_id": { - "display-name": "V10CredentialCreate", "docs": "Schema identifier", "type": "optional", "validation": { @@ -28194,7 +27260,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_issuer_did": { - "display-name": "V10CredentialCreate", "docs": "Schema issuer DID", "type": "optional", "validation": { @@ -28205,12 +27270,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_name": { - "display-name": "V10CredentialCreate", "docs": "Schema name", "type": "optional", }, "schema_version": { - "display-name": "V10CredentialCreate", "docs": "Schema version", "type": "optional", "validation": { @@ -28221,7 +27284,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "trace": { - "display-name": "V10CredentialCreate", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -28407,17 +27469,14 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_issue": { - "display-name": "V10CredentialConnFreeOfferRequest", "docs": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "optional", }, "auto_remove": { - "display-name": "V10CredentialConnFreeOfferRequest", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V10CredentialConnFreeOfferRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -28436,7 +27495,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "root.CredentialPreview", }, "trace": { - "display-name": "V10CredentialConnFreeOfferRequest", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -29100,7 +28158,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "comment": { - "display-name": "V10CredentialIssueRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -29317,7 +28374,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "counter_proposal": { - "display-name": "V10CredentialBoundOfferRequest", "type": "optional", }, }, @@ -29666,12 +28722,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_remove": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Human-readable comment", "type": "optional", }, @@ -29686,7 +28740,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "cred_def_id": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -29701,7 +28754,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "root.CredentialPreview", }, "issuer_did": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Credential issuer DID", "type": "optional", "validation": { @@ -29712,7 +28764,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_id": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Schema identifier", "type": "optional", "validation": { @@ -29723,7 +28774,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_issuer_did": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Schema issuer DID", "type": "optional", "validation": { @@ -29734,12 +28784,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_name": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Schema name", "type": "optional", }, "schema_version": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Schema version", "type": "optional", "validation": { @@ -29750,7 +28798,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "trace": { - "display-name": "V10CredentialProposalRequestMand", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -29937,17 +28984,14 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_issue": { - "display-name": "V10CredentialFreeOfferRequest", "docs": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "optional", }, "auto_remove": { - "display-name": "V10CredentialFreeOfferRequest", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V10CredentialFreeOfferRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -29976,7 +29020,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "root.CredentialPreview", }, "trace": { - "display-name": "V10CredentialFreeOfferRequest", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -30167,12 +29210,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_remove": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Human-readable comment", "type": "optional", }, @@ -30187,7 +29228,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "cred_def_id": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -30198,11 +29238,9 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "credential_proposal": { - "display-name": "V10CredentialProposalRequestOpt", "type": "optional", }, "issuer_did": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Credential issuer DID", "type": "optional", "validation": { @@ -30213,7 +29251,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_id": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Schema identifier", "type": "optional", "validation": { @@ -30224,7 +29261,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_issuer_did": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Schema issuer DID", "type": "optional", "validation": { @@ -30235,12 +29271,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_name": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Schema name", "type": "optional", }, "schema_version": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Schema version", "type": "optional", "validation": { @@ -30251,7 +29285,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "trace": { - "display-name": "V10CredentialProposalRequestOpt", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -30427,7 +29460,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "credential_id": { - "display-name": "V10CredentialStoreRequest", "type": "optional", }, }, @@ -30715,22 +29747,18 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_remove": { - "display-name": "V20IssueCredSchemaCore", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V20IssueCredSchemaCore", "docs": "Human-readable comment", "type": "optional", }, "credential_preview": { - "display-name": "V20IssueCredSchemaCore", "type": "optional", }, "filter": "root.V20CredBoundOfferRequestFilter", "trace": { - "display-name": "V20IssueCredSchemaCore", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -30975,27 +30003,22 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_issue": { - "display-name": "V20CredOfferConnFreeRequest", "docs": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "optional", }, "auto_remove": { - "display-name": "V20CredOfferConnFreeRequest", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V20CredOfferConnFreeRequest", "docs": "Human-readable comment", "type": "optional", }, "credential_preview": { - "display-name": "V20CredOfferConnFreeRequest", "type": "optional", }, "filter": "root.V20CredBoundOfferRequestFilter", "trace": { - "display-name": "V20CredOfferConnFreeRequest", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -31975,7 +30998,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "comment": { - "display-name": "V20CredIssueRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -32267,11 +31289,9 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "counter_preview": { - "display-name": "V20CredBoundOfferRequest", "type": "optional", }, "filter": { - "display-name": "V20CredBoundOfferRequest", "type": "optional", }, }, @@ -32505,7 +31525,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "holder_did": { - "display-name": "V20CredRequestRequest", "docs": "Holder DID to substitute for the credentialSubject.id", "type": "optional", }, @@ -32989,17 +32008,14 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_issue": { - "display-name": "V20CredOfferRequest", "docs": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "optional", }, "auto_remove": { - "display-name": "V20CredOfferRequest", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V20CredOfferRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -33014,12 +32030,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "credential_preview": { - "display-name": "V20CredOfferRequest", "type": "optional", }, "filter": "root.V20CredBoundOfferRequestFilter", "trace": { - "display-name": "V20CredOfferRequest", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -33515,12 +32529,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_remove": { - "display-name": "V20CredRequestFree", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V20CredRequestFree", "docs": "Human-readable comment", "type": "optional", }, @@ -33536,12 +32548,10 @@ exports[`open api parser > aries > simple 1`] = ` }, "filter": "root.V20CredRequestFreeFilter", "holder_did": { - "display-name": "V20CredRequestFree", "docs": "Holder DID to substitute for the credentialSubject.id", "type": "optional", }, "trace": { - "display-name": "V20CredRequestFree", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -33796,7 +32806,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "credential_id": { - "display-name": "V20CredStoreRequest", "type": "optional", }, }, @@ -33961,7 +32970,6 @@ exports[`open api parser > aries > simple 1`] = ` "properties": { "doc": "root.VerifyRequestDoc", "verkey": { - "display-name": "VerifyRequest", "docs": "Verkey to use for doc verification", "type": "optional", }, @@ -34017,15 +33025,12 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "mechanism": { - "display-name": "TAAAccept", "type": "optional", }, "text": { - "display-name": "TAAAccept", "type": "optional", }, "version": { - "display-name": "TAAAccept", "type": "optional", }, }, @@ -34521,12 +33526,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "mediator_terms": { - "display-name": "AdminMediationDeny", "docs": "List of mediator rules for recipient", "type": "optional>", }, "recipient_terms": { - "display-name": "AdminMediationDeny", "docs": "List of recipient rules for mediation", "type": "optional>", }, @@ -34863,12 +33866,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "mediator_terms": { - "display-name": "MediationCreateRequest", "docs": "List of mediator rules for recipient", "type": "optional>", }, "recipient_terms": { - "display-name": "MediationCreateRequest", "docs": "List of recipient rules for mediation", "type": "optional>", }, @@ -34918,7 +33919,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "filter": { - "display-name": "KeylistQueryFilterRequest", "docs": "Filter for keylist query", "type": "optional", }, @@ -34994,7 +33994,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "updates": { - "display-name": "KeylistUpdateRequest", "type": "optional>", }, }, @@ -35099,7 +34098,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "mediation_id": { - "display-name": "MediationIdMatchInfo", "docs": "Mediation record identifier", "type": "optional", "validation": { @@ -35204,47 +34202,38 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "image_url": { - "display-name": "CreateWalletRequest", "docs": "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", "type": "optional", }, "key_management_mode": { - "display-name": "CreateWalletRequest", "docs": "Key management method to use for this wallet.", "type": "optional>", }, "label": { - "display-name": "CreateWalletRequest", "docs": "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", "type": "optional", }, "wallet_dispatch_type": { - "display-name": "CreateWalletRequest", "docs": "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", "type": "optional", }, "wallet_key": { - "display-name": "CreateWalletRequest", "docs": "Master key used for key derivation.", "type": "optional", }, "wallet_key_derivation": { - "display-name": "CreateWalletRequest", "docs": "Key derivation", "type": "optional", }, "wallet_name": { - "display-name": "CreateWalletRequest", "docs": "Wallet name", "type": "optional", }, "wallet_type": { - "display-name": "CreateWalletRequest", "docs": "Type of the wallet to create", "type": "optional", }, "wallet_webhook_urls": { - "display-name": "CreateWalletRequest", "docs": "List of Webhook URLs associated with this subwallet", "type": "optional>", }, @@ -35291,7 +34280,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "wallet_key": { - "display-name": "RemoveWalletRequest", "docs": "Master key used for key derivation. Only required for unmanaged wallets.", "type": "optional", }, @@ -35335,7 +34323,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "wallet_key": { - "display-name": "CreateWalletTokenRequest", "docs": "Master key used for key derivation. Only required for unamanged wallets.", "type": "optional", }, @@ -35471,22 +34458,18 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "image_url": { - "display-name": "UpdateWalletRequest", "docs": "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", "type": "optional", }, "label": { - "display-name": "UpdateWalletRequest", "docs": "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", "type": "optional", }, "wallet_dispatch_type": { - "display-name": "UpdateWalletRequest", "docs": "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", "type": "optional", }, "wallet_webhook_urls": { - "display-name": "UpdateWalletRequest", "docs": "List of Webhook URLs associated with this subwallet", "type": "optional>", }, @@ -35686,26 +34669,21 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "accept": { - "display-name": "InvitationCreateRequest", "docs": "List of mime type in order of preference that should be use in responding to the message", "type": "optional>", }, "alias": { - "display-name": "InvitationCreateRequest", "docs": "Alias for connection", "type": "optional", }, "attachments": { - "display-name": "InvitationCreateRequest", "docs": "Optional invitation attachments", "type": "optional>", }, "handshake_protocols": { - "display-name": "InvitationCreateRequest", "type": "optional>", }, "mediation_id": { - "display-name": "InvitationCreateRequest", "docs": "Identifier for active mediation record to be used", "type": "optional", "validation": { @@ -35716,22 +34694,18 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "metadata": { - "display-name": "InvitationCreateRequest", "docs": "Optional metadata to attach to the connection created with the invitation", "type": "optional", }, "my_label": { - "display-name": "InvitationCreateRequest", "docs": "Label for connection invitation", "type": "optional", }, "protocol_version": { - "display-name": "InvitationCreateRequest", "docs": "OOB protocol version", "type": "optional", }, "use_public_did": { - "display-name": "InvitationCreateRequest", "docs": "Whether to use public DID in invitation", "type": "optional", }, @@ -36189,12 +35163,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_verify": { - "display-name": "V10PresentationCreateRequestRequest", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "comment": { - "display-name": "V10PresentationCreateRequestRequest", "type": "optional", }, "proof_request": { @@ -36202,7 +35174,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "root.IndyProofRequest", }, "trace": { - "display-name": "V10PresentationCreateRequestRequest", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -37010,12 +35981,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_verify": { - "display-name": "V10PresentationSendRequestRequest", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "comment": { - "display-name": "V10PresentationSendRequestRequest", "type": "optional", }, "connection_id": { @@ -37033,7 +36002,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "root.IndyProofRequest", }, "trace": { - "display-name": "V10PresentationSendRequestRequest", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -37246,12 +36214,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_present": { - "display-name": "V10PresentationProposalRequest", "docs": "Whether to respond automatically to presentation requests, building and presenting requested proof", "type": "optional", }, "comment": { - "display-name": "V10PresentationProposalRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -37270,7 +36236,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "root.IndyPresPreview", }, "trace": { - "display-name": "V10PresentationProposalRequest", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -37650,12 +36615,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_verify": { - "display-name": "V10PresentationSendRequestToProposal", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "trace": { - "display-name": "V10PresentationSendRequestToProposal", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -38059,12 +37022,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_verify": { - "display-name": "V20PresCreateRequestRequest", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "comment": { - "display-name": "V20PresCreateRequestRequest", "type": "optional", }, "presentation_request": { @@ -38072,7 +37033,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "root.V20PresRequestByFormat", }, "trace": { - "display-name": "V20PresCreateRequestRequest", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -38818,12 +37778,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_verify": { - "display-name": "V20PresSendRequestRequest", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "comment": { - "display-name": "V20PresSendRequestRequest", "type": "optional", }, "connection_id": { @@ -38841,7 +37799,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "root.V20PresRequestByFormat", }, "trace": { - "display-name": "V20PresSendRequestRequest", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -39034,12 +37991,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_present": { - "display-name": "V20PresProposalRequest", "docs": "Whether to respond automatically to presentation requests, building and presenting requested proof", "type": "optional", }, "comment": { - "display-name": "V20PresProposalRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -39058,7 +38013,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "root.V20PresProposalByFormat", }, "trace": { - "display-name": "V20PresProposalRequest", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -39236,15 +38190,12 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "dif": { - "display-name": "V20PresSpecByFormatRequest", "type": "optional", }, "indy": { - "display-name": "V20PresSpecByFormatRequest", "type": "optional", }, "trace": { - "display-name": "V20PresSpecByFormatRequest", "docs": "Record trace information, based on agent configuration", "type": "optional", }, @@ -39405,12 +38356,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "auto_verify": { - "display-name": "V20PresentationSendRequestToProposal", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "trace": { - "display-name": "V20PresentationSendRequestToProposal", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -39708,7 +38657,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "purge": { - "display-name": "ClearPendingRevocationsRequest", "docs": "Credential revocation ids by revocation registry id: omit for all, specify null or empty list for all pending per revocation registry", "type": "optional>>", }, @@ -39784,7 +38732,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "credential_definition_id": { - "display-name": "RevRegCreateRequest", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -39795,7 +38742,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "max_cred_num": { - "display-name": "RevRegCreateRequest", "docs": "Revocation registry size", "type": "optional", "validation": { @@ -40508,12 +39454,10 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "comment": { - "display-name": "RevokeRequest", "docs": "Optional comment to include in revocation notification", "type": "optional", }, "connection_id": { - "display-name": "RevokeRequest", "docs": "Connection ID to which the revocation notification will be sent; required if notify is true", "type": "optional", "validation": { @@ -40524,7 +39468,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "cred_ex_id": { - "display-name": "RevokeRequest", "docs": "Credential exchange identifier", "type": "optional", "validation": { @@ -40535,7 +39478,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "cred_rev_id": { - "display-name": "RevokeRequest", "docs": "Credential revocation identifier", "type": "optional", "validation": { @@ -40546,22 +39488,18 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "notify": { - "display-name": "RevokeRequest", "docs": "Send a notification to the credential recipient", "type": "optional", }, "notify_version": { - "display-name": "RevokeRequest", "docs": "Specify which version of the revocation notification should be sent", "type": "optional", }, "publish": { - "display-name": "RevokeRequest", "docs": "(True) publish revocation to ledger immediately, or (default, False) mark it pending", "type": "optional", }, "rev_reg_id": { - "display-name": "RevokeRequest", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -40572,7 +39510,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "thread_id": { - "display-name": "RevokeRequest", "docs": "Thread ID of the credential exchange message thread resulting in the credential now being revoked; required if notify is true", "type": "optional", }, @@ -41318,7 +40255,6 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "comment": { - "display-name": "PingRequest", "docs": "Comment for the ping message", "type": "optional", }, @@ -41379,16 +40315,13 @@ exports[`open api parser > aries > simple 1`] = ` "body": { "properties": { "method": { - "display-name": "DIDCreate", "docs": "Method for the requested DID.Supported methods are 'key', 'sov', and any other registered method.", "type": "optional", }, "options": { - "display-name": "DIDCreate", "type": "optional", }, "seed": { - "display-name": "DIDCreate", "docs": "Optional seed to use for DID, Must beenabled in configuration before use.", "type": "optional", }, @@ -41593,7 +40526,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "endpoint": { - "display-name": "DIDEndpointWithType", "docs": "Endpoint to set (omit to delete)", "type": "optional", "validation": { @@ -41604,7 +40536,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "endpoint_type": { - "display-name": "DIDEndpointWithType", "docs": "Endpoint type to set (default 'Endpoint'); affects only public or posted DIDs", "type": "optional", }, @@ -41811,15 +40742,12 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "aml": { - "display-name": "AMLRecord", "type": "optional>", }, "amlContext": { - "display-name": "AMLRecord", "type": "optional", }, "version": { - "display-name": "AMLRecord", "type": "optional", }, }, @@ -41831,7 +40759,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "ActionMenuFetchResult", "type": "optional", }, }, @@ -41849,7 +40776,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "config": { - "display-name": "AdminConfig", "docs": "Configuration settings", "type": "optional", }, @@ -41869,7 +40795,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "AdminModules", "docs": "List of admin modules", "type": "optional>", }, @@ -41884,22 +40809,18 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "conductor": { - "display-name": "AdminStatus", "docs": "Conductor statistics", "type": "optional", }, "label": { - "display-name": "AdminStatus", "docs": "Default label", "type": "optional", }, "timing": { - "display-name": "AdminStatus", "docs": "Timing results", "type": "optional", }, "version": { - "display-name": "AdminStatus", "docs": "Version code", "type": "optional", }, @@ -41919,7 +40840,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "alive": { - "display-name": "AdminStatusLiveliness", "docs": "Liveliness status", "type": "optional", }, @@ -41932,7 +40852,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "ready": { - "display-name": "AdminStatusReadiness", "docs": "Readiness status", "type": "optional", }, @@ -41952,12 +40871,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "AttachDecorator", "docs": "Attachment identifier", "type": "optional", }, "byte_count": { - "display-name": "AttachDecorator", "docs": "Byte count of data included by reference", "type": "optional", }, @@ -41966,17 +40883,14 @@ exports[`open api parser > aries > simple 1`] = ` "type": "AttachDecoratorData", }, "description": { - "display-name": "AttachDecorator", "docs": "Human-readable description of content", "type": "optional", }, "filename": { - "display-name": "AttachDecorator", "docs": "File name", "type": "optional", }, "lastmod_time": { - "display-name": "AttachDecorator", "docs": "Hint regarding last modification datetime, in ISO-8601 format", "type": "optional", "validation": { @@ -41987,7 +40901,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "mime-type": { - "display-name": "AttachDecorator", "docs": "MIME type", "type": "optional", }, @@ -42000,7 +40913,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "base64": { - "display-name": "AttachDecoratorData", "docs": "Base64-encoded data", "type": "optional", "validation": { @@ -42011,21 +40923,17 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "json": { - "display-name": "AttachDecoratorData", "docs": "JSON-serialized data", "type": "optional>", }, "jws": { - "display-name": "AttachDecoratorData", "type": "optional", }, "links": { - "display-name": "AttachDecoratorData", "docs": "List of hypertext links to data", "type": "optional>", }, "sha256": { - "display-name": "AttachDecoratorData", "docs": "SHA256 hash (binhex encoded) of content", "type": "optional", "validation": { @@ -42048,7 +40956,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "AttachDecoratorDataJWSHeader", }, "protected": { - "display-name": "AttachDecoratorData1JWS", "docs": "protected JWS header", "type": "optional", "validation": { @@ -42077,11 +40984,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "header": { - "display-name": "AttachDecoratorDataJWS", "type": "optional", }, "protected": { - "display-name": "AttachDecoratorDataJWS", "docs": "protected JWS header", "type": "optional", "validation": { @@ -42092,7 +40997,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "signature": { - "display-name": "AttachDecoratorDataJWS", "docs": "signature", "type": "optional", "validation": { @@ -42103,7 +41007,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "signatures": { - "display-name": "AttachDecoratorDataJWS", "docs": "List of signatures", "type": "optional>", }, @@ -42139,12 +41042,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "id": { - "display-name": "AttachmentDef", "docs": "Attachment identifier", "type": "optional", }, "type": { - "display-name": "AttachmentDef", "docs": "Attachment type", "type": "optional", }, @@ -42173,7 +41074,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "AttributeMimeTypesResult", "type": "optional>>", }, }, @@ -42186,27 +41086,21 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "jwt": { - "display-name": "ClaimFormat", "type": "optional", }, "jwt_vc": { - "display-name": "ClaimFormat", "type": "optional", }, "jwt_vp": { - "display-name": "ClaimFormat", "type": "optional", }, "ldp": { - "display-name": "ClaimFormat", "type": "optional", }, "ldp_vc": { - "display-name": "ClaimFormat", "type": "optional", }, "ldp_vp": { - "display-name": "ClaimFormat", "type": "optional", }, }, @@ -42246,27 +41140,22 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "accept": { - "display-name": "ConnRecord", "docs": "Connection acceptance: manual or auto", "type": "optional", }, "alias": { - "display-name": "ConnRecord", "docs": "Optional alias to apply to connection for later use", "type": "optional", }, "connection_id": { - "display-name": "ConnRecord", "docs": "Connection identifier", "type": "optional", }, "connection_protocol": { - "display-name": "ConnRecord", "docs": "Connection protocol used", "type": "optional", }, "created_at": { - "display-name": "ConnRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -42277,17 +41166,14 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "error_msg": { - "display-name": "ConnRecord", "docs": "Error message", "type": "optional", }, "inbound_connection_id": { - "display-name": "ConnRecord", "docs": "Inbound routing connection id to use", "type": "optional", }, "invitation_key": { - "display-name": "ConnRecord", "docs": "Public key for connection", "type": "optional", "validation": { @@ -42298,17 +41184,14 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "invitation_mode": { - "display-name": "ConnRecord", "docs": "Invitation mode", "type": "optional", }, "invitation_msg_id": { - "display-name": "ConnRecord", "docs": "ID of out-of-band invitation message", "type": "optional", }, "my_did": { - "display-name": "ConnRecord", "docs": "Our DID for connection", "type": "optional", "validation": { @@ -42319,27 +41202,22 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "request_id": { - "display-name": "ConnRecord", "docs": "Connection request identifier", "type": "optional", }, "rfc23_state": { - "display-name": "ConnRecord", "docs": "State per RFC 23", "type": "optional", }, "routing_state": { - "display-name": "ConnRecord", "docs": "Routing state of connection", "type": "optional", }, "state": { - "display-name": "ConnRecord", "docs": "Current record state", "type": "optional", }, "their_did": { - "display-name": "ConnRecord", "docs": "Their DID for connection", "type": "optional", "validation": { @@ -42350,22 +41228,18 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "their_label": { - "display-name": "ConnRecord", "docs": "Their label for connection", "type": "optional", }, "their_public_did": { - "display-name": "ConnRecord", "docs": "Other agent's public DID for connection", "type": "optional", }, "their_role": { - "display-name": "ConnRecord", "docs": "Their role in the connection protocol", "type": "optional", }, "updated_at": { - "display-name": "ConnRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -42445,17 +41319,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "ConnectionInvitation", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "ConnectionInvitation", "docs": "Message type", "type": "optional", }, "did": { - "display-name": "ConnectionInvitation", "docs": "DID for connection invitation", "type": "optional", "validation": { @@ -42466,27 +41337,22 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "imageUrl": { - "display-name": "ConnectionInvitation", "docs": "Optional image URL for connection invitation", "type": "optional", }, "label": { - "display-name": "ConnectionInvitation", "docs": "Optional label for connection invitation", "type": "optional", }, "recipientKeys": { - "display-name": "ConnectionInvitation", "docs": "List of recipient keys", "type": "optional>", }, "routingKeys": { - "display-name": "ConnectionInvitation", "docs": "List of routing keys", "type": "optional>", }, "serviceEndpoint": { - "display-name": "ConnectionInvitation", "docs": "Service endpoint at which to reach this agent", "type": "optional", }, @@ -42499,7 +41365,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "ConnectionList", "docs": "List of connection records", "type": "optional>", }, @@ -42512,7 +41377,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "ConnectionMetadata", "docs": "Dictionary of metadata associated with connection.", "type": "optional", }, @@ -42595,32 +41459,25 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "fields": { - "display-name": "Constraints", "type": "optional>", }, "is_holder": { - "display-name": "Constraints", "type": "optional>", }, "limit_disclosure": { - "display-name": "Constraints", "docs": "LimitDisclosure", "type": "optional", }, "status_active": { - "display-name": "Constraints", "type": "optional", }, "status_revoked": { - "display-name": "Constraints", "type": "optional", }, "status_suspended": { - "display-name": "Constraints", "type": "optional", }, "subject_is_issuer": { - "display-name": "Constraints", "docs": "SubjectIsIssuer", "type": "optional", }, @@ -42673,7 +41530,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "CreateWalletResponse", "docs": "Time of record creation", "type": "optional", "validation": { @@ -42688,22 +41544,18 @@ exports[`open api parser > aries > simple 1`] = ` "type": "CreateWalletResponseKeyManagementMode", }, "settings": { - "display-name": "CreateWalletResponse", "docs": "Settings for this wallet.", "type": "optional", }, "state": { - "display-name": "CreateWalletResponse", "docs": "Current record state", "type": "optional", }, "token": { - "display-name": "CreateWalletResponse", "docs": "Authorization token to authenticate wallet requests", "type": "optional", }, "updated_at": { - "display-name": "CreateWalletResponse", "docs": "Time of last record update", "type": "optional", "validation": { @@ -42743,7 +41595,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "token": { - "display-name": "CreateWalletTokenResponse", "docs": "Authorization token to authenticate wallet requests", "type": "optional", }, @@ -42756,7 +41607,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "mime-type": { - "display-name": "CredAttrSpec", "docs": "MIME type: omit for (null) default", "type": "optional", }, @@ -42777,11 +41627,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "primary": { - "display-name": "CredDefValue", "type": "optional", }, "revocation": { - "display-name": "CredDefValue", "type": "optional", }, }, @@ -42793,7 +41641,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "n": { - "display-name": "CredDefValuePrimary", "type": "optional", "validation": { "format": undefined, @@ -42803,11 +41650,9 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "r": { - "display-name": "CredDefValuePrimary", "type": "optional", }, "rctxt": { - "display-name": "CredDefValuePrimary", "type": "optional", "validation": { "format": undefined, @@ -42817,7 +41662,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "s": { - "display-name": "CredDefValuePrimary", "type": "optional", "validation": { "format": undefined, @@ -42827,7 +41671,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "z": { - "display-name": "CredDefValuePrimary", "type": "optional", "validation": { "format": undefined, @@ -42845,47 +41688,36 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "g": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "g_dash": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "h": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "h0": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "h1": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "h2": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "h_cap": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "htilde": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "pk": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "u": { - "display-name": "CredDefValueRevocation", "type": "optional", }, "y": { - "display-name": "CredDefValueRevocation", "type": "optional", }, }, @@ -42897,7 +41729,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "CredInfoList", "type": "optional>", }, }, @@ -42909,7 +41740,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "rev_reg_delta": { - "display-name": "CredRevIndyRecordsResult", "docs": "Indy revocation registry delta", "type": "optional", }, @@ -42929,7 +41759,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "CredRevRecordDetailsResult", "type": "optional>", }, }, @@ -42941,7 +41770,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "CredRevRecordResult", "type": "optional", }, }, @@ -42953,7 +41781,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "revoked": { - "display-name": "CredRevokedResult", "docs": "Whether credential is revoked on the ledger", "type": "optional", }, @@ -42971,11 +41798,9 @@ exports[`open api parser > aries > simple 1`] = ` "type": "list>", }, "credentialSubject": { - "display-name": "credentialSubject", "type": "map", }, "expirationDate": { - "display-name": "Credential", "docs": "The expiration date", "type": "optional", "validation": { @@ -42986,7 +41811,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "id": { - "display-name": "Credential", "type": "optional", "validation": { "format": undefined, @@ -43006,12 +41830,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "issuer": { - "display-name": "issuer", "docs": "The JSON-LD Verifiable Credential Issuer. Either string of object with id field.", "type": "map", }, "proof": { - "display-name": "Credential", "type": "optional", }, "type": { @@ -43028,7 +41850,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "id": { - "display-name": "CredentialDefinition", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -43039,26 +41860,21 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schemaId": { - "display-name": "CredentialDefinition", "docs": "Schema identifier within credential definition identifier", "type": "optional", }, "tag": { - "display-name": "CredentialDefinition", "docs": "Tag within credential definition identifier", "type": "optional", }, "type": { - "display-name": "CredentialDefinition", "docs": "Signature type: CL for Camenisch-Lysyanskaya", "type": "optional>", }, "value": { - "display-name": "CredentialDefinition", "type": "optional", }, "ver": { - "display-name": "CredentialDefinition", "docs": "Node protocol version", "type": "optional", "validation": { @@ -43077,7 +41893,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "credential_definition": { - "display-name": "CredentialDefinitionGetResult", "type": "optional", }, }, @@ -43089,7 +41904,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "credential_definition_id": { - "display-name": "CredentialDefinitionSendResult", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -43113,7 +41927,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "credential_definition_ids": { - "display-name": "CredentialDefinitionsCreatedResult", "type": "optional>", }, }, @@ -43125,22 +41938,18 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "CredentialOffer", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "CredentialOffer", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "CredentialOffer", "docs": "Human-readable comment", "type": "optional", }, "credential_preview": { - "display-name": "CredentialOffer", "type": "optional", }, "offers~attach": { @@ -43156,7 +41965,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@type": { - "display-name": "CredentialPreview", "docs": "Message type identifier", "type": "optional", }, @@ -43175,22 +41983,18 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "CredentialProposal", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "CredentialProposal", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "CredentialProposal", "docs": "Human-readable comment", "type": "optional", }, "cred_def_id": { - "display-name": "CredentialProposal", "type": "optional", "validation": { "format": undefined, @@ -43200,11 +42004,9 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "credential_proposal": { - "display-name": "CredentialProposal", "type": "optional", }, "issuer_did": { - "display-name": "CredentialProposal", "type": "optional", "validation": { "format": undefined, @@ -43214,7 +42016,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_id": { - "display-name": "CredentialProposal", "type": "optional", "validation": { "format": undefined, @@ -43224,7 +42025,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_issuer_did": { - "display-name": "CredentialProposal", "type": "optional", "validation": { "format": undefined, @@ -43234,11 +42034,9 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_name": { - "display-name": "CredentialProposal", "type": "optional", }, "schema_version": { - "display-name": "CredentialProposal", "type": "optional", "validation": { "format": undefined, @@ -43268,7 +42066,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "did": { - "display-name": "DID", "docs": "DID of interest", "type": "optional", "validation": { @@ -43279,22 +42076,18 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "key_type": { - "display-name": "DID", "docs": "Key type associated with the DID", "type": "optional", }, "method": { - "display-name": "DID", "docs": "Did method associated with the DID", "type": "optional", }, "posture": { - "display-name": "DID", "docs": "Whether DID is current public DID, posted to ledger but not current public DID, or local to the wallet", "type": "optional", }, "verkey": { - "display-name": "DID", "docs": "Public verification key", "type": "optional", "validation": { @@ -43313,7 +42106,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "did": { - "display-name": "DIDCreateOptions", "docs": "Specify final value of the did (including did:: prefix)if the method supports or requires so.", "type": "optional", "validation": { @@ -43324,7 +42116,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "key_type": { - "display-name": "key_type", "docs": "Key type to use for the DID keypair. Validated with the chosen DID method's supported key types.", "type": "DidCreateOptionsKeyType", }, @@ -43347,7 +42138,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "endpoint": { - "display-name": "DIDEndpoint", "docs": "Endpoint to set (omit to delete)", "type": "optional", "validation": { @@ -43366,7 +42156,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "DIDList", "docs": "DID list", "type": "optional>", }, @@ -43379,7 +42168,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "DIDResult", "type": "optional", }, }, @@ -43391,25 +42179,20 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "filter": { - "display-name": "DIFField", "type": "optional", }, "id": { - "display-name": "DIFField", "docs": "ID", "type": "optional", }, "path": { - "display-name": "DIFField", "type": "optional>", }, "predicate": { - "display-name": "DIFField", "docs": "Preference", "type": "optional", }, "purpose": { - "display-name": "DIFField", "docs": "Purpose", "type": "optional", }, @@ -43422,12 +42205,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "directive": { - "display-name": "DIFHolder", "docs": "Preference", "type": "optional", }, "field_id": { - "display-name": "DIFHolder", "type": "optional>", }, }, @@ -43439,7 +42220,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "challenge": { - "display-name": "DIFOptions", "docs": "Challenge protect against replay attack", "type": "optional", "validation": { @@ -43450,7 +42230,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "domain": { - "display-name": "DIFOptions", "docs": "Domain protect against replay attack", "type": "optional", }, @@ -43463,21 +42242,17 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "issuer_id": { - "display-name": "DIFPresSpec", "docs": "Issuer identifier to sign the presentation, if different from current public DID", "type": "optional", }, "presentation_definition": { - "display-name": "DIFPresSpec", "type": "optional", }, "record_ids": { - "display-name": "DIFPresSpec", "docs": "Mapping of input_descriptor id to list of stored W3C credential record_id", "type": "optional", }, "reveal_doc": { - "display-name": "DIFPresSpec", "docs": "reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required", "type": "optional", }, @@ -43490,11 +42265,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "input_descriptors": { - "display-name": "DIFProofProposal", "type": "optional>", }, "options": { - "display-name": "DIFProofProposal", "type": "optional", }, }, @@ -43506,7 +42279,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "options": { - "display-name": "DIFProofRequest", "type": "optional", }, "presentation_definition": { @@ -43577,12 +42349,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "Disclose", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "Disclose", "docs": "Message type", "type": "optional", }, @@ -43600,12 +42370,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "Disclosures", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "Disclosures", "docs": "Message type", "type": "optional", }, @@ -43652,7 +42420,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "string", }, "endorser_name": { - "display-name": "EndorserInfo", "docs": "Endorser Name", "type": "optional", }, @@ -43665,7 +42432,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "my_endpoint": { - "display-name": "EndpointsResult", "docs": "My endpoint", "type": "optional", "validation": { @@ -43676,7 +42442,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "their_endpoint": { - "display-name": "EndpointsResult", "docs": "Their endpoint", "type": "optional", "validation": { @@ -43695,61 +42460,49 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "const": { - "display-name": "Filter", "docs": "Const", "type": "optional>", }, "enum": { - "display-name": "Filter", "type": "optional>>", }, "exclusiveMaximum": { - "display-name": "Filter", "docs": "ExclusiveMaximum", "type": "optional>", }, "exclusiveMinimum": { - "display-name": "Filter", "docs": "ExclusiveMinimum", "type": "optional>", }, "format": { - "display-name": "Filter", "docs": "Format", "type": "optional", }, "maxLength": { - "display-name": "Filter", "docs": "Max Length", "type": "optional", }, "maximum": { - "display-name": "Filter", "docs": "Maximum", "type": "optional>", }, "minLength": { - "display-name": "Filter", "docs": "Min Length", "type": "optional", }, "minimum": { - "display-name": "Filter", "docs": "Minimum", "type": "optional>", }, "not": { - "display-name": "Filter", "docs": "Not", "type": "optional", }, "pattern": { - "display-name": "Filter", "docs": "Pattern", "type": "optional", }, "type": { - "display-name": "Filter", "docs": "Type", "type": "optional", }, @@ -43762,7 +42515,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "master_secret": { - "display-name": "Generated", "type": "optional", "validation": { "format": undefined, @@ -43772,7 +42524,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "number": { - "display-name": "Generated", "type": "optional", "validation": { "format": undefined, @@ -43782,7 +42533,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "remainder": { - "display-name": "Generated", "type": "optional", "validation": { "format": undefined, @@ -43800,7 +42550,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "endpoint": { - "display-name": "GetDIDEndpointResponse", "docs": "Full verification key", "type": "optional", "validation": { @@ -43819,7 +42568,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "verkey": { - "display-name": "GetDIDVerkeyResponse", "docs": "Full verification key", "type": "optional", "validation": { @@ -43838,7 +42586,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "role": { - "display-name": "GetNymRoleResponse", "docs": "Ledger role", "type": "optional", }, @@ -43932,12 +42679,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "attrs": { - "display-name": "IndyCredInfo", "docs": "Attribute names and value", "type": "optional>", }, "cred_def_id": { - "display-name": "IndyCredInfo", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -43948,7 +42693,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "cred_rev_id": { - "display-name": "IndyCredInfo", "docs": "Credential revocation identifier", "type": "optional", "validation": { @@ -43959,12 +42703,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "referent": { - "display-name": "IndyCredInfo", "docs": "Wallet referent", "type": "optional", }, "rev_reg_id": { - "display-name": "IndyCredInfo", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -43975,7 +42717,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_id": { - "display-name": "IndyCredInfo", "docs": "Schema identifier", "type": "optional", "validation": { @@ -43994,15 +42735,12 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "cred_info": { - "display-name": "IndyCredPrecis", "type": "optional", }, "interval": { - "display-name": "IndyCredPrecis", "type": "optional", }, "presentation_referents": { - "display-name": "IndyCredPrecis", "type": "optional>", }, }, @@ -44096,12 +42834,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "rev_reg": { - "display-name": "IndyCredential", "docs": "Revocation registry state", "type": "optional", }, "rev_reg_id": { - "display-name": "IndyCredential", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -44132,12 +42868,10 @@ exports[`open api parser > aries > simple 1`] = ` "type": "IndyCredentialSignatureCorrectnessProof", }, "values": { - "display-name": "values", "docs": "Credential attributes", "type": "map", }, "witness": { - "display-name": "IndyCredential", "docs": "Witness for revocation proof", "type": "optional", }, @@ -44169,7 +42903,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "a_prime": { - "display-name": "IndyEQProof", "type": "optional", "validation": { "format": undefined, @@ -44179,7 +42912,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "e": { - "display-name": "IndyEQProof", "type": "optional", "validation": { "format": undefined, @@ -44189,11 +42921,9 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "m": { - "display-name": "IndyEQProof", "type": "optional>", }, "m2": { - "display-name": "IndyEQProof", "type": "optional", "validation": { "format": undefined, @@ -44203,11 +42933,9 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "revealed_attrs": { - "display-name": "IndyEQProof", "type": "optional>", }, "v": { - "display-name": "IndyEQProof", "type": "optional", "validation": { "format": undefined, @@ -44225,7 +42953,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "alpha": { - "display-name": "IndyGEProof", "type": "optional", "validation": { "format": undefined, @@ -44235,7 +42962,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "mj": { - "display-name": "IndyGEProof", "type": "optional", "validation": { "format": undefined, @@ -44245,19 +42971,15 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "predicate": { - "display-name": "IndyGEProof", "type": "optional", }, "r": { - "display-name": "IndyGEProof", "type": "optional>", }, "t": { - "display-name": "IndyGEProof", "type": "optional>", }, "u": { - "display-name": "IndyGEProof", "type": "optional>", }, }, @@ -44269,17 +42991,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "attr_name": { - "display-name": "IndyGEProofPred", "docs": "Attribute name, indy-canonicalized", "type": "optional", }, "p_type": { - "display-name": "IndyGEProofPred", "docs": "Predicate type", "type": "optional", }, "value": { - "display-name": "IndyGEProofPred", "docs": "Predicate threshold value", "type": "optional", }, @@ -44337,11 +43056,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "c_list": { - "display-name": "IndyNonRevocProof", "type": "optional>", }, "x_list": { - "display-name": "IndyNonRevocProof", "type": "optional>", }, }, @@ -44353,7 +43070,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "from": { - "display-name": "IndyNonRevocationInterval", "docs": "Earliest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -44365,7 +43081,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "to": { - "display-name": "IndyNonRevocationInterval", "docs": "Latest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -44385,7 +43100,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "cred_def_id": { - "display-name": "IndyPresAttrSpec", "type": "optional", "validation": { "format": undefined, @@ -44395,7 +43109,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "mime-type": { - "display-name": "IndyPresAttrSpec", "docs": "MIME type (default null)", "type": "optional", }, @@ -44404,12 +43117,10 @@ exports[`open api parser > aries > simple 1`] = ` "type": "string", }, "referent": { - "display-name": "IndyPresAttrSpec", "docs": "Credential referent", "type": "optional", }, "value": { - "display-name": "IndyPresAttrSpec", "docs": "Attribute value", "type": "optional", }, @@ -44422,7 +43133,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "cred_def_id": { - "display-name": "IndyPresPredSpec", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -44477,7 +43187,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@type": { - "display-name": "IndyPresPreview", "docs": "Message type identifier", "type": "optional", }, @@ -44504,7 +43213,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "map", }, "trace": { - "display-name": "IndyPresSpec", "docs": "Whether to trace event (default false)", "type": "optional", }, @@ -44517,11 +43225,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "eq_proof": { - "display-name": "IndyPrimaryProof", "type": "optional", }, "ge_proofs": { - "display-name": "IndyPrimaryProof", "docs": "Indy GE proofs", "type": "optional>", }, @@ -44538,16 +43244,13 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "identifiers": { - "display-name": "IndyProof", "docs": "Indy proof.identifiers content", "type": "optional>", }, "proof": { - "display-name": "IndyProof", "type": "optional", }, "requested_proof": { - "display-name": "IndyProof", "type": "optional", }, }, @@ -44559,7 +43262,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "cred_def_id": { - "display-name": "IndyProofIdentifier", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -44570,7 +43272,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "rev_reg_id": { - "display-name": "IndyProofIdentifier", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -44581,7 +43282,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_id": { - "display-name": "IndyProofIdentifier", "docs": "Schema identifier", "type": "optional", "validation": { @@ -44592,7 +43292,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "timestamp": { - "display-name": "IndyProofIdentifier", "docs": "Timestamp epoch", "type": "optional", "validation": { @@ -44612,11 +43311,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "aggregated_proof": { - "display-name": "IndyProofProof", "type": "optional", }, "proofs": { - "display-name": "IndyProofProof", "docs": "Indy proof proofs", "type": "optional>", }, @@ -44629,12 +43326,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "c_hash": { - "display-name": "IndyProofProofAggregatedProof", "docs": "c_hash value", "type": "optional", }, "c_list": { - "display-name": "IndyProofProofAggregatedProof", "docs": "c_list value", "type": "optional>>", }, @@ -44647,11 +43342,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "non_revoc_proof": { - "display-name": "IndyProofProofProofsProof", "type": "optional", }, "primary_proof": { - "display-name": "IndyProofProofProofsProof", "type": "optional", }, }, @@ -44672,21 +43365,17 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "name": { - "display-name": "IndyProofReqAttrSpec", "docs": "Attribute name", "type": "optional", }, "names": { - "display-name": "IndyProofReqAttrSpec", "docs": "Attribute name group", "type": "optional>", }, "non_revoked": { - "display-name": "IndyProofReqAttrSpec", "type": "optional", }, "restrictions": { - "display-name": "IndyProofReqAttrSpec", "docs": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", "type": "optional>>", }, @@ -44699,7 +43388,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "from": { - "display-name": "IndyProofReqAttrSpecNonRevoked", "docs": "Earliest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -44711,7 +43399,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "to": { - "display-name": "IndyProofReqAttrSpecNonRevoked", "docs": "Latest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -44735,7 +43422,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "string", }, "non_revoked": { - "display-name": "IndyProofReqPredSpec", "type": "optional", }, "p_type": { @@ -44747,7 +43433,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "integer", }, "restrictions": { - "display-name": "IndyProofReqPredSpec", "docs": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", "type": "optional>>", }, @@ -44760,7 +43445,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "from": { - "display-name": "IndyProofReqPredSpecNonRevoked", "docs": "Earliest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -44772,7 +43456,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "to": { - "display-name": "IndyProofReqPredSpecNonRevoked", "docs": "Latest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -44816,16 +43499,13 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "name": { - "display-name": "IndyProofRequest", "docs": "Proof request name", "type": "optional", }, "non_revoked": { - "display-name": "IndyProofRequest", "type": "optional", }, "nonce": { - "display-name": "IndyProofRequest", "docs": "Nonce", "type": "optional", "validation": { @@ -44844,7 +43524,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "map", }, "version": { - "display-name": "IndyProofRequest", "docs": "Proof request version", "type": "optional", "validation": { @@ -44863,7 +43542,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "from": { - "display-name": "IndyProofRequestNonRevoked", "docs": "Earliest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -44875,7 +43553,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "to": { - "display-name": "IndyProofRequestNonRevoked", "docs": "Latest time of interest in non-revocation interval", "type": "optional", "validation": { @@ -44895,27 +43572,22 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "predicates": { - "display-name": "IndyProofRequestedProof", "docs": "Proof requested proof predicates.", "type": "optional>", }, "revealed_attr_groups": { - "display-name": "IndyProofRequestedProof", "docs": "Proof requested proof revealed attribute groups", "type": "optional>>", }, "revealed_attrs": { - "display-name": "IndyProofRequestedProof", "docs": "Proof requested proof revealed attributes", "type": "optional>>", }, "self_attested_attrs": { - "display-name": "IndyProofRequestedProof", "docs": "Proof requested proof self-attested attributes", "type": "optional", }, "unrevealed_attrs": { - "display-name": "IndyProofRequestedProof", "docs": "Unrevealed attributes", "type": "optional", }, @@ -44928,7 +43600,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "sub_proof_index": { - "display-name": "IndyProofRequestedProofPredicate", "docs": "Sub-proof index", "type": "optional", }, @@ -44941,7 +43612,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "encoded": { - "display-name": "IndyProofRequestedProofRevealedAttr", "docs": "Encoded value", "type": "optional", "validation": { @@ -44952,12 +43622,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "raw": { - "display-name": "IndyProofRequestedProofRevealedAttr", "docs": "Raw value", "type": "optional", }, "sub_proof_index": { - "display-name": "IndyProofRequestedProofRevealedAttr", "docs": "Sub-proof index", "type": "optional", }, @@ -44970,12 +43638,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "sub_proof_index": { - "display-name": "IndyProofRequestedProofRevealedAttrGroup", "docs": "Sub-proof index", "type": "optional", }, "values": { - "display-name": "IndyProofRequestedProofRevealedAttrGroup", "docs": "Indy proof requested proof revealed attr groups group value", "type": "optional>", }, @@ -45006,7 +43672,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "string", }, "revealed": { - "display-name": "IndyRequestedCredsRequestedAttr", "docs": "Whether to reveal attribute in proof (default true)", "type": "optional", }, @@ -45023,7 +43688,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "string", }, "timestamp": { - "display-name": "IndyRequestedCredsRequestedPred", "docs": "Epoch timestamp of interest for non-revocation proof", "type": "optional", "validation": { @@ -45043,7 +43707,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "credDefId": { - "display-name": "IndyRevRegDef", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -45054,7 +43717,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "id": { - "display-name": "IndyRevRegDef", "docs": "Indy revocation registry identifier", "type": "optional", "validation": { @@ -45065,21 +43727,17 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "revocDefType": { - "display-name": "IndyRevRegDef", "docs": "Revocation registry type (specify CL_ACCUM)", "type": "optional>", }, "tag": { - "display-name": "IndyRevRegDef", "docs": "Revocation registry tag", "type": "optional", }, "value": { - "display-name": "IndyRevRegDef", "type": "optional", }, "ver": { - "display-name": "IndyRevRegDef", "docs": "Version of revocation registry definition", "type": "optional", "validation": { @@ -45098,12 +43756,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "issuanceType": { - "display-name": "IndyRevRegDefValue", "docs": "Issuance type", "type": "optional", }, "maxCredNum": { - "display-name": "IndyRevRegDefValue", "docs": "Maximum number of credentials; registry size", "type": "optional", "validation": { @@ -45115,11 +43771,9 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "publicKeys": { - "display-name": "IndyRevRegDefValue", "type": "optional", }, "tailsHash": { - "display-name": "IndyRevRegDefValue", "docs": "Tails hash value", "type": "optional", "validation": { @@ -45130,7 +43784,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "tailsLocation": { - "display-name": "IndyRevRegDefValue", "docs": "Tails file location", "type": "optional", }, @@ -45143,7 +43796,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "accumKey": { - "display-name": "IndyRevRegDefValuePublicKeys", "type": "optional", }, }, @@ -45155,7 +43807,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "z": { - "display-name": "IndyRevRegDefValuePublicKeysAccumKey", "docs": "Value for z", "type": "optional", }, @@ -45168,11 +43819,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "value": { - "display-name": "IndyRevRegEntry", "type": "optional", }, "ver": { - "display-name": "IndyRevRegEntry", "docs": "Version of revocation registry entry", "type": "optional", "validation": { @@ -45191,17 +43840,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "accum": { - "display-name": "IndyRevRegEntryValue", "docs": "Accumulator value", "type": "optional", }, "prevAccum": { - "display-name": "IndyRevRegEntryValue", "docs": "Previous accumulator value", "type": "optional", }, "revoked": { - "display-name": "IndyRevRegEntryValue", "docs": "Revoked credential revocation identifiers", "type": "optional>", }, @@ -45214,35 +43860,28 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "constraints": { - "display-name": "InputDescriptors", "type": "optional", }, "group": { - "display-name": "InputDescriptors", "type": "optional>", }, "id": { - "display-name": "InputDescriptors", "docs": "ID", "type": "optional", }, "metadata": { - "display-name": "InputDescriptors", "docs": "Metadata dictionary", "type": "optional", }, "name": { - "display-name": "InputDescriptors", "docs": "Name", "type": "optional", }, "purpose": { - "display-name": "InputDescriptors", "docs": "Purpose", "type": "optional", }, "schema": { - "display-name": "InputDescriptors", "type": "optional", }, }, @@ -45260,41 +43899,33 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "InvitationMessage", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "InvitationMessage", "docs": "Message type", "type": "optional", }, "accept": { - "display-name": "InvitationMessage", "docs": "List of mime type in order of preference", "type": "optional>", }, "handshake_protocols": { - "display-name": "InvitationMessage", "type": "optional>", }, "imageUrl": { - "display-name": "InvitationMessage", "docs": "Optional image URL for out-of-band invitation", "type": "optional", }, "label": { - "display-name": "InvitationMessage", "docs": "Optional label", "type": "optional", }, "requests~attach": { - "display-name": "InvitationMessage", "docs": "Optional request attachment", "type": "optional>", }, "services": { - "display-name": "InvitationMessage", "type": "optional>>", }, }, @@ -45306,7 +43937,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "InvitationRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -45317,41 +43947,33 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "invi_msg_id": { - "display-name": "InvitationRecord", "docs": "Invitation message identifier", "type": "optional", }, "invitation": { - "display-name": "InvitationRecord", "type": "optional", }, "invitation_id": { - "display-name": "InvitationRecord", "docs": "Invitation record identifier", "type": "optional", }, "invitation_url": { - "display-name": "InvitationRecord", "docs": "Invitation message URL", "type": "optional", }, "oob_id": { - "display-name": "InvitationRecord", "docs": "Out of band record identifier", "type": "optional", }, "state": { - "display-name": "InvitationRecord", "docs": "Out of band message exchange state", "type": "optional", }, "trace": { - "display-name": "InvitationRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "InvitationRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -45375,16 +43997,13 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "connection_id": { - "display-name": "InvitationResult", "docs": "Connection identifier", "type": "optional", }, "invitation": { - "display-name": "InvitationResult", "type": "optional", }, "invitation_url": { - "display-name": "InvitationResult", "docs": "Invitation URL", "type": "optional", }, @@ -45398,7 +44017,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "IssuerCredRevRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -45409,7 +44027,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "cred_def_id": { - "display-name": "IssuerCredRevRecord", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -45420,17 +44037,14 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "cred_ex_id": { - "display-name": "IssuerCredRevRecord", "docs": "Credential exchange record identifier at credential issue", "type": "optional", }, "cred_ex_version": { - "display-name": "IssuerCredRevRecord", "docs": "Credential exchange version", "type": "optional", }, "cred_rev_id": { - "display-name": "IssuerCredRevRecord", "docs": "Credential revocation identifier", "type": "optional", "validation": { @@ -45441,12 +44055,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "record_id": { - "display-name": "IssuerCredRevRecord", "docs": "Issuer credential revocation record identifier", "type": "optional", }, "rev_reg_id": { - "display-name": "IssuerCredRevRecord", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -45457,12 +44069,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "state": { - "display-name": "IssuerCredRevRecord", "docs": "Issue credential revocation record state", "type": "optional", }, "updated_at": { - "display-name": "IssuerCredRevRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -45481,7 +44091,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "IssuerRevRegRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -45492,7 +44101,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "cred_def_id": { - "display-name": "IssuerRevRegRecord", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -45503,12 +44111,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "error_msg": { - "display-name": "IssuerRevRegRecord", "docs": "Error message", "type": "optional", }, "issuer_did": { - "display-name": "IssuerRevRegRecord", "docs": "Issuer DID", "type": "optional", "validation": { @@ -45519,35 +44125,28 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "max_cred_num": { - "display-name": "IssuerRevRegRecord", "docs": "Maximum number of credentials for revocation registry", "type": "optional", }, "pending_pub": { - "display-name": "IssuerRevRegRecord", "docs": "Credential revocation identifier for credential revoked and pending publication to ledger", "type": "optional>", }, "record_id": { - "display-name": "IssuerRevRegRecord", "docs": "Issuer revocation registry record identifier", "type": "optional", }, "revoc_def_type": { - "display-name": "IssuerRevRegRecord", "docs": "Revocation registry type (specify CL_ACCUM)", "type": "optional>", }, "revoc_reg_def": { - "display-name": "IssuerRevRegRecord", "type": "optional", }, "revoc_reg_entry": { - "display-name": "IssuerRevRegRecord", "type": "optional", }, "revoc_reg_id": { - "display-name": "IssuerRevRegRecord", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -45558,17 +44157,14 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "state": { - "display-name": "IssuerRevRegRecord", "docs": "Issue revocation registry record state", "type": "optional", }, "tag": { - "display-name": "IssuerRevRegRecord", "docs": "Tag within issuer revocation registry identifier", "type": "optional", }, "tails_hash": { - "display-name": "IssuerRevRegRecord", "docs": "Tails hash", "type": "optional", "validation": { @@ -45579,17 +44175,14 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "tails_local_path": { - "display-name": "IssuerRevRegRecord", "docs": "Local path to tails file", "type": "optional", }, "tails_public_uri": { - "display-name": "IssuerRevRegRecord", "docs": "Public URI for tails file", "type": "optional", }, "updated_at": { - "display-name": "IssuerRevRegRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -45618,7 +44211,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "Keylist", "docs": "List of keylist records", "type": "optional>", }, @@ -45631,22 +44223,18 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "KeylistQuery", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "KeylistQuery", "docs": "Message type", "type": "optional", }, "filter": { - "display-name": "KeylistQuery", "docs": "Query dictionary object", "type": "optional", }, "paginate": { - "display-name": "KeylistQuery", "type": "optional", }, }, @@ -45665,12 +44253,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "limit": { - "display-name": "KeylistQueryPaginate", "docs": "Limit for keylist query", "type": "optional", }, "offset": { - "display-name": "KeylistQueryPaginate", "docs": "Offset value for query", "type": "optional", }, @@ -45683,17 +44269,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "KeylistUpdate", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "KeylistUpdate", "docs": "Message type", "type": "optional", }, "updates": { - "display-name": "KeylistUpdate", "docs": "List of update rules", "type": "optional>", }, @@ -45748,12 +44331,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "challenge": { - "display-name": "LDProofVCDetailOptions", "docs": "A challenge to include in the proof. SHOULD be provided by the requesting party of the credential (=holder)", "type": "optional", }, "created": { - "display-name": "LDProofVCDetailOptions", "docs": "The date and time of the proof (with a maximum accuracy in seconds). Defaults to current system time", "type": "optional", "validation": { @@ -45764,16 +44345,13 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "credentialStatus": { - "display-name": "LDProofVCDetailOptions", "type": "optional", }, "domain": { - "display-name": "LDProofVCDetailOptions", "docs": "The intended domain of validity for the proof", "type": "optional", }, "proofPurpose": { - "display-name": "LDProofVCDetailOptions", "docs": "The proof purpose used for the proof. Should match proof purposes registered in the Linked Data Proofs Specification", "type": "optional", }, @@ -45805,27 +44383,22 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "genesis_file": { - "display-name": "LedgerConfigInstance", "docs": "genesis_file", "type": "optional", }, "genesis_transactions": { - "display-name": "LedgerConfigInstance", "docs": "genesis_transactions", "type": "optional", }, "genesis_url": { - "display-name": "LedgerConfigInstance", "docs": "genesis_url", "type": "optional", }, "id": { - "display-name": "LedgerConfigInstance", "docs": "ledger_id", "type": "optional", }, "is_production": { - "display-name": "LedgerConfigInstance", "docs": "is_production", "type": "optional", }, @@ -45848,7 +44421,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "challenge": { - "display-name": "LinkedDataProof", "docs": "Associates a challenge with a proof, for use with a proofPurpose such as authentication", "type": "optional", }, @@ -45863,7 +44435,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "domain": { - "display-name": "LinkedDataProof", "docs": "A string value specifying the restricted domain of the signature.", "type": "optional", "validation": { @@ -45874,12 +44445,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "jws": { - "display-name": "LinkedDataProof", "docs": "Associates a Detached Json Web Signature with a proof", "type": "optional", }, "nonce": { - "display-name": "LinkedDataProof", "docs": "The nonce", "type": "optional", }, @@ -45888,7 +44457,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "string", }, "proofValue": { - "display-name": "LinkedDataProof", "docs": "The proof value of a proof", "type": "optional", }, @@ -45915,21 +44483,17 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "MediationDeny", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "MediationDeny", "docs": "Message type", "type": "optional", }, "mediator_terms": { - "display-name": "MediationDeny", "type": "optional>", }, "recipient_terms": { - "display-name": "MediationDeny", "type": "optional>", }, }, @@ -45941,22 +44505,18 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "MediationGrant", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "MediationGrant", "docs": "Message type", "type": "optional", }, "endpoint": { - "display-name": "MediationGrant", "docs": "endpoint on which messages destined for the recipient are received.", "type": "optional", }, "routing_keys": { - "display-name": "MediationGrant", "type": "optional>", }, }, @@ -45968,7 +44528,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "MediationList", "docs": "List of mediation records", "type": "optional>", }, @@ -45982,7 +44541,6 @@ exports[`open api parser > aries > simple 1`] = ` "properties": { "connection_id": "string", "created_at": { - "display-name": "MediationRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -45993,33 +44551,26 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "endpoint": { - "display-name": "MediationRecord", "type": "optional", }, "mediation_id": { - "display-name": "MediationRecord", "type": "optional", }, "mediator_terms": { - "display-name": "MediationRecord", "type": "optional>", }, "recipient_terms": { - "display-name": "MediationRecord", "type": "optional>", }, "role": "string", "routing_keys": { - "display-name": "MediationRecord", "type": "optional>", }, "state": { - "display-name": "MediationRecord", "docs": "Current record state", "type": "optional", }, "updated_at": { - "display-name": "MediationRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -46038,22 +44589,18 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "Menu", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "Menu", "docs": "Message type", "type": "optional", }, "description": { - "display-name": "Menu", "docs": "Introductory text for the menu", "type": "optional", }, "errormsg": { - "display-name": "Menu", "docs": "An optional error message to display in menu header", "type": "optional", }, @@ -46063,7 +44610,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "list", }, "title": { - "display-name": "Menu", "docs": "Menu title", "type": "optional", }, @@ -46076,22 +44622,18 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "description": { - "display-name": "MenuForm", "docs": "Additional descriptive text for menu form", "type": "optional", }, "params": { - "display-name": "MenuForm", "docs": "List of form parameters", "type": "optional>", }, "submit-label": { - "display-name": "MenuForm", "docs": "Alternative label for form submit button", "type": "optional", }, "title": { - "display-name": "MenuForm", "docs": "Menu form title", "type": "optional", }, @@ -46104,12 +44646,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "default": { - "display-name": "MenuFormParam", "docs": "Default parameter value", "type": "optional", }, "description": { - "display-name": "MenuFormParam", "docs": "Additional descriptive text for menu form parameter", "type": "optional", }, @@ -46118,7 +44658,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "string", }, "required": { - "display-name": "MenuFormParam", "docs": "Whether parameter is required", "type": "optional", }, @@ -46127,7 +44666,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "string", }, "type": { - "display-name": "MenuFormParam", "docs": "Menu form parameter input type", "type": "optional", }, @@ -46140,12 +44678,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "description": { - "display-name": "MenuJson", "docs": "Introductory text for the menu", "type": "optional", }, "errormsg": { - "display-name": "MenuJson", "docs": "Optional error message to display in menu header", "type": "optional", }, @@ -46155,7 +44691,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "list", }, "title": { - "display-name": "MenuJson", "docs": "Menu title", "type": "optional", }, @@ -46168,17 +44703,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "description": { - "display-name": "MenuOption", "docs": "Additional descriptive text for menu option", "type": "optional", }, "disabled": { - "display-name": "MenuOption", "docs": "Whether to show option as disabled", "type": "optional", }, "form": { - "display-name": "MenuOption", "type": "optional", }, "name": { @@ -46199,17 +44731,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "attach_thread_id": { - "display-name": "OobRecord", "docs": "Connection record identifier", "type": "optional", }, "connection_id": { - "display-name": "OobRecord", "docs": "Connection record identifier", "type": "optional", }, "created_at": { - "display-name": "OobRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -46229,12 +44758,10 @@ exports[`open api parser > aries > simple 1`] = ` "type": "string", }, "our_recipient_key": { - "display-name": "OobRecord", "docs": "Recipient key used for oob invitation", "type": "optional", }, "role": { - "display-name": "OobRecord", "docs": "OOB Role", "type": "optional", }, @@ -46243,16 +44770,13 @@ exports[`open api parser > aries > simple 1`] = ` "type": "OobRecordState", }, "their_service": { - "display-name": "OobRecord", "type": "optional", }, "trace": { - "display-name": "OobRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "OobRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -46308,7 +44832,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "thread_id": { - "display-name": "PingRequestResponse", "docs": "Thread ID of the ping message", "type": "optional", }, @@ -46321,11 +44844,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "format": { - "display-name": "PresentationDefinition", "type": "optional", }, "id": { - "display-name": "PresentationDefinition", "docs": "Unique Resource Identifier", "type": "optional", "validation": { @@ -46336,21 +44857,17 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "input_descriptors": { - "display-name": "PresentationDefinition", "type": "optional>", }, "name": { - "display-name": "PresentationDefinition", "docs": "Human-friendly name that describes what the presentation definition pertains to", "type": "optional", }, "purpose": { - "display-name": "PresentationDefinition", "docs": "Describes the purpose for which the Presentation Definition's inputs are being requested", "type": "optional", }, "submission_requirements": { - "display-name": "PresentationDefinition", "type": "optional>", }, }, @@ -46362,17 +44879,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "PresentationProposal", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "PresentationProposal", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "PresentationProposal", "docs": "Human-readable comment", "type": "optional", }, @@ -46389,17 +44903,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "PresentationRequest", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "PresentationRequest", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "PresentationRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -46417,7 +44928,6 @@ exports[`open api parser > aries > simple 1`] = ` "properties": { "pid": "string", "roles": { - "display-name": "ProtocolDescriptor", "docs": "List of roles", "type": "optional>", }, @@ -46430,7 +44940,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "rrid2crid": { - "display-name": "PublishRevocations", "docs": "Credential revocation ids by revocation registry id", "type": "optional>>", }, @@ -46443,17 +44952,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "Queries", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "Queries", "docs": "Message type", "type": "optional", }, "queries": { - "display-name": "Queries", "type": "optional>", }, }, @@ -46465,17 +44971,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "Query", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "Query", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "Query", "type": "optional", }, "query": "string", @@ -46488,7 +44991,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "feature-type": { - "display-name": "feature-type", "docs": "feature type", "type": "QueryItemFeatureType", }, @@ -46518,7 +45020,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "encoded": { - "display-name": "RawEncoded", "docs": "Encoded value", "type": "optional", "validation": { @@ -46529,7 +45030,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "raw": { - "display-name": "RawEncoded", "docs": "Raw value", "type": "optional", }, @@ -46572,7 +45072,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "RevRegIssuedResult", "docs": "Number of credentials issued against revocation registry", "type": "optional", "validation": { @@ -46592,7 +45091,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "RevRegResult", "type": "optional", }, }, @@ -46604,17 +45102,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "accum_calculated": { - "display-name": "RevRegWalletUpdatedResult", "docs": "Calculated accumulator for phantom revocations", "type": "optional", }, "accum_fixed": { - "display-name": "RevRegWalletUpdatedResult", "docs": "Applied ledger transaction to fix revocations", "type": "optional", }, "rev_reg_delta": { - "display-name": "RevRegWalletUpdatedResult", "docs": "Indy revocation registry delta", "type": "optional", }, @@ -46648,7 +45143,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "rev_reg_ids": { - "display-name": "RevRegsCreated", "type": "optional>", }, }, @@ -46661,11 +45155,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "connection_id": { - "display-name": "RouteRecord", "type": "optional", }, "created_at": { - "display-name": "RouteRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -46677,20 +45169,16 @@ exports[`open api parser > aries > simple 1`] = ` }, "recipient_key": "string", "record_id": { - "display-name": "RouteRecord", "type": "optional", }, "role": { - "display-name": "RouteRecord", "type": "optional", }, "state": { - "display-name": "RouteRecord", "docs": "Current record state", "type": "optional", }, "updated_at": { - "display-name": "RouteRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -46701,7 +45189,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "wallet_id": { - "display-name": "RouteRecord", "type": "optional", }, }, @@ -46713,12 +45200,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "attrNames": { - "display-name": "Schema", "docs": "Schema attribute names", "type": "optional>", }, "id": { - "display-name": "Schema", "docs": "Schema identifier", "type": "optional", "validation": { @@ -46729,12 +45214,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "name": { - "display-name": "Schema", "docs": "Schema name", "type": "optional", }, "seqNo": { - "display-name": "Schema", "docs": "Schema sequence number", "type": "optional", "validation": { @@ -46746,7 +45229,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "ver": { - "display-name": "Schema", "docs": "Node protocol version", "type": "optional", "validation": { @@ -46757,7 +45239,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "version": { - "display-name": "Schema", "docs": "Schema version", "type": "optional", "validation": { @@ -46776,7 +45257,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "schema": { - "display-name": "SchemaGetResult", "type": "optional", }, }, @@ -46788,12 +45268,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "required": { - "display-name": "SchemaInputDescriptor", "docs": "Required", "type": "optional", }, "uri": { - "display-name": "SchemaInputDescriptor", "docs": "URI", "type": "optional", }, @@ -46806,7 +45284,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "schema": { - "display-name": "SchemaSendResult", "type": "optional", }, "schema_id": { @@ -46833,7 +45310,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "schema_ids": { - "display-name": "SchemasCreatedResult", "type": "optional>", }, }, @@ -46845,12 +45321,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "oneof_filter": { - "display-name": "SchemasInputDescriptorFilter", "docs": "oneOf", "type": "optional", }, "uri_groups": { - "display-name": "SchemasInputDescriptorFilter", "type": "optional>>", }, }, @@ -46871,7 +45345,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "list", }, "routingKeys": { - "display-name": "ServiceDecorator", "docs": "List of routing keys", "type": "optional>", }, @@ -46888,12 +45361,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "error": { - "display-name": "SignResponse", "docs": "Error text", "type": "optional", }, "signed_doc": { - "display-name": "SignResponse", "docs": "Signed document", "type": "optional", }, @@ -46913,16 +45384,13 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "challenge": { - "display-name": "SignatureOptions", "type": "optional", }, "domain": { - "display-name": "SignatureOptions", "type": "optional", }, "proofPurpose": "string", "type": { - "display-name": "SignatureOptions", "type": "optional", }, "verificationMethod": "string", @@ -46949,41 +45417,33 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "count": { - "display-name": "SubmissionRequirements", "docs": "Count Value", "type": "optional", }, "from": { - "display-name": "SubmissionRequirements", "docs": "From", "type": "optional", }, "from_nested": { - "display-name": "SubmissionRequirements", "type": "optional>", }, "max": { - "display-name": "SubmissionRequirements", "docs": "Max Value", "type": "optional", }, "min": { - "display-name": "SubmissionRequirements", "docs": "Min Value", "type": "optional", }, "name": { - "display-name": "SubmissionRequirements", "docs": "Name", "type": "optional", }, "purpose": { - "display-name": "SubmissionRequirements", "docs": "Purpose", "type": "optional", }, "rule": { - "display-name": "SubmissionRequirements", "docs": "Selection", "type": "optional", }, @@ -46996,11 +45456,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "mechanism": { - "display-name": "TAAAcceptance", "type": "optional", }, "time": { - "display-name": "TAAAcceptance", "type": "optional", "validation": { "exclusiveMax": undefined, @@ -47019,19 +45477,15 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "aml_record": { - "display-name": "TAAInfo", "type": "optional", }, "taa_accepted": { - "display-name": "TAAInfo", "type": "optional", }, "taa_record": { - "display-name": "TAAInfo", "type": "optional", }, "taa_required": { - "display-name": "TAAInfo", "type": "optional", }, }, @@ -47043,15 +45497,12 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "digest": { - "display-name": "TAARecord", "type": "optional", }, "text": { - "display-name": "TAARecord", "type": "optional", }, "version": { - "display-name": "TAARecord", "type": "optional", }, }, @@ -47063,7 +45514,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "result": { - "display-name": "TAAResult", "type": "optional", }, }, @@ -47075,7 +45525,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "message": { - "display-name": "TailsDeleteResponse", "type": "optional", }, }, @@ -47087,12 +45536,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "transaction_my_job": { - "display-name": "TransactionJobs", "docs": "My transaction related job", "type": "optional", }, "transaction_their_job": { - "display-name": "TransactionJobs", "docs": "Their transaction related job", "type": "optional", }, @@ -47127,7 +45574,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "TransactionList", "docs": "List of transaction records", "type": "optional>", }, @@ -47140,17 +45586,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "_type": { - "display-name": "TransactionRecord", "docs": "Transaction type", "type": "optional", }, "connection_id": { - "display-name": "TransactionRecord", "docs": "The connection identifier for thie particular transaction record", "type": "optional", }, "created_at": { - "display-name": "TransactionRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -47161,56 +45604,44 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "endorser_write_txn": { - "display-name": "TransactionRecord", "docs": "If True, Endorser will write the transaction after endorsing it", "type": "optional", }, "formats": { - "display-name": "TransactionRecord", "type": "optional>>", }, "messages_attach": { - "display-name": "TransactionRecord", "type": "optional>", }, "meta_data": { - "display-name": "TransactionRecord", "type": "optional", }, "signature_request": { - "display-name": "TransactionRecord", "type": "optional>", }, "signature_response": { - "display-name": "TransactionRecord", "type": "optional>", }, "state": { - "display-name": "TransactionRecord", "docs": "Current record state", "type": "optional", }, "thread_id": { - "display-name": "TransactionRecord", "docs": "Thread Identifier", "type": "optional", }, "timing": { - "display-name": "TransactionRecord", "type": "optional", }, "trace": { - "display-name": "TransactionRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "transaction_id": { - "display-name": "TransactionRecord", "docs": "Transaction identifier", "type": "optional", }, "updated_at": { - "display-name": "TransactionRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -47264,11 +45695,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "sent": { - "display-name": "TxnOrCredentialDefinitionSendResult", "type": "optional", }, "txn": { - "display-name": "TxnOrCredentialDefinitionSendResult", "type": "optional", }, }, @@ -47285,11 +45714,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "sent": { - "display-name": "TxnOrPublishRevocationsResult", "type": "optional", }, "txn": { - "display-name": "TxnOrPublishRevocationsResult", "type": "optional", }, }, @@ -47306,12 +45733,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "success": { - "display-name": "TxnOrRegisterLedgerNymResponse", "docs": "Success of nym registration operation", "type": "optional", }, "txn": { - "display-name": "TxnOrRegisterLedgerNymResponse", "type": "optional", }, }, @@ -47328,11 +45753,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "sent": { - "display-name": "TxnOrRevRegResult", "type": "optional", }, "txn": { - "display-name": "TxnOrRevRegResult", "type": "optional", }, }, @@ -47349,11 +45772,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "sent": { - "display-name": "TxnOrSchemaSendResult", "type": "optional", }, "txn": { - "display-name": "TxnOrSchemaSendResult", "type": "optional", }, }, @@ -47380,27 +45801,22 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "auto_issue": { - "display-name": "V10CredentialExchange", "docs": "Issuer choice to issue to request in this credential exchange", "type": "optional", }, "auto_offer": { - "display-name": "V10CredentialExchange", "docs": "Holder choice to accept offer in this credential exchange", "type": "optional", }, "auto_remove": { - "display-name": "V10CredentialExchange", "docs": "Issuer choice to remove this credential exchange record when complete", "type": "optional", }, "connection_id": { - "display-name": "V10CredentialExchange", "docs": "Connection identifier", "type": "optional", }, "created_at": { - "display-name": "V10CredentialExchange", "docs": "Time of record creation", "type": "optional", "validation": { @@ -47411,11 +45827,9 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "credential": { - "display-name": "V10CredentialExchange", "type": "optional", }, "credential_definition_id": { - "display-name": "V10CredentialExchange", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -47426,72 +45840,57 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "credential_exchange_id": { - "display-name": "V10CredentialExchange", "docs": "Credential exchange identifier", "type": "optional", }, "credential_id": { - "display-name": "V10CredentialExchange", "docs": "Credential identifier", "type": "optional", }, "credential_offer": { - "display-name": "V10CredentialExchange", "type": "optional", }, "credential_offer_dict": { - "display-name": "V10CredentialExchange", "type": "optional", }, "credential_proposal_dict": { - "display-name": "V10CredentialExchange", "type": "optional", }, "credential_request": { - "display-name": "V10CredentialExchange", "type": "optional", }, "credential_request_metadata": { - "display-name": "V10CredentialExchange", "docs": "(Indy) credential request metadata", "type": "optional", }, "error_msg": { - "display-name": "V10CredentialExchange", "docs": "Error message", "type": "optional", }, "initiator": { - "display-name": "V10CredentialExchange", "docs": "Issue-credential exchange initiator: self or external", "type": "optional", }, "parent_thread_id": { - "display-name": "V10CredentialExchange", "docs": "Parent thread identifier", "type": "optional", }, "raw_credential": { - "display-name": "V10CredentialExchange", "type": "optional", }, "revoc_reg_id": { - "display-name": "V10CredentialExchange", "docs": "Revocation registry identifier", "type": "optional", }, "revocation_id": { - "display-name": "V10CredentialExchange", "docs": "Credential identifier within revocation registry", "type": "optional", }, "role": { - "display-name": "V10CredentialExchange", "docs": "Issue-credential exchange role: holder or issuer", "type": "optional", }, "schema_id": { - "display-name": "V10CredentialExchange", "docs": "Schema identifier", "type": "optional", "validation": { @@ -47502,22 +45901,18 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "state": { - "display-name": "V10CredentialExchange", "docs": "Issue-credential exchange state", "type": "optional", }, "thread_id": { - "display-name": "V10CredentialExchange", "docs": "Thread identifier", "type": "optional", }, "trace": { - "display-name": "V10CredentialExchange", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "V10CredentialExchange", "docs": "Time of last record update", "type": "optional", "validation": { @@ -47578,7 +45973,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V10CredentialExchangeListResult", "docs": "Aries#0036 v1.0 credential exchange records", "type": "optional>", }, @@ -47606,7 +46000,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V10DiscoveryExchangeListResult", "type": "optional>", }, }, @@ -47623,12 +46016,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "connection_id": { - "display-name": "V10DiscoveryRecord", "docs": "Connection identifier", "type": "optional", }, "created_at": { - "display-name": "V10DiscoveryRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -47639,35 +46030,28 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "disclose": { - "display-name": "V10DiscoveryRecord", "type": "optional", }, "discovery_exchange_id": { - "display-name": "V10DiscoveryRecord", "docs": "Credential exchange identifier", "type": "optional", }, "query_msg": { - "display-name": "V10DiscoveryRecord", "type": "optional", }, "state": { - "display-name": "V10DiscoveryRecord", "docs": "Current record state", "type": "optional", }, "thread_id": { - "display-name": "V10DiscoveryRecord", "docs": "Thread identifier", "type": "optional", }, "trace": { - "display-name": "V10DiscoveryRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "V10DiscoveryRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -47697,22 +46081,18 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "auto_present": { - "display-name": "V10PresentationExchange", "docs": "Prover choice to auto-present proof as verifier requests", "type": "optional", }, "auto_verify": { - "display-name": "V10PresentationExchange", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "connection_id": { - "display-name": "V10PresentationExchange", "docs": "Connection identifier", "type": "optional", }, "created_at": { - "display-name": "V10PresentationExchange", "docs": "Time of record creation", "type": "optional", "validation": { @@ -47723,58 +46103,46 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "error_msg": { - "display-name": "V10PresentationExchange", "docs": "Error message", "type": "optional", }, "initiator": { - "display-name": "V10PresentationExchange", "docs": "Present-proof exchange initiator: self or external", "type": "optional", }, "presentation": { - "display-name": "V10PresentationExchange", "type": "optional", }, "presentation_exchange_id": { - "display-name": "V10PresentationExchange", "docs": "Presentation exchange identifier", "type": "optional", }, "presentation_proposal_dict": { - "display-name": "V10PresentationExchange", "type": "optional", }, "presentation_request": { - "display-name": "V10PresentationExchange", "type": "optional", }, "presentation_request_dict": { - "display-name": "V10PresentationExchange", "type": "optional", }, "role": { - "display-name": "V10PresentationExchange", "docs": "Present-proof exchange role: prover or verifier", "type": "optional", }, "state": { - "display-name": "V10PresentationExchange", "docs": "Present-proof exchange state", "type": "optional", }, "thread_id": { - "display-name": "V10PresentationExchange", "docs": "Thread identifier", "type": "optional", }, "trace": { - "display-name": "V10PresentationExchange", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "V10PresentationExchange", "docs": "Time of last record update", "type": "optional", "validation": { @@ -47785,12 +46153,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "verified": { - "display-name": "V10PresentationExchange", "docs": "Whether presentation is verified: true or false", "type": "optional", }, "verified_msgs": { - "display-name": "V10PresentationExchange", "type": "optional>", }, }, @@ -47812,7 +46178,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V10PresentationExchangeList", "docs": "Aries RFC 37 v1.0 presentation exchange records", "type": "optional>", }, @@ -47865,7 +46230,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "mime-type": { - "display-name": "V20CredAttrSpec", "docs": "MIME type: omit for (null) default", "type": "optional", }, @@ -47896,12 +46260,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "auto_remove": { - "display-name": "V20CredExFree", "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "optional", }, "comment": { - "display-name": "V20CredExFree", "docs": "Human-readable comment", "type": "optional", }, @@ -47916,17 +46278,14 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "credential_preview": { - "display-name": "V20CredExFree", "type": "optional", }, "filter": "V20CredBoundOfferRequestFilter", "trace": { - "display-name": "V20CredExFree", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "verification_method": { - "display-name": "V20CredExFree", "docs": "For ld-proofs. Verification method for signing.", "type": "optional", }, @@ -47939,31 +46298,25 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "auto_issue": { - "display-name": "V20CredExRecord", "docs": "Issuer choice to issue to request in this credential exchange", "type": "optional", }, "auto_offer": { - "display-name": "V20CredExRecord", "docs": "Holder choice to accept offer in this credential exchange", "type": "optional", }, "auto_remove": { - "display-name": "V20CredExRecord", "docs": "Issuer choice to remove this credential exchange record when complete", "type": "optional", }, "by_format": { - "display-name": "V20CredExRecord", "type": "optional", }, "connection_id": { - "display-name": "V20CredExRecord", "docs": "Connection identifier", "type": "optional", }, "created_at": { - "display-name": "V20CredExRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -47974,67 +46327,53 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "cred_ex_id": { - "display-name": "V20CredExRecord", "docs": "Credential exchange identifier", "type": "optional", }, "cred_issue": { - "display-name": "V20CredExRecord", "type": "optional", }, "cred_offer": { - "display-name": "V20CredExRecord", "type": "optional", }, "cred_preview": { - "display-name": "V20CredExRecord", "type": "optional", }, "cred_proposal": { - "display-name": "V20CredExRecord", "type": "optional", }, "cred_request": { - "display-name": "V20CredExRecord", "type": "optional", }, "error_msg": { - "display-name": "V20CredExRecord", "docs": "Error message", "type": "optional", }, "initiator": { - "display-name": "V20CredExRecord", "docs": "Issue-credential exchange initiator: self or external", "type": "optional", }, "parent_thread_id": { - "display-name": "V20CredExRecord", "docs": "Parent thread identifier", "type": "optional", }, "role": { - "display-name": "V20CredExRecord", "docs": "Issue-credential exchange role: holder or issuer", "type": "optional", }, "state": { - "display-name": "V20CredExRecord", "docs": "Issue-credential exchange state", "type": "optional", }, "thread_id": { - "display-name": "V20CredExRecord", "docs": "Thread identifier", "type": "optional", }, "trace": { - "display-name": "V20CredExRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "V20CredExRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -48053,19 +46392,15 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "cred_issue": { - "display-name": "V20CredExRecordByFormat", "type": "optional", }, "cred_offer": { - "display-name": "V20CredExRecordByFormat", "type": "optional", }, "cred_proposal": { - "display-name": "V20CredExRecordByFormat", "type": "optional", }, "cred_request": { - "display-name": "V20CredExRecordByFormat", "type": "optional", }, }, @@ -48130,15 +46465,12 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "cred_ex_record": { - "display-name": "V20CredExRecordDetail", "type": "optional", }, "indy": { - "display-name": "V20CredExRecordDetail", "type": "optional", }, "ld_proof": { - "display-name": "V20CredExRecordDetail", "type": "optional", }, }, @@ -48155,7 +46487,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "V20CredExRecordIndy", "docs": "Time of record creation", "type": "optional", "validation": { @@ -48166,27 +46497,22 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "cred_ex_id": { - "display-name": "V20CredExRecordIndy", "docs": "Corresponding v2.0 credential exchange record identifier", "type": "optional", }, "cred_ex_indy_id": { - "display-name": "V20CredExRecordIndy", "docs": "Record identifier", "type": "optional", }, "cred_id_stored": { - "display-name": "V20CredExRecordIndy", "docs": "Credential identifier stored in wallet", "type": "optional", }, "cred_request_metadata": { - "display-name": "V20CredExRecordIndy", "docs": "Credential request metadata for indy holder", "type": "optional", }, "cred_rev_id": { - "display-name": "V20CredExRecordIndy", "docs": "Credential revocation identifier within revocation registry", "type": "optional", "validation": { @@ -48197,7 +46523,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "rev_reg_id": { - "display-name": "V20CredExRecordIndy", "docs": "Revocation registry identifier", "type": "optional", "validation": { @@ -48208,12 +46533,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "state": { - "display-name": "V20CredExRecordIndy", "docs": "Current record state", "type": "optional", }, "updated_at": { - "display-name": "V20CredExRecordIndy", "docs": "Time of last record update", "type": "optional", "validation": { @@ -48249,7 +46572,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "V20CredExRecordLDProof", "docs": "Time of record creation", "type": "optional", "validation": { @@ -48260,27 +46582,22 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "cred_ex_id": { - "display-name": "V20CredExRecordLDProof", "docs": "Corresponding v2.0 credential exchange record identifier", "type": "optional", }, "cred_ex_ld_proof_id": { - "display-name": "V20CredExRecordLDProof", "docs": "Record identifier", "type": "optional", }, "cred_id_stored": { - "display-name": "V20CredExRecordLDProof", "docs": "Credential identifier stored in wallet", "type": "optional", }, "state": { - "display-name": "V20CredExRecordLDProof", "docs": "Current record state", "type": "optional", }, "updated_at": { - "display-name": "V20CredExRecordLDProof", "docs": "Time of last record update", "type": "optional", "validation": { @@ -48299,7 +46616,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V20CredExRecordListResult", "docs": "Credential exchange records and corresponding detail records", "type": "optional>", }, @@ -48369,11 +46685,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "indy": { - "display-name": "V20CredFilter", "type": "optional", }, "ld_proof": { - "display-name": "V20CredFilter", "type": "optional", }, }, @@ -48385,7 +46699,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "cred_def_id": { - "display-name": "V20CredFilterIndy", "docs": "Credential definition identifier", "type": "optional", "validation": { @@ -48396,7 +46709,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "issuer_did": { - "display-name": "V20CredFilterIndy", "docs": "Credential issuer DID", "type": "optional", "validation": { @@ -48407,7 +46719,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_id": { - "display-name": "V20CredFilterIndy", "docs": "Schema identifier", "type": "optional", "validation": { @@ -48418,7 +46729,6 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_issuer_did": { - "display-name": "V20CredFilterIndy", "docs": "Schema issuer DID", "type": "optional", "validation": { @@ -48429,12 +46739,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "schema_name": { - "display-name": "V20CredFilterIndy", "docs": "Schema name", "type": "optional", }, "schema_version": { - "display-name": "V20CredFilterIndy", "docs": "Schema version", "type": "optional", "validation": { @@ -48474,17 +46782,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20CredIssue", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20CredIssue", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20CredIssue", "docs": "Human-readable comment", "type": "optional", }, @@ -48499,7 +46804,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "list", }, "replacement_id": { - "display-name": "V20CredIssue", "docs": "Issuer-unique identifier to coordinate credential replacement", "type": "optional", }, @@ -48512,22 +46816,18 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20CredOffer", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20CredOffer", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20CredOffer", "docs": "Human-readable comment", "type": "optional", }, "credential_preview": { - "display-name": "V20CredOffer", "type": "optional", }, "formats": { @@ -48541,7 +46841,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "list", }, "replacement_id": { - "display-name": "V20CredOffer", "docs": "Issuer-unique identifier to coordinate credential replacement", "type": "optional", }, @@ -48554,7 +46853,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@type": { - "display-name": "V20CredPreview", "docs": "Message type identifier", "type": "optional", }, @@ -48568,22 +46866,18 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20CredProposal", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20CredProposal", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20CredProposal", "docs": "Human-readable comment", "type": "optional", }, "credential_preview": { - "display-name": "V20CredProposal", "type": "optional", }, "filters~attach": { @@ -48610,17 +46904,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20CredRequest", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20CredRequest", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20CredRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -48648,7 +46939,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V20DiscoveryExchangeListResult", "type": "optional>", }, }, @@ -48665,7 +46955,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V20DiscoveryExchangeResult", "type": "optional", }, }, @@ -48677,12 +46966,10 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "connection_id": { - "display-name": "V20DiscoveryRecord", "docs": "Connection identifier", "type": "optional", }, "created_at": { - "display-name": "V20DiscoveryRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -48693,35 +46980,28 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "disclosures": { - "display-name": "V20DiscoveryRecord", "type": "optional", }, "discovery_exchange_id": { - "display-name": "V20DiscoveryRecord", "docs": "Credential exchange identifier", "type": "optional", }, "queries_msg": { - "display-name": "V20DiscoveryRecord", "type": "optional", }, "state": { - "display-name": "V20DiscoveryRecord", "docs": "Current record state", "type": "optional", }, "thread_id": { - "display-name": "V20DiscoveryRecord", "docs": "Thread identifier", "type": "optional", }, "trace": { - "display-name": "V20DiscoveryRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "V20DiscoveryRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -48751,17 +47031,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20Pres", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20Pres", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20Pres", "docs": "Human-readable comment", "type": "optional", }, @@ -48783,26 +47060,21 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "auto_present": { - "display-name": "V20PresExRecord", "docs": "Prover choice to auto-present proof as verifier requests", "type": "optional", }, "auto_verify": { - "display-name": "V20PresExRecord", "docs": "Verifier choice to auto-verify proof presentation", "type": "optional", }, "by_format": { - "display-name": "V20PresExRecord", "type": "optional", }, "connection_id": { - "display-name": "V20PresExRecord", "docs": "Connection identifier", "type": "optional", }, "created_at": { - "display-name": "V20PresExRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -48813,54 +47085,43 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "error_msg": { - "display-name": "V20PresExRecord", "docs": "Error message", "type": "optional", }, "initiator": { - "display-name": "V20PresExRecord", "docs": "Present-proof exchange initiator: self or external", "type": "optional", }, "pres": { - "display-name": "V20PresExRecord", "type": "optional", }, "pres_ex_id": { - "display-name": "V20PresExRecord", "docs": "Presentation exchange identifier", "type": "optional", }, "pres_proposal": { - "display-name": "V20PresExRecord", "type": "optional", }, "pres_request": { - "display-name": "V20PresExRecord", "type": "optional", }, "role": { - "display-name": "V20PresExRecord", "docs": "Present-proof exchange role: prover or verifier", "type": "optional", }, "state": { - "display-name": "V20PresExRecord", "docs": "Present-proof exchange state", "type": "optional", }, "thread_id": { - "display-name": "V20PresExRecord", "docs": "Thread identifier", "type": "optional", }, "trace": { - "display-name": "V20PresExRecord", "docs": "Record trace information, based on agent configuration", "type": "optional", }, "updated_at": { - "display-name": "V20PresExRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -48871,12 +47132,10 @@ exports[`open api parser > aries > simple 1`] = ` }, }, "verified": { - "display-name": "V20PresExRecord", "docs": "Whether presentation is verified: 'true' or 'false'", "type": "optional", }, "verified_msgs": { - "display-name": "V20PresExRecord", "type": "optional>", }, }, @@ -48888,15 +47147,12 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "pres": { - "display-name": "V20PresExRecordByFormat", "type": "optional", }, "pres_proposal": { - "display-name": "V20PresExRecordByFormat", "type": "optional", }, "pres_request": { - "display-name": "V20PresExRecordByFormat", "type": "optional", }, }, @@ -48932,7 +47188,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "V20PresExRecordList", "docs": "Presentation exchange records", "type": "optional>", }, @@ -49031,17 +47286,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20PresProposal", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20PresProposal", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20PresProposal", "docs": "Human-readable comment", "type": "optional", }, @@ -49063,11 +47315,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "dif": { - "display-name": "V20PresProposalByFormat", "type": "optional", }, "indy": { - "display-name": "V20PresProposalByFormat", "type": "optional", }, }, @@ -49089,17 +47339,14 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "@id": { - "display-name": "V20PresRequest", "docs": "Message identifier", "type": "optional", }, "@type": { - "display-name": "V20PresRequest", "docs": "Message type", "type": "optional", }, "comment": { - "display-name": "V20PresRequest", "docs": "Human-readable comment", "type": "optional", }, @@ -49113,7 +47360,6 @@ exports[`open api parser > aries > simple 1`] = ` "type": "list", }, "will_confirm": { - "display-name": "V20PresRequest", "docs": "Whether verifier will send confirmation ack", "type": "optional", }, @@ -49126,11 +47372,9 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "dif": { - "display-name": "V20PresRequestByFormat", "type": "optional", }, "indy": { - "display-name": "V20PresRequestByFormat", "type": "optional", }, }, @@ -49163,47 +47407,37 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "contexts": { - "display-name": "VCRecord", "type": "optional>", }, "cred_tags": { - "display-name": "VCRecord", "type": "optional>", }, "cred_value": { - "display-name": "VCRecord", "docs": "(JSON-serializable) credential value", "type": "optional", }, "expanded_types": { - "display-name": "VCRecord", "type": "optional>", }, "given_id": { - "display-name": "VCRecord", "docs": "Credential identifier", "type": "optional", }, "issuer_id": { - "display-name": "VCRecord", "docs": "Issuer identifier", "type": "optional", }, "proof_types": { - "display-name": "VCRecord", "type": "optional>", }, "record_id": { - "display-name": "VCRecord", "docs": "Record identifier", "type": "optional", }, "schema_ids": { - "display-name": "VCRecord", "type": "optional>", }, "subject_ids": { - "display-name": "VCRecord", "type": "optional>", }, }, @@ -49215,7 +47449,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "VCRecordList", "type": "optional>", }, }, @@ -49239,7 +47472,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "error": { - "display-name": "VerifyResponse", "docs": "Error text", "type": "optional", }, @@ -49253,7 +47485,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "results": { - "display-name": "WalletList", "docs": "List of wallet records", "type": "optional>", }, @@ -49267,7 +47498,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "created_at": { - "display-name": "WalletRecord", "docs": "Time of record creation", "type": "optional", "validation": { @@ -49282,17 +47512,14 @@ exports[`open api parser > aries > simple 1`] = ` "type": "WalletRecordKeyManagementMode", }, "settings": { - "display-name": "WalletRecord", "docs": "Settings for this wallet.", "type": "optional", }, "state": { - "display-name": "WalletRecord", "docs": "Current record state", "type": "optional", }, "updated_at": { - "display-name": "WalletRecord", "docs": "Time of last record update", "type": "optional", "validation": { @@ -49332,7 +47559,6 @@ exports[`open api parser > aries > simple 1`] = ` "docs": undefined, "properties": { "ledger_id": { - "display-name": "WriteLedgerRequest", "type": "optional", }, }, diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/axle.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/axle.test.ts.snap index 9c81a5393fa..371b0753941 100644 --- a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/axle.test.ts.snap +++ b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/axle.test.ts.snap @@ -92,7 +92,6 @@ exports[`open api parser > axle > docs 1`] = ` "carrier": "string", "createdAt": "string", "email": { - "display-name": "Account", "type": "optional", }, "firstName": "string", @@ -100,7 +99,6 @@ exports[`open api parser > axle > docs 1`] = ` "lastName": "string", "modifiedAt": "string", "phone": { - "display-name": "Account", "type": "optional", }, "policies": "list", @@ -699,27 +697,21 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "docs": undefined, "properties": { "addressLine1": { - "display-name": "Address", "type": "optional", }, "addressLine2": { - "display-name": "Address", "type": "optional", }, "city": { - "display-name": "Address", "type": "optional", }, "country": { - "display-name": "Address", "type": "optional", }, "postalCode": { - "display-name": "Address", "type": "optional", }, "state": { - "display-name": "Address", "type": "optional", }, }, @@ -737,7 +729,6 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "domain": "string", "id": "string", "logoUrl": { - "display-name": "Carrier", "type": "optional", }, "modifiedAt": "string", @@ -753,20 +744,16 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "properties": { "code": "CoverageCode", "deductible": { - "display-name": "Coverage", "type": "optional", }, "label": "string", "limitPerAccident": { - "display-name": "Coverage", "type": "optional", }, "limitPerPerson": { - "display-name": "Coverage", "type": "optional", }, "property": { - "display-name": "Coverage", "type": "optional", }, }, @@ -793,12 +780,10 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "docs": undefined, "properties": { "message": { - "display-name": "Error", "docs": "Provides a reason for why the operation failed, if available.", "type": "optional", }, "success": { - "display-name": "Error", "type": "optional", }, }, @@ -810,33 +795,26 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "docs": undefined, "properties": { "dateOfBirth": { - "display-name": "Insured", "type": "optional", }, "dateOfBirthYear": { - "display-name": "Insured", "type": "optional", }, "firstName": "string", "lastName": "string", "licenseNo": { - "display-name": "Insured", "type": "optional", }, "licenseState": { - "display-name": "Insured", "type": "optional", }, "licenseStatus": { - "display-name": "Insured", "type": "optional", }, "property": { - "display-name": "Insured", "type": "optional", }, "type": { - "display-name": "Insured", "type": "optional", }, }, @@ -866,12 +844,10 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "docs": undefined, "properties": { "address": { - "display-name": "Third Party", "type": "optional
", }, "name": "string", "property": { - "display-name": "Third Party", "type": "optional", }, "type": { @@ -898,12 +874,10 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "docs": "User to attach to Ignition session. If user is set, unique \`id\` must be provided.", "properties": { "email": { - "display-name": "User", "docs": "User's email address.", "type": "optional", }, "firstName": { - "display-name": "User", "docs": "User's first name.", "type": "optional", }, @@ -912,12 +886,10 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "type": "string", }, "lastName": { - "display-name": "User", "docs": "User's last name.", "type": "optional", }, "phone": { - "display-name": "User", "docs": "User's phone number in E.164 format.", "type": "optional", }, @@ -930,7 +902,6 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "docs": undefined, "properties": { "bodyStyle": { - "display-name": "Vehicle", "type": "optional", }, "make": "string", @@ -1044,7 +1015,6 @@ exports[`open api parser > axle > simple 1`] = ` "carrier": "string", "createdAt": "string", "email": { - "display-name": "Account", "type": "optional", }, "firstName": "string", @@ -1052,7 +1022,6 @@ exports[`open api parser > axle > simple 1`] = ` "lastName": "string", "modifiedAt": "string", "phone": { - "display-name": "Account", "type": "optional", }, "policies": "list", @@ -1572,27 +1541,21 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "docs": undefined, "properties": { "addressLine1": { - "display-name": "Address", "type": "optional", }, "addressLine2": { - "display-name": "Address", "type": "optional", }, "city": { - "display-name": "Address", "type": "optional", }, "country": { - "display-name": "Address", "type": "optional", }, "postalCode": { - "display-name": "Address", "type": "optional", }, "state": { - "display-name": "Address", "type": "optional", }, }, @@ -1610,7 +1573,6 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "domain": "string", "id": "string", "logoUrl": { - "display-name": "Carrier", "type": "optional", }, "modifiedAt": "string", @@ -1626,20 +1588,16 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "properties": { "code": "CoverageCode", "deductible": { - "display-name": "Coverage", "type": "optional", }, "label": "string", "limitPerAccident": { - "display-name": "Coverage", "type": "optional", }, "limitPerPerson": { - "display-name": "Coverage", "type": "optional", }, "property": { - "display-name": "Coverage", "type": "optional", }, }, @@ -1666,12 +1624,10 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "docs": undefined, "properties": { "message": { - "display-name": "Error", "docs": "Provides a reason for why the operation failed, if available.", "type": "optional", }, "success": { - "display-name": "Error", "type": "optional", }, }, @@ -1683,33 +1639,26 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "docs": undefined, "properties": { "dateOfBirth": { - "display-name": "Insured", "type": "optional", }, "dateOfBirthYear": { - "display-name": "Insured", "type": "optional", }, "firstName": "string", "lastName": "string", "licenseNo": { - "display-name": "Insured", "type": "optional", }, "licenseState": { - "display-name": "Insured", "type": "optional", }, "licenseStatus": { - "display-name": "Insured", "type": "optional", }, "property": { - "display-name": "Insured", "type": "optional", }, "type": { - "display-name": "Insured", "type": "optional", }, }, @@ -1739,12 +1688,10 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "docs": undefined, "properties": { "address": { - "display-name": "Third Party", "type": "optional
", }, "name": "string", "property": { - "display-name": "Third Party", "type": "optional", }, "type": { @@ -1771,12 +1718,10 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "docs": "User to attach to Ignition session. If user is set, unique \`id\` must be provided.", "properties": { "email": { - "display-name": "User", "docs": "User's email address.", "type": "optional", }, "firstName": { - "display-name": "User", "docs": "User's first name.", "type": "optional", }, @@ -1785,12 +1730,10 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "type": "string", }, "lastName": { - "display-name": "User", "docs": "User's last name.", "type": "optional", }, "phone": { - "display-name": "User", "docs": "User's phone number in E.164 format.", "type": "optional", }, @@ -1803,7 +1746,6 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "docs": undefined, "properties": { "bodyStyle": { - "display-name": "Vehicle", "type": "optional", }, "make": "string", diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/belvo.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/belvo.test.ts.snap index 259a73e1ec4..c2ebde3ae90 100644 --- a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/belvo.test.ts.snap +++ b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/belvo.test.ts.snap @@ -14967,7 +14967,6 @@ A payment intent captures all payment information (such as the amount to be char "type": "string", }, "metadata": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "Optional and customizable object where you can provide any additional key-value pairs for your internal purposes. For example, an internal reference number for the payment intent. ⚠️ **Note**: You can only provide up to 50 keys (keys can have up to 50 characters each and each value can be up to 500 characters). We do not support nested objects, only ASCII values.", @@ -20360,7 +20359,6 @@ client.connect() "properties": { "attach_pdf": { "default": false, - "display-name": "Tax Declarations", "docs": "When this is set to \`true\`, you will receive the PDF as a binary string in the response.", "type": "optional", }, @@ -20376,7 +20374,6 @@ client.connect() }, "save_data": { "default": true, - "display-name": "Tax Declarations", "docs": "Indicates whether or not to persist the data in Belvo. By default, this is set to \`true\` and we return a 201 Created response. When set to \`false\`, the data won't be persisted and we return a 200 OK response.", "type": "optional", @@ -31461,14 +31458,12 @@ client.connect() "docs": "This error occurs when you try to access Belvo's resource without the correct permissions.", "properties": { "code": { - "display-name": "Access to Belvo API denied", "docs": "A unique error code (\`access_to_resource_denied\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 403 access_to_resource_denied.", "type": "optional", }, "message": { - "display-name": "Access to Belvo API denied", "docs": "A short description of the error. For \`access_to_resource_denied\` errors, the description is: @@ -31477,7 +31472,6 @@ For \`access_to_resource_denied\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Access to Belvo API denied", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -32279,7 +32273,6 @@ For \`BUSINESS\` bank accounts that Belvo creates for organizations, this field }, }, "metadata": { - "display-name": "Business Bank Account", "docs": "Optional and customizable object where you can provide any additional key-value pairs for your internal purposes. For example, an internal reference number for the payment intent. ⚠️ **Note**: You can only provide up to 50 keys (keys can have up to 50 characters each and each value can be up to 500 characters). We do not support nested objects, only ASCII values.", @@ -32397,7 +32390,6 @@ For \`BUSINESS\` bank accounts that Belvo creates for organizations, this field "docs": "Information about the payer's bank account. Belvo returns this object when the payer's bank account information is not saved in the Belvo database.", "properties": { "bank_account_information": { - "display-name": "Bank account information PSE", "type": "optional", }, }, @@ -32546,7 +32538,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "details": { - "display-name": "Beneficiary Bank Account", "type": "optional", }, "holder": { @@ -32591,11 +32582,9 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "holder": { - "display-name": "Beneficiary Bank Account PSE", "type": "optional", }, "id": { - "display-name": "Beneficiary Bank Account PSE", "docs": "Belvo's unique ID for the beneficiary bank account.", "type": "optional", "validation": { @@ -32606,7 +32595,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "institution": { - "display-name": "Beneficiary Bank Account PSE", "docs": "Belvo's unique ID for the institution that the bank account is created in.", "type": "optional", "validation": { @@ -32617,7 +32605,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "number": { - "display-name": "Beneficiary Bank Account PSE", "docs": "The bank account number.", "type": "optional", }, @@ -32630,7 +32617,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Details regarding the business bank account holder.", "properties": { "Information": { - "display-name": "Business", "type": "optional", }, "type": "EnumBankAccountHolderTypePse", @@ -33038,7 +33024,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "PSE", }, "metadata": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "Optional and customizable object where you can provide any additional key-value pairs for your internal purposes. For example, an internal reference number for the payment intent. ⚠️ **Note**: You can only provide up to 50 keys (keys can have up to 50 characters each and each value can be up to 500 characters). We do not support nested objects, only ASCII values.", @@ -33063,7 +33048,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "address": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The customer's physical address. ", "type": "optional", @@ -33099,7 +33083,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "phone": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The customer's phone number. ", "type": "optional", @@ -33113,7 +33096,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "address": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The customer's physical address. ", "type": "optional", @@ -33149,7 +33131,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "phone": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The customer's phone number. ", "type": "optional", @@ -33174,7 +33155,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "CreatePaymentLinkOfpiAmount", }, "callback_urls": { - "display-name": "Brazil 🇧🇷 OFPI", "type": "optional", }, "customer": { @@ -33189,7 +33169,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "expires_in": { "default": "7d", - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The payment link expiration time. It allows the following formats to be sent through: - whole number + \`m\` for x amount of minutes. For example: \`15m\` for 15 minutes. @@ -33242,7 +33221,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "allowed_payment_method_types": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "A list of payment method types allowed in this payment intent. For PSE, this value must be set to \`pse\`.", "type": "optional>", }, @@ -33254,7 +33232,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "CreatePaymentLinkPseAmount", }, "callback_urls": { - "display-name": "Colombia 🇨🇴 PSE", "type": "optional", }, "customer": { @@ -33269,7 +33246,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "expires_in": { "default": "7d", - "display-name": "Colombia 🇨🇴 PSE", "docs": "The payment link expiration time. It allows the following formats to be sent through: - whole number + \`m\` for x amount of minutes. For example: \`15m\` for 15 minutes. @@ -33322,7 +33298,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "address": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The customers physical address. ", "type": "optional", @@ -33382,7 +33357,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "phone": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The customer's phone number. ", "type": "optional", @@ -33441,7 +33415,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "address": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The customers physical address. @@ -33504,7 +33477,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "phone": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The customer's phone number. @@ -33521,7 +33493,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "payer_institution": { - "display-name": "Display PSE Colombia confirmation required.", "type": "optional", }, }, @@ -33533,20 +33504,16 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "beneficiary_bank_account": { - "display-name": "Display Open Finance Brazil confirmation required", "type": "optional", }, "payer_identifier": { - "display-name": "Display Open Finance Brazil confirmation required", "docs": "The payer's ID.", "type": "optional", }, "payer_institution": { - "display-name": "Display Open Finance Brazil confirmation required", "type": "optional", }, "payer_name": { - "display-name": "Display Open Finance Brazil confirmation required", "docs": "The name of the payer.", "type": "optional", }, @@ -33559,7 +33526,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Object containing form fields for the required credentials (for example, \`username\` or \`password\`) in this step.", "properties": { "payer_institution": { - "display-name": "Display PSE confirmation required", "type": "optional", }, }, @@ -33571,11 +33537,9 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Object detailing what payment method information you need to display.", "properties": { "beneficiary_bank_account": { - "display-name": "Display PSE payment method information", "type": "optional", }, "customer_bank_accounts": { - "display-name": "Display PSE payment method information", "docs": "Array of customer bank account objects.", "type": "optional>", }, @@ -33597,7 +33561,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Object detailing what payment method information you need to display.", "properties": { "institutions": { - "display-name": "Display Open Finance Brazil payment method information", "docs": "An array of institution objects.", "type": "optional>", }, @@ -33610,14 +33573,12 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Object detailing what payment method information you need to display.", "properties": { "customer_bank_accounts": { - "display-name": "Display PSE payment method information", "docs": "Array of bank account objects. **Note**: If there are no customer accounts saved in the Belvo database, we return an empty array.", "type": "optional>", }, "institutions": { - "display-name": "Display PSE payment method information", "docs": "An array of institution objects.", "type": "optional>", }, @@ -35685,14 +35646,12 @@ Please see our [Institutions](https://developers.belvo.com/docs/institution) Dev "docs": "This error occurs when the institution's website that you're trying to access is down due to maintenance or other issues, which means Belvo is unable to create new links or retrieve new data.", "properties": { "code": { - "display-name": "Institution Down", "docs": "A unique error code (\`institution_down\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 institution_down errors.", "type": "optional", }, "message": { - "display-name": "Institution Down", "docs": "A short description of the error. For \`institution_down\` errors, the description is: @@ -35701,7 +35660,6 @@ For \`institution_down\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Institution Down", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -35768,14 +35726,12 @@ For \`institution_down\` errors, the description is: "docs": "This error occurs when we (Belvo) have deactivated the institution in our API.", "properties": { "code": { - "display-name": "Institution Inactive", "docs": "A unique error code (\`institution_inactive\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 institution_inactive errors.", "type": "optional", }, "message": { - "display-name": "Institution Inactive", "docs": "A short description of the error. For \`institution_inactive\` errors, the description is: @@ -35784,7 +35740,6 @@ For \`institution_inactive\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Institution Inactive", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -35803,14 +35758,12 @@ For \`institution_inactive\` errors, the description is: "docs": "This error occurs when the institution's website that you're trying to access is down due to maintenance or other issues, which means Belvo is unable to create new links or retrieve new data.", "properties": { "code": { - "display-name": "Institution Unavailable", "docs": "A unique error code (\`institution_unavailable\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how handle 400 institution_unavailable errors.", "type": "optional", }, "message": { - "display-name": "Institution Unavailable", "docs": "A short description of the error. For \`institution_unavailable\` errors, the description is: @@ -35819,7 +35772,6 @@ For \`institution_unavailable\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Institution Unavailable", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -35953,14 +35905,12 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "This error occurs when you try to update a link from single to recurrent, but there are no login credentials stored for the user.", "properties": { "code": { - "display-name": "Invalid Access Mode", "docs": "A unique error code (\`invalid_access_mode_switch\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 invalid_access_mode_switch errors.", "type": "optional", }, "message": { - "display-name": "Invalid Access Mode", "docs": "A short description of the error. For \`invalid_access_mode_switch\` errors, the description is: @@ -35969,7 +35919,6 @@ For \`invalid_access_mode_switch\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Invalid Access Mode", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -35988,14 +35937,12 @@ For \`invalid_access_mode_switch\` errors, the description is: "docs": "This error occurs when you try to access an account but the user credentials are no longer valid, prompting an error from the institution.", "properties": { "code": { - "display-name": "Invalid Link", "docs": "A unique error code (\`invalid_link\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 invalid_link errors.", "type": "optional", }, "message": { - "display-name": "Invalid Link", "docs": "A short description of the error. For \`invalid_link\` errors, the description is: @@ -36004,7 +35951,6 @@ For \`invalid_link\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Invalid Link", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -36023,14 +35969,12 @@ For \`invalid_link\` errors, the description is: "docs": "This error occurs when you request incomes for a link within a given date range, however, the period between \`date_from\` and \`date_to\` is less than 90 days.", "properties": { "code": { - "display-name": "Invalid Period", "docs": "A unique error code (\`invalid_period\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 invalid_period errors.", "type": "optional", }, "message": { - "display-name": "Invalid Period", "docs": "A short description of the error. For \`invalid_period\` errors, the description is: @@ -36039,7 +35983,6 @@ For \`invalid_period\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Invalid Period", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -36498,7 +36441,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "created_at": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", "type": "optional", }, @@ -36523,7 +36465,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "expiration_date": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "Indicates when the invoice is set to expire. For example: If the invoice is paid in installments, this field indicates the date when the installment is to be paid. @@ -36537,13 +36478,11 @@ For example: If the invoice is paid in installments, this field indicates the da }, }, "folio": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "**Note**: This field is not applicable for DIAN Colombia and will return \`null\`. ", "type": "optional", }, "id": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "Belvo's unique identifier for the current invoice.", "type": "optional", "validation": { @@ -36574,17 +36513,14 @@ For example: If the invoice is paid in installments, this field indicates the da }, "invoice_type": "optional", "link": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "The \`link.id\` the invoice belongs to.", "type": "optional", }, "payment_method": { - "display-name": "🇨🇴 DIAN Colombia", "type": "optional", }, "payment_method_description": { "availability": "deprecated", - "display-name": "🇨🇴 DIAN Colombia", "docs": "The description of the payment method used for this invoice. ", "type": "optional", @@ -36608,13 +36544,11 @@ For detailed information regarding DIAN's payment types, please see their [offic }, "payroll": "optional", "place_of_issue": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "**Note**: This field is not applicable for DIAN Colombia and will return \`null\`. ", "type": "optional", }, "receiver_details": { - "display-name": "🇨🇴 DIAN Colombia", "type": "optional", }, "receiver_id": { @@ -36626,12 +36560,10 @@ For detailed information regarding DIAN's payment types, please see their [offic "type": "optional", }, "receiver_tax_fraud_status": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "**Note**: This field is not applicable for DIAN Colombia and will return \`null\`.", "type": "optional", }, "sender_details": { - "display-name": "🇨🇴 DIAN Colombia", "type": "optional", }, "sender_id": { @@ -36643,7 +36575,6 @@ For detailed information regarding DIAN's payment types, please see their [offic "type": "optional", }, "sender_tax_fraud_status": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "Indicates whether or not the sender is on a tax fraud list for having submitted incorrect data, having outstanding payments, or having conducted business that is in violation of the fiscal institution's regulations. **Note**: This field is not applicable for DIAN Colombia and will return \`null\`.", "type": "optional", @@ -36672,23 +36603,19 @@ For detailed information regarding DIAN's payment types, please see their [offic }, "type": "optional", "usage": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "**Note**: This field is not applicable for DIAN Colombia and will return \`null\`. ", "type": "optional", }, "version": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "**Note**: This field is not applicable for DIAN Colombia and will return \`null\`. ", "type": "optional", }, "warnings": { - "display-name": "🇨🇴 DIAN Colombia", "type": "optional", }, "xml": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "**Note**: This field is not applicable for DIAN Colombia and will return \`null\`. ", "type": "optional", @@ -36830,7 +36757,6 @@ For detailed information regarding DIAN's tax schemes, please see their [officia "type": "optional", }, "created_at": { - "display-name": "🇲🇽 SAT Mexico", "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", "type": "optional", }, @@ -36855,13 +36781,11 @@ For detailed information regarding DIAN's tax schemes, please see their [officia "type": "optional", }, "folio": { - "display-name": "🇲🇽 SAT Mexico", "docs": "The internal control number that the taxpayer assigns to the invoice. ", "type": "optional", }, "id": { - "display-name": "🇲🇽 SAT Mexico", "docs": "Belvo's unique identifier used to reference the current invoice.", "type": "optional", "validation": { @@ -36892,17 +36816,14 @@ For detailed information regarding DIAN's tax schemes, please see their [officia }, "invoice_type": "optional", "link": { - "display-name": "🇲🇽 SAT Mexico", "docs": "The \`link.id\` the invoice belongs to.", "type": "optional", }, "payment_method": { - "display-name": "🇲🇽 SAT Mexico", "type": "optional", }, "payment_method_description": { "availability": "deprecated", - "display-name": "🇲🇽 SAT Mexico", "docs": "*This field has been deprecated.* *The description of the payment method used for this invoice.* @@ -36929,14 +36850,12 @@ For detailed information regarding DIAN's tax schemes, please see their [officia }, "payroll": "optional", "place_of_issue": { - "display-name": "🇲🇽 SAT Mexico", "docs": "The postcode of where the invoice was issued. ", "type": "optional", }, "receiver_blacklist_status": { "availability": "deprecated", - "display-name": "🇲🇽 SAT Mexico", "docs": "This field has been deprecated. Please use \`receiver_tax_fraud_status\` instead. ", "type": "optional", @@ -36950,7 +36869,6 @@ For detailed information regarding DIAN's tax schemes, please see their [officia "type": "optional", }, "receiver_tax_fraud_status": { - "display-name": "🇲🇽 SAT Mexico", "docs": "Indicates whether or not the receiver is on SAT's tax fraud list for having submitted incorrect data, having outstanding payments, or having conducted business that is in violation of the fiscal institution's regulations.

SAT updates the tax fraud list every three months.

For more information regarding the reason's a taxpayer can be put on the tax fraud list, please see [Article 69](http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69.html) and [Article 69-B](http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69B.html) of Mexico's Código Fiscal de la Federación.

@@ -36960,7 +36878,6 @@ Possible statuses are: }, "sender_blacklist_status": { "availability": "deprecated", - "display-name": "🇲🇽 SAT Mexico", "docs": "This field has been deprecated. Please use \`sender_tax_fraud_status\` instead. ", "type": "optional", @@ -36974,7 +36891,6 @@ Possible statuses are: "type": "optional", }, "sender_tax_fraud_status": { - "display-name": "🇲🇽 SAT Mexico", "docs": "Indicates whether or not the sender is on SAT's tax fraud list for having submitted incorrect data, having outstanding payments, or having conducted business that is in violation of the fiscal institution's regulations.

SAT updates the tax fraud list every three months.

For more information regarding the reason's a taxpayer can be put on the tax fraud list, please see [Article 69](http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69.html) and [Article 69-B](http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69B.html) of Mexico's Código Fiscal de la Federación.

@@ -37002,7 +36918,6 @@ Possible statuses are: }, "type": "optional", "usage": { - "display-name": "🇲🇽 SAT Mexico", "docs": "The invoice's usage code, as defined by the legal entity of the country. - 🇲🇽 Mexico [SAT catalog reference article](https://developers.belvo.com/docs/sat-catalogs#usage) @@ -37010,17 +36925,14 @@ Possible statuses are: "type": "optional", }, "version": { - "display-name": "🇲🇽 SAT Mexico", "docs": "The CFDI version of the invoice. ", "type": "optional", }, "warnings": { - "display-name": "🇲🇽 SAT Mexico", "type": "optional", }, "xml": { - "display-name": "🇲🇽 SAT Mexico", "docs": "XML of the invoice document. ", "type": "optional", @@ -37673,14 +37585,12 @@ A unique 44-character string that can be used to identify a user at a given inst - the user's account is either locked or the user does not have permission to access their internet banking.", "properties": { "code": { - "display-name": "Login Error", "docs": "A unique error code (\`login_error\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 login_error errors.", "type": "optional", }, "message": { - "display-name": "Login Error", "docs": "A short description of the error. For \`login_error\` errors, the description can be one of the following: @@ -37695,7 +37605,6 @@ For \`login_error\` errors, the description can be one of the following: "type": "optional", }, "request_id": { - "display-name": "Login Error", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -37756,12 +37665,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "open_finance_display_confirmation_required": { - "display-name": "OFPI - Display Confirmation Required", "type": "optional", }, "ready_to_confirm": { "default": true, - "display-name": "OFPI - Display Confirmation Required", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When set to \`true\`, you need to confirm the payment by making a PATCH request sending through \`confirm: true\`.", @@ -37776,12 +37683,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "pse_display_confirmation_required": { - "display-name": "Display PSE confirmation required", "type": "optional", }, "ready_to_confirm": { "default": true, - "display-name": "Display PSE confirmation required", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When the value is \`true\`, you'll need to make a PATCH request sending through \`confirm: true\` to confirm the payment.", @@ -37796,12 +37701,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "pse_display_credentials_required": { - "display-name": "Display PSE credentials required", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "Display PSE credentials required", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When the value is \`true\`, you'll need to make a PATCH request sending through \`confirm: true\` to confirm the payment.", @@ -37816,12 +37719,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "pse_display_customer_bank_accounts": { - "display-name": "Display PSE customer bank accounts", "type": "optional", }, "ready_to_confirm": { "default": true, - "display-name": "Display PSE customer bank accounts", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When the value is \`true\`, you'll need to make a PATCH request sending through \`confirm: true\` to confirm the payment.", @@ -37836,12 +37737,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "pse_display_needs_redirect": { - "display-name": "Display PSE needs redirect", "type": "optional", }, "ready_to_confirm": { "default": true, - "display-name": "Display PSE needs redirect", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When the value is \`true\`, you'll need to make a PATCH request sending through \`confirm: true\` to confirm the payment.", @@ -37856,12 +37755,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "open_finance_display_payment_failed": { - "display-name": "OFPI - Payment Failed", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "OFPI - Payment Failed", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When set to \`true\`,you need to confirm the payment by making a PATCH request sending through \`confirm: true\`.", @@ -37876,12 +37773,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "open_finance_display_payment_method_information": { - "display-name": "OFPI - Display Payment Method Information", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "OFPI - Display Payment Method Information", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When set to \`true\`, you need to confirm the payment by making a PATCH request sending through \`confirm: true\`.", @@ -37896,12 +37791,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type. You'll need to send a PATCH request with the institution selected by the customer or their bank accounts (if there are accounts already saved in the Belvo database).", "properties": { "pse_display_payment_method_information": { - "display-name": "Display PSE payment method information", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "Display PSE payment method information", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When the value is \`true\`, you'll need to make a PATCH request sending through \`confirm: true\` to confirm the payment.", @@ -37916,12 +37809,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "open_finance_display_payment_processing": { - "display-name": "OFPI - Payment Processing", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "OFPI - Payment Processing", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When set to \`true\`, you need to confirm the payment by making a PATCH request sending through \`confirm: true\`.", @@ -37936,12 +37827,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "open_finance_display_payment_succeeded": { - "display-name": "OFPI - Payment Succeeded", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "OFPI - Payment Succeeded", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When set to \`true\`, you need to confirm the payment by making a PATCH request sending through \`confirm: true\`.", @@ -37956,11 +37845,9 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "pse_display_token_required": { - "display-name": "Display PSE token required", "type": "optional", }, "ready_to_confirm": { - "display-name": "Display PSE token required", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. This value will return: - \`false\` when a customer wants to pay for the very first time. This is so because you still need to input information about your customer in the following steps to process a payment successfully. @@ -37979,12 +37866,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "open_finance_display_needs_redirect": { - "display-name": "OFPI - Needs Redirect", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "OFPI - Needs Redirect", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When set to \`true\`, you need to confirm the payment by making a PATCH request sending through \`confirm: true\`.", @@ -38023,14 +37908,12 @@ For \`login_error\` errors, the description can be one of the following: "docs": undefined, "properties": { "code": { - "display-name": "Not Found", "docs": "A unique error code (\`not_found\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 404 not_found errors.", "type": "optional", }, "message": { - "display-name": "Not Found", "docs": "A short description of the error. For \`not_found\` errors, the description is: @@ -38039,7 +37922,6 @@ For \`not_found\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Not Found", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -38068,7 +37950,6 @@ For \`not_found\` errors, the description is: }, }, "callback_url": { - "display-name": "OFPB", "docs": "The URL to your application that your customer will be directed to once they confirm the payment in their bank application.", "type": "optional", }, @@ -38081,7 +37962,6 @@ For \`not_found\` errors, the description is: "docs": "Details about the payment method.", "properties": { "open_finance": { - "display-name": "OFPI", "type": "optional", }, }, @@ -38348,7 +38228,6 @@ When set to \`false\`, the data won't be persisted and we return a 200 OK respon "docs": undefined, "properties": { "pse": { - "display-name": "PATCH payment method details", "type": "optional", }, }, @@ -38476,7 +38355,6 @@ When set to \`false\`, the data won't be persisted and we return a 200 OK respon }, "charges": { "availability": "deprecated", - "display-name": "Brazil 🇧🇷 OFPI", "docs": "An array of charge objects related to this paymnet intent. If no charges are associated, we return an empty array. **Note**: The charges resource will be deprecated and removed from our API by end of Q1 2023. We recommend not using any data from this resource.", @@ -38537,7 +38415,6 @@ When set to \`false\`, the data won't be persisted and we return a 200 OK respon "type": "LastErrorPaymentError", }, "metadata": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "Optional and customizable object where you can provide any additional key-value pairs for your internal purposes. For example, an internal reference number. ⚠️ **Note**: You can only provide up to 50 keys (keys can have up to 50 characters each and each value can be up to 500 characters). We do not support nested objects, only ASCII values.", @@ -38788,7 +38665,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "charges": { "availability": "deprecated", - "display-name": "Colombia 🇨🇴 PSE", "docs": "An array of charge objects related to this paymnet intent. If no charges are associated, we return an empty array. **Note**: The charges resource will be deprecated and removed from our API by end of Q1 2023. We recommend not using any data from this resource.", @@ -38846,7 +38722,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "last_error": "PaymentIntentPseLastError", "metadata": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "Optional and customizable object where you can provide any additional key-value pairs for your internal purposes. For example, an internal reference number. ⚠️ **Note**: You can only provide up to 50 keys (keys can have up to 50 characters each and each value can be up to 500 characters). We do not support nested objects, only ASCII values.", @@ -38948,14 +38823,12 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "cancel": { - "display-name": "Payment Link Callback URLs", "docs": "The URL that the user should be redirected to if they decide to cancel the payment process or if an error occurs. **Note:** Not required if your integration only generates payment links through the [Belvo Dashboard](https://dashboard.belvo.com/).", "type": "optional", }, "success": { - "display-name": "Payment Link Callback URLs", "docs": "The URL that the user should be redirected to when they complete the payment process successfully. **Note:** Not required if your integration only generates payment links through the [Belvo Dashboard](https://dashboard.belvo.com/).", @@ -38972,12 +38845,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p **Note:** This field will return an empty object if your integration only generates payment links through the [Belvo Dashboard](https://dashboard.belvo.com/).", "properties": { "cancel": { - "display-name": "Payment Link Callback URLs", "docs": "The URL that the user should be redirected to if they decide to cancel the payment process or if an error occurs.", "type": "optional", }, "success": { - "display-name": "Payment Link Callback URLs", "docs": "The URL that the user should be redirected to when they complete the payment process successfully.", "type": "optional", }, @@ -38990,7 +38861,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "access_token": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The Belvo-generated access token for the payment link. **Note:** You'll need the \`access_token\` to make [Get details for a payment link](https://developers.belvo.com/reference/detailcreatepaymentlink) requests.", @@ -39040,7 +38910,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "payment_intent": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "Belvo's unique ID for the payment intent. You can retrieve the complete payment intent by using our [Get details of a payment link](https://developers.belvo.com/reference/detailcreatepaymentlink) request.", "type": "optional", "validation": { @@ -39056,7 +38925,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "status": "EnumPaymentLinksStatus", "updated_at": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The ISO-8601 timestamp of when the payment link was last updated. ", "type": "optional", @@ -39070,7 +38938,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "access_token": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The Belvo-generated access token for the payment link. **Note:** You'll need the \`access_token\` to make [Get details for a payment link](https://developers.belvo.com/reference/detailcreatepaymentlink) requests.", @@ -39120,7 +38987,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "payment_intent": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "Belvo's unique ID for the payment intent. You can retrieve the complete payment intent by using our [Get details of a payment link](https://developers.belvo.com/reference/detailcreatepaymentlink) request.", "type": "optional", "validation": { @@ -39136,7 +39002,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "status": "EnumPaymentLinksStatus", "updated_at": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The ISO-8601 timestamp of when the payment link was last updated. ", "type": "optional", @@ -39150,7 +39015,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "access_token": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The Belvo-generated access token for the payment link. **Note:** You'll need the \`access_token\` to make [Get details for a payment link](https://developers.belvo.com/reference/detailcreatepaymentlink) requests.", @@ -39200,7 +39064,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "payment_intent": { - "display-name": "Brazil 🇧🇷 OFPI", "type": "optional", }, "payment_url": { @@ -39209,7 +39072,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "status": "EnumPaymentLinksStatus", "updated_at": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The ISO-8601 timestamp of when the payment link was last updated. ", "type": "optional", @@ -39268,7 +39130,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "access_token": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The Belvo-generated access token for the payment link. **Note:** You'll need the \`access_token\` to make [Get details for a payment link](https://developers.belvo.com/reference/detailcreatepaymentlink) requests.", @@ -39318,7 +39179,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "payment_intent": { - "display-name": "Colombia 🇨🇴 PSE", "type": "optional", }, "payment_url": { @@ -39327,7 +39187,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "status": "EnumPaymentLinksStatus", "updated_at": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The ISO-8601 timestamp of when the payment link was last updated. ", "type": "optional", @@ -39955,14 +39814,12 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Belvo has a limit regarding the time it takes to log in, retrieve account data, and log out. A timeout occurs when there is a very high amount of data and everything could not be obtained within the allotted time.", "properties": { "code": { - "display-name": "Request Timeout", "docs": "A unique error code (\`request_timeout\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 408 request_timeout errors.", "type": "optional", }, "message": { - "display-name": "Request Timeout", "docs": "A short description of the error. For \`request_timeout\` errors, the description is: @@ -39971,7 +39828,6 @@ For \`request_timeout\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Request Timeout", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -40517,14 +40373,12 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "This error occurs when you try to resume a request session that has already expired. This is usually because the user took too long to provide their authentication token.", "properties": { "code": { - "display-name": "Session Expired", "docs": "A unique error code (\`session_expired\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 session_expired errors.", "type": "optional", }, "message": { - "display-name": "Session Expired", "docs": "A short description of the error. For \`session_expired\` errors, the description is: @@ -40533,7 +40387,6 @@ For \`session_expired\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Session Expired", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -40800,12 +40653,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "count": { - "display-name": "Tax Declaration Business", "docs": "The total number of results in your Belvo account.", "type": "optional", }, "next": { - "display-name": "Tax Declaration Business", "docs": "The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is \`null\`. In our documentation example, we use \`{endpoint}\` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, \`accounts\` or \`owners\`). @@ -40813,12 +40664,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "previous": { - "display-name": "Tax Declaration Business", "docs": "The URL to the previous page of results. If there is no previous page, the value is \`null\`.", "type": "optional", }, "results": { - "display-name": "Tax Declaration Business", "docs": "Array of Business Tax Declaration objects.", "type": "optional>", }, @@ -40887,12 +40736,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "count": { - "display-name": "Tax Declaration Individual", "docs": "The total number of results in your Belvo account.", "type": "optional", }, "next": { - "display-name": "Tax Declaration Individual", "docs": "The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is \`null\`. In our documentation example, we use \`{endpoint}\` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, \`accounts\` or \`owners\`). @@ -40900,12 +40747,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "previous": { - "display-name": "Tax Declaration Individual", "docs": "The URL to the previous page of results. If there is no previous page, the value is \`null\`.", "type": "optional", }, "results": { - "display-name": "Tax Declaration Individual", "docs": "Array of Individual Tax Declaration objects.", "type": "optional>", }, @@ -41146,17 +40991,14 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional>", }, "created_at": { - "display-name": "Tax Return Business", "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", "type": "optional", }, "datos_adicionales": { - "display-name": "Tax Return Business", "docs": "Additional data regarding the tax return.", "type": "optional>", }, "deducciones_autorizadas": { - "display-name": "Tax Return Business", "docs": "Details regarding the legal entity's deductions.", "type": "optional>", }, @@ -41169,7 +41011,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional>", }, "dividendos_o_utilidades_distribuidos": { - "display-name": "Tax Return Business", "docs": "Details regarding distributed dividends.", "type": "optional>", }, @@ -41182,7 +41023,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional>", }, "id": { - "display-name": "Tax Return Business", "docs": "Unique identifier created by Belvo used to reference the current Tax Return.", "type": "optional", "validation": { @@ -41230,7 +41070,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "created_at": { - "display-name": "Tax Return Business Monthly", "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", "type": "optional", }, @@ -41251,7 +41090,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional>", }, "id": { - "display-name": "Tax Return Business Monthly", "docs": "Unique identifier created by Belvo used to reference the current Tax Return.", "type": "optional", "validation": { @@ -41276,7 +41114,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "receipt_pdf": { - "display-name": "Tax Return Business Monthly", "docs": "The acknowledgement receipt from the fiscal institution confirming that they received the tax return.", "type": "optional", "validation": { @@ -41304,12 +41141,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "created_at": { - "display-name": "Tax Return Personal", "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", "type": "optional", }, "datos_informativos": { - "display-name": "Tax Return Personal", "docs": "Extra informative data on the tax return.", "type": "optional>", }, @@ -41326,7 +41161,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional>", }, "id": { - "display-name": "Tax Return Personal", "docs": "Unique identifier created by Belvo used to reference the current Tax Return.", "type": "optional", "validation": { @@ -41341,7 +41175,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional>", }, "link": { - "display-name": "Tax Return Personal", "docs": "The \`link.id\` the statement belongs to", "type": "optional", "validation": { @@ -41397,12 +41230,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "created_at": { - "display-name": "Tax Return Personal Monthly", "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", "type": "optional", }, "id": { - "display-name": "Tax Return Personal Monthly", "docs": "Unique identifier created by Belvo used to reference the current Tax Return.", "type": "optional", "validation": { @@ -41435,7 +41266,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "receipt_pdf": { - "display-name": "Tax Return Personal Monthly", "docs": "The acknowledgement receipt from the fiscal institution confirming that they received the tax return.", "type": "optional", "validation": { @@ -41459,12 +41289,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "extra-properties": true, "properties": { "count": { - "display-name": "Tax Return Personal Business Monthly", "docs": "The total number of results in your Belvo account.", "type": "optional", }, "next": { - "display-name": "Tax Return Personal Business Monthly", "docs": "The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is \`null\`. In our documentation example, we use \`{endpoint}\` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, \`accounts\` or \`owners\`). @@ -41472,12 +41300,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "previous": { - "display-name": "Tax Return Personal Business Monthly", "docs": "The URL to the previous page of results. If there is no previous page, the value is \`null\`.", "type": "optional", }, "results": { - "display-name": "Tax Return Personal Business Monthly", "docs": "Array of Monthly Business Tax Return objects.", "type": "optional>", }, @@ -41491,12 +41317,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "extra-properties": true, "properties": { "count": { - "display-name": "Tax Return Personal Business", "docs": "The total number of results in your Belvo account.", "type": "optional", }, "next": { - "display-name": "Tax Return Personal Business", "docs": "The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is \`null\`. In our documentation example, we use \`{endpoint}\` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, \`accounts\` or \`owners\`). @@ -41504,12 +41328,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "previous": { - "display-name": "Tax Return Personal Business", "docs": "The URL to the previous page of results. If there is no previous page, the value is \`null\`.", "type": "optional", }, "results": { - "display-name": "Tax Return Personal Business", "docs": "Array of Business Tax Return objects.", "type": "optional>", }, @@ -41523,7 +41345,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "properties": { "attach_pdf": { "default": false, - "display-name": "Monthly Tax Returns", "docs": "When this is set to \`true\`, you will receive the PDF as a binary string in the response.", "type": "optional", }, @@ -41551,7 +41372,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "save_data": { "default": true, - "display-name": "Monthly Tax Returns", "docs": "Indicates whether or not to persist the data in Belvo. By default, this is set to \`true\` and we return a 201 Created response. When set to \`false\`, the data won't be persisted and we return a 200 OK response.", "type": "optional", @@ -41572,12 +41392,10 @@ When set to \`false\`, the data won't be persisted and we return a 200 OK respon "extra-properties": true, "properties": { "count": { - "display-name": "Tax Return Personal Monthly", "docs": "The total number of results in your Belvo account.", "type": "optional", }, "next": { - "display-name": "Tax Return Personal Monthly", "docs": "The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is \`null\`. In our documentation example, we use \`{endpoint}\` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, \`accounts\` or \`owners\`). @@ -41585,12 +41403,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "previous": { - "display-name": "Tax Return Personal Monthly", "docs": "The URL to the previous page of results. If there is no previous page, the value is \`null\`.", "type": "optional", }, "results": { - "display-name": "Tax Return Personal Monthly", "docs": "Array of Monthly Personal Tax Return objects.", "type": "optional>", }, @@ -41604,12 +41420,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "extra-properties": true, "properties": { "count": { - "display-name": "Tax Return Personal", "docs": "The total number of results in your Belvo account.", "type": "optional", }, "next": { - "display-name": "Tax Return Personal", "docs": "The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is \`null\`. In our documentation example, we use \`{endpoint}\` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, \`accounts\` or \`owners\`). @@ -41617,12 +41431,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "previous": { - "display-name": "Tax Return Personal", "docs": "The URL to the previous page of results. If there is no previous page, the value is \`null\`.", "type": "optional", }, "results": { - "display-name": "Tax Return Personal", "docs": "Array of Personal Tax Return objects.", "type": "optional>", }, @@ -41636,7 +41448,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "properties": { "attach_pdf": { "default": false, - "display-name": "Yearly Tax Returns", "docs": "When this is set to \`true\`, you will receive the PDF as a binary string in the response.", "type": "optional", }, @@ -41652,7 +41463,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "save_data": { "default": true, - "display-name": "Yearly Tax Returns", "docs": "Indicates whether or not to persist the data in Belvo. By default, this is set to \`true\` and we return a 201 Created response. When set to \`false\`, the data won't be persisted and we return a 200 OK response.", "type": "optional", @@ -42525,14 +42335,12 @@ You will still need to make a PATCH call to complete the request.", - you make a request for information while Belvo is scraping data from the institution for that user.", "properties": { "code": { - "display-name": "Too Many Sessions", "docs": "A unique error code (\`too_many_sessions\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 too_many_sessions errors.", "type": "optional", }, "message": { - "display-name": "Too Many Sessions", "docs": "A short description of the error. For \`too_many_sessions\` errors, the description is: @@ -42541,7 +42349,6 @@ For \`too_many_sessions\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Too Many Sessions", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -42657,7 +42464,6 @@ For \`too_many_sessions\` errors, the description is: "docs": "Information about the payer's bank account. Belvo returns the bank account ID when the account is already saved in the Belvo database.", "properties": { "bank_account": { - "display-name": "Bank account PSE", "docs": "Belvo's unique identifier for the payer’s bank account.", "type": "optional", "validation": { @@ -42673,7 +42479,6 @@ For \`too_many_sessions\` errors, the description is: }, }, "TransactionBankAccountOfpi": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "Object containing the payer's bank account information. For OFPI, this field will return an empty object.", "type": "map", }, @@ -42842,14 +42647,12 @@ When set to \`false\`, the data won't be persisted and we return a 200 OK respon "docs": "This error occurs when you try to make an API call using incorrect Belvo API credentials (either your secret key or secret password, or both, are incorrect).", "properties": { "code": { - "display-name": "Unauthorized Error", "docs": "A unique error code (\`authentication_failed\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 401 authentication_failed errors.", "type": "optional", }, "message": { - "display-name": "Unauthorized Error", "docs": "A short description of the error. For \`authentication_failed\` errors, the description is: @@ -42858,7 +42661,6 @@ For \`authentication_failed\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Unauthorized Error", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -42878,14 +42680,12 @@ For \`authentication_failed\` errors, the description is: A Link's status is set to \`unconfirmed_link\` when your user has not completed the Link creation process successfully (for example, they might not provide a valid MFA token).", "properties": { "code": { - "display-name": "Unconfirmed Link", "docs": "A unique error code (\`unconfirmed_link\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 unconfirmed_link errors.", "type": "optional", }, "message": { - "display-name": "Unconfirmed Link", "docs": "A short description of the error. For \`unconfirmed_link\` errors, the description is: @@ -42894,7 +42694,6 @@ For \`unconfirmed_link\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Unconfirmed Link", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -42913,14 +42712,12 @@ For \`unconfirmed_link\` errors, the description is: "docs": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.", "properties": { "code": { - "display-name": "Unexpected Error", "docs": "A unique error code (\`unexpected_error\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 500 unexpected_error errors.", "type": "optional", }, "message": { - "display-name": "Unexpected Error", "docs": "A short description of the error. For \`unexpected_error\` errors, the description is: @@ -42929,7 +42726,6 @@ For \`unexpected_error\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Unexpected Error", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -42948,14 +42744,12 @@ For \`unexpected_error\` errors, the description is: "docs": "This error occurs when you try to access some data operation that Belvo does not support for an institution. For example, trying to access the Balances resource for fiscal institutions.", "properties": { "code": { - "display-name": "Unsupported Operation", "docs": "A unique error code (\`unsupported_operation\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 unsupported_operation errors.", "type": "optional", }, "message": { - "display-name": "Unsupported Operation", "docs": "A short description of the error. For \`unsupported_operation\` errors, the description is: @@ -42964,7 +42758,6 @@ For \`unsupported_operation\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Unsupported Operation", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -42983,7 +42776,6 @@ For \`unsupported_operation\` errors, the description is: "docs": "This error occurs when you try to resume a request session that has already expired. This is usually because the user took too long to provide their authentication token.", "properties": { "code": { - "display-name": "Validation Error", "docs": "A unique error code (\`null\`, \`does_not_exist\`, \`required\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle: @@ -42994,12 +42786,10 @@ For \`unsupported_operation\` errors, the description is: "type": "optional", }, "field": { - "display-name": "Validation Error", "docs": "Name of the field where the error was encountered.", "type": "optional", }, "message": { - "display-name": "Validation Error", "docs": "A short description of the error. For \`session_expired\` errors, the description can be (among others): @@ -43011,7 +42801,6 @@ For \`session_expired\` errors, the description can be (among others): "type": "optional", }, "request_id": { - "display-name": "Validation Error", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -58017,7 +57806,6 @@ A payment intent captures all payment information (such as the amount to be char "type": "string", }, "metadata": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "Optional and customizable object where you can provide any additional key-value pairs for your internal purposes. For example, an internal reference number for the payment intent. ⚠️ **Note**: You can only provide up to 50 keys (keys can have up to 50 characters each and each value can be up to 500 characters). We do not support nested objects, only ASCII values.", @@ -63410,7 +63198,6 @@ client.connect() "properties": { "attach_pdf": { "default": false, - "display-name": "Tax Declarations", "docs": "When this is set to \`true\`, you will receive the PDF as a binary string in the response.", "type": "optional", }, @@ -63426,7 +63213,6 @@ client.connect() }, "save_data": { "default": true, - "display-name": "Tax Declarations", "docs": "Indicates whether or not to persist the data in Belvo. By default, this is set to \`true\` and we return a 201 Created response. When set to \`false\`, the data won't be persisted and we return a 200 OK response.", "type": "optional", @@ -73136,14 +72922,12 @@ client.connect() "docs": "This error occurs when you try to access Belvo's resource without the correct permissions.", "properties": { "code": { - "display-name": "Access to Belvo API denied", "docs": "A unique error code (\`access_to_resource_denied\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 403 access_to_resource_denied.", "type": "optional", }, "message": { - "display-name": "Access to Belvo API denied", "docs": "A short description of the error. For \`access_to_resource_denied\` errors, the description is: @@ -73152,7 +72936,6 @@ For \`access_to_resource_denied\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Access to Belvo API denied", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -73954,7 +73737,6 @@ For \`BUSINESS\` bank accounts that Belvo creates for organizations, this field }, }, "metadata": { - "display-name": "Business Bank Account", "docs": "Optional and customizable object where you can provide any additional key-value pairs for your internal purposes. For example, an internal reference number for the payment intent. ⚠️ **Note**: You can only provide up to 50 keys (keys can have up to 50 characters each and each value can be up to 500 characters). We do not support nested objects, only ASCII values.", @@ -74072,7 +73854,6 @@ For \`BUSINESS\` bank accounts that Belvo creates for organizations, this field "docs": "Information about the payer's bank account. Belvo returns this object when the payer's bank account information is not saved in the Belvo database.", "properties": { "bank_account_information": { - "display-name": "Bank account information PSE", "type": "optional", }, }, @@ -74221,7 +74002,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "details": { - "display-name": "Beneficiary Bank Account", "type": "optional", }, "holder": { @@ -74266,11 +74046,9 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "holder": { - "display-name": "Beneficiary Bank Account PSE", "type": "optional", }, "id": { - "display-name": "Beneficiary Bank Account PSE", "docs": "Belvo's unique ID for the beneficiary bank account.", "type": "optional", "validation": { @@ -74281,7 +74059,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "institution": { - "display-name": "Beneficiary Bank Account PSE", "docs": "Belvo's unique ID for the institution that the bank account is created in.", "type": "optional", "validation": { @@ -74292,7 +74069,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "number": { - "display-name": "Beneficiary Bank Account PSE", "docs": "The bank account number.", "type": "optional", }, @@ -74305,7 +74081,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Details regarding the business bank account holder.", "properties": { "Information": { - "display-name": "Business", "type": "optional", }, "type": "EnumBankAccountHolderTypePse", @@ -74713,7 +74488,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "PSE", }, "metadata": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "Optional and customizable object where you can provide any additional key-value pairs for your internal purposes. For example, an internal reference number for the payment intent. ⚠️ **Note**: You can only provide up to 50 keys (keys can have up to 50 characters each and each value can be up to 500 characters). We do not support nested objects, only ASCII values.", @@ -74738,7 +74512,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "address": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The customer's physical address. ", "type": "optional", @@ -74774,7 +74547,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "phone": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The customer's phone number. ", "type": "optional", @@ -74788,7 +74560,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "address": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The customer's physical address. ", "type": "optional", @@ -74824,7 +74595,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "phone": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The customer's phone number. ", "type": "optional", @@ -74849,7 +74619,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "CreatePaymentLinkOfpiAmount", }, "callback_urls": { - "display-name": "Brazil 🇧🇷 OFPI", "type": "optional", }, "customer": { @@ -74864,7 +74633,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "expires_in": { "default": "7d", - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The payment link expiration time. It allows the following formats to be sent through: - whole number + \`m\` for x amount of minutes. For example: \`15m\` for 15 minutes. @@ -74917,7 +74685,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "allowed_payment_method_types": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "A list of payment method types allowed in this payment intent. For PSE, this value must be set to \`pse\`.", "type": "optional>", }, @@ -74929,7 +74696,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "CreatePaymentLinkPseAmount", }, "callback_urls": { - "display-name": "Colombia 🇨🇴 PSE", "type": "optional", }, "customer": { @@ -74944,7 +74710,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "expires_in": { "default": "7d", - "display-name": "Colombia 🇨🇴 PSE", "docs": "The payment link expiration time. It allows the following formats to be sent through: - whole number + \`m\` for x amount of minutes. For example: \`15m\` for 15 minutes. @@ -74997,7 +74762,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "address": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The customers physical address. ", "type": "optional", @@ -75057,7 +74821,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "phone": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The customer's phone number. ", "type": "optional", @@ -75116,7 +74879,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "address": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The customers physical address. @@ -75179,7 +74941,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "phone": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The customer's phone number. @@ -75196,7 +74957,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "payer_institution": { - "display-name": "Display PSE Colombia confirmation required.", "type": "optional", }, }, @@ -75208,20 +74968,16 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "beneficiary_bank_account": { - "display-name": "Display Open Finance Brazil confirmation required", "type": "optional", }, "payer_identifier": { - "display-name": "Display Open Finance Brazil confirmation required", "docs": "The payer's ID.", "type": "optional", }, "payer_institution": { - "display-name": "Display Open Finance Brazil confirmation required", "type": "optional", }, "payer_name": { - "display-name": "Display Open Finance Brazil confirmation required", "docs": "The name of the payer.", "type": "optional", }, @@ -75234,7 +74990,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Object containing form fields for the required credentials (for example, \`username\` or \`password\`) in this step.", "properties": { "payer_institution": { - "display-name": "Display PSE confirmation required", "type": "optional", }, }, @@ -75246,11 +75001,9 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Object detailing what payment method information you need to display.", "properties": { "beneficiary_bank_account": { - "display-name": "Display PSE payment method information", "type": "optional", }, "customer_bank_accounts": { - "display-name": "Display PSE payment method information", "docs": "Array of customer bank account objects.", "type": "optional>", }, @@ -75272,7 +75025,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Object detailing what payment method information you need to display.", "properties": { "institutions": { - "display-name": "Display Open Finance Brazil payment method information", "docs": "An array of institution objects.", "type": "optional>", }, @@ -75285,14 +75037,12 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Object detailing what payment method information you need to display.", "properties": { "customer_bank_accounts": { - "display-name": "Display PSE payment method information", "docs": "Array of bank account objects. **Note**: If there are no customer accounts saved in the Belvo database, we return an empty array.", "type": "optional>", }, "institutions": { - "display-name": "Display PSE payment method information", "docs": "An array of institution objects.", "type": "optional>", }, @@ -77360,14 +77110,12 @@ Please see our [Institutions](https://developers.belvo.com/docs/institution) Dev "docs": "This error occurs when the institution's website that you're trying to access is down due to maintenance or other issues, which means Belvo is unable to create new links or retrieve new data.", "properties": { "code": { - "display-name": "Institution Down", "docs": "A unique error code (\`institution_down\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 institution_down errors.", "type": "optional", }, "message": { - "display-name": "Institution Down", "docs": "A short description of the error. For \`institution_down\` errors, the description is: @@ -77376,7 +77124,6 @@ For \`institution_down\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Institution Down", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -77443,14 +77190,12 @@ For \`institution_down\` errors, the description is: "docs": "This error occurs when we (Belvo) have deactivated the institution in our API.", "properties": { "code": { - "display-name": "Institution Inactive", "docs": "A unique error code (\`institution_inactive\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 institution_inactive errors.", "type": "optional", }, "message": { - "display-name": "Institution Inactive", "docs": "A short description of the error. For \`institution_inactive\` errors, the description is: @@ -77459,7 +77204,6 @@ For \`institution_inactive\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Institution Inactive", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -77478,14 +77222,12 @@ For \`institution_inactive\` errors, the description is: "docs": "This error occurs when the institution's website that you're trying to access is down due to maintenance or other issues, which means Belvo is unable to create new links or retrieve new data.", "properties": { "code": { - "display-name": "Institution Unavailable", "docs": "A unique error code (\`institution_unavailable\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how handle 400 institution_unavailable errors.", "type": "optional", }, "message": { - "display-name": "Institution Unavailable", "docs": "A short description of the error. For \`institution_unavailable\` errors, the description is: @@ -77494,7 +77236,6 @@ For \`institution_unavailable\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Institution Unavailable", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -77628,14 +77369,12 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "This error occurs when you try to update a link from single to recurrent, but there are no login credentials stored for the user.", "properties": { "code": { - "display-name": "Invalid Access Mode", "docs": "A unique error code (\`invalid_access_mode_switch\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 invalid_access_mode_switch errors.", "type": "optional", }, "message": { - "display-name": "Invalid Access Mode", "docs": "A short description of the error. For \`invalid_access_mode_switch\` errors, the description is: @@ -77644,7 +77383,6 @@ For \`invalid_access_mode_switch\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Invalid Access Mode", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -77663,14 +77401,12 @@ For \`invalid_access_mode_switch\` errors, the description is: "docs": "This error occurs when you try to access an account but the user credentials are no longer valid, prompting an error from the institution.", "properties": { "code": { - "display-name": "Invalid Link", "docs": "A unique error code (\`invalid_link\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 invalid_link errors.", "type": "optional", }, "message": { - "display-name": "Invalid Link", "docs": "A short description of the error. For \`invalid_link\` errors, the description is: @@ -77679,7 +77415,6 @@ For \`invalid_link\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Invalid Link", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -77698,14 +77433,12 @@ For \`invalid_link\` errors, the description is: "docs": "This error occurs when you request incomes for a link within a given date range, however, the period between \`date_from\` and \`date_to\` is less than 90 days.", "properties": { "code": { - "display-name": "Invalid Period", "docs": "A unique error code (\`invalid_period\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 invalid_period errors.", "type": "optional", }, "message": { - "display-name": "Invalid Period", "docs": "A short description of the error. For \`invalid_period\` errors, the description is: @@ -77714,7 +77447,6 @@ For \`invalid_period\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Invalid Period", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -78173,7 +77905,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "created_at": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", "type": "optional", }, @@ -78198,7 +77929,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "expiration_date": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "Indicates when the invoice is set to expire. For example: If the invoice is paid in installments, this field indicates the date when the installment is to be paid. @@ -78212,13 +77942,11 @@ For example: If the invoice is paid in installments, this field indicates the da }, }, "folio": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "**Note**: This field is not applicable for DIAN Colombia and will return \`null\`. ", "type": "optional", }, "id": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "Belvo's unique identifier for the current invoice.", "type": "optional", "validation": { @@ -78249,17 +77977,14 @@ For example: If the invoice is paid in installments, this field indicates the da }, "invoice_type": "optional", "link": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "The \`link.id\` the invoice belongs to.", "type": "optional", }, "payment_method": { - "display-name": "🇨🇴 DIAN Colombia", "type": "optional", }, "payment_method_description": { "availability": "deprecated", - "display-name": "🇨🇴 DIAN Colombia", "docs": "The description of the payment method used for this invoice. ", "type": "optional", @@ -78283,13 +78008,11 @@ For detailed information regarding DIAN's payment types, please see their [offic }, "payroll": "optional", "place_of_issue": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "**Note**: This field is not applicable for DIAN Colombia and will return \`null\`. ", "type": "optional", }, "receiver_details": { - "display-name": "🇨🇴 DIAN Colombia", "type": "optional", }, "receiver_id": { @@ -78301,12 +78024,10 @@ For detailed information regarding DIAN's payment types, please see their [offic "type": "optional", }, "receiver_tax_fraud_status": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "**Note**: This field is not applicable for DIAN Colombia and will return \`null\`.", "type": "optional", }, "sender_details": { - "display-name": "🇨🇴 DIAN Colombia", "type": "optional", }, "sender_id": { @@ -78318,7 +78039,6 @@ For detailed information regarding DIAN's payment types, please see their [offic "type": "optional", }, "sender_tax_fraud_status": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "Indicates whether or not the sender is on a tax fraud list for having submitted incorrect data, having outstanding payments, or having conducted business that is in violation of the fiscal institution's regulations. **Note**: This field is not applicable for DIAN Colombia and will return \`null\`.", "type": "optional", @@ -78347,23 +78067,19 @@ For detailed information regarding DIAN's payment types, please see their [offic }, "type": "optional", "usage": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "**Note**: This field is not applicable for DIAN Colombia and will return \`null\`. ", "type": "optional", }, "version": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "**Note**: This field is not applicable for DIAN Colombia and will return \`null\`. ", "type": "optional", }, "warnings": { - "display-name": "🇨🇴 DIAN Colombia", "type": "optional", }, "xml": { - "display-name": "🇨🇴 DIAN Colombia", "docs": "**Note**: This field is not applicable for DIAN Colombia and will return \`null\`. ", "type": "optional", @@ -78505,7 +78221,6 @@ For detailed information regarding DIAN's tax schemes, please see their [officia "type": "optional", }, "created_at": { - "display-name": "🇲🇽 SAT Mexico", "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", "type": "optional", }, @@ -78530,13 +78245,11 @@ For detailed information regarding DIAN's tax schemes, please see their [officia "type": "optional", }, "folio": { - "display-name": "🇲🇽 SAT Mexico", "docs": "The internal control number that the taxpayer assigns to the invoice. ", "type": "optional", }, "id": { - "display-name": "🇲🇽 SAT Mexico", "docs": "Belvo's unique identifier used to reference the current invoice.", "type": "optional", "validation": { @@ -78567,17 +78280,14 @@ For detailed information regarding DIAN's tax schemes, please see their [officia }, "invoice_type": "optional", "link": { - "display-name": "🇲🇽 SAT Mexico", "docs": "The \`link.id\` the invoice belongs to.", "type": "optional", }, "payment_method": { - "display-name": "🇲🇽 SAT Mexico", "type": "optional", }, "payment_method_description": { "availability": "deprecated", - "display-name": "🇲🇽 SAT Mexico", "docs": "*This field has been deprecated.* *The description of the payment method used for this invoice.* @@ -78604,14 +78314,12 @@ For detailed information regarding DIAN's tax schemes, please see their [officia }, "payroll": "optional", "place_of_issue": { - "display-name": "🇲🇽 SAT Mexico", "docs": "The postcode of where the invoice was issued. ", "type": "optional", }, "receiver_blacklist_status": { "availability": "deprecated", - "display-name": "🇲🇽 SAT Mexico", "docs": "This field has been deprecated. Please use \`receiver_tax_fraud_status\` instead. ", "type": "optional", @@ -78625,7 +78333,6 @@ For detailed information regarding DIAN's tax schemes, please see their [officia "type": "optional", }, "receiver_tax_fraud_status": { - "display-name": "🇲🇽 SAT Mexico", "docs": "Indicates whether or not the receiver is on SAT's tax fraud list for having submitted incorrect data, having outstanding payments, or having conducted business that is in violation of the fiscal institution's regulations.

SAT updates the tax fraud list every three months.

For more information regarding the reason's a taxpayer can be put on the tax fraud list, please see [Article 69](http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69.html) and [Article 69-B](http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69B.html) of Mexico's Código Fiscal de la Federación.

@@ -78635,7 +78342,6 @@ Possible statuses are: }, "sender_blacklist_status": { "availability": "deprecated", - "display-name": "🇲🇽 SAT Mexico", "docs": "This field has been deprecated. Please use \`sender_tax_fraud_status\` instead. ", "type": "optional", @@ -78649,7 +78355,6 @@ Possible statuses are: "type": "optional", }, "sender_tax_fraud_status": { - "display-name": "🇲🇽 SAT Mexico", "docs": "Indicates whether or not the sender is on SAT's tax fraud list for having submitted incorrect data, having outstanding payments, or having conducted business that is in violation of the fiscal institution's regulations.

SAT updates the tax fraud list every three months.

For more information regarding the reason's a taxpayer can be put on the tax fraud list, please see [Article 69](http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69.html) and [Article 69-B](http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69B.html) of Mexico's Código Fiscal de la Federación.

@@ -78677,7 +78382,6 @@ Possible statuses are: }, "type": "optional", "usage": { - "display-name": "🇲🇽 SAT Mexico", "docs": "The invoice's usage code, as defined by the legal entity of the country. - 🇲🇽 Mexico [SAT catalog reference article](https://developers.belvo.com/docs/sat-catalogs#usage) @@ -78685,17 +78389,14 @@ Possible statuses are: "type": "optional", }, "version": { - "display-name": "🇲🇽 SAT Mexico", "docs": "The CFDI version of the invoice. ", "type": "optional", }, "warnings": { - "display-name": "🇲🇽 SAT Mexico", "type": "optional", }, "xml": { - "display-name": "🇲🇽 SAT Mexico", "docs": "XML of the invoice document. ", "type": "optional", @@ -79348,14 +79049,12 @@ A unique 44-character string that can be used to identify a user at a given inst - the user's account is either locked or the user does not have permission to access their internet banking.", "properties": { "code": { - "display-name": "Login Error", "docs": "A unique error code (\`login_error\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 login_error errors.", "type": "optional", }, "message": { - "display-name": "Login Error", "docs": "A short description of the error. For \`login_error\` errors, the description can be one of the following: @@ -79370,7 +79069,6 @@ For \`login_error\` errors, the description can be one of the following: "type": "optional", }, "request_id": { - "display-name": "Login Error", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -79431,12 +79129,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "open_finance_display_confirmation_required": { - "display-name": "OFPI - Display Confirmation Required", "type": "optional", }, "ready_to_confirm": { "default": true, - "display-name": "OFPI - Display Confirmation Required", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When set to \`true\`, you need to confirm the payment by making a PATCH request sending through \`confirm: true\`.", @@ -79451,12 +79147,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "pse_display_confirmation_required": { - "display-name": "Display PSE confirmation required", "type": "optional", }, "ready_to_confirm": { "default": true, - "display-name": "Display PSE confirmation required", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When the value is \`true\`, you'll need to make a PATCH request sending through \`confirm: true\` to confirm the payment.", @@ -79471,12 +79165,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "pse_display_credentials_required": { - "display-name": "Display PSE credentials required", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "Display PSE credentials required", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When the value is \`true\`, you'll need to make a PATCH request sending through \`confirm: true\` to confirm the payment.", @@ -79491,12 +79183,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "pse_display_customer_bank_accounts": { - "display-name": "Display PSE customer bank accounts", "type": "optional", }, "ready_to_confirm": { "default": true, - "display-name": "Display PSE customer bank accounts", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When the value is \`true\`, you'll need to make a PATCH request sending through \`confirm: true\` to confirm the payment.", @@ -79511,12 +79201,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "pse_display_needs_redirect": { - "display-name": "Display PSE needs redirect", "type": "optional", }, "ready_to_confirm": { "default": true, - "display-name": "Display PSE needs redirect", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When the value is \`true\`, you'll need to make a PATCH request sending through \`confirm: true\` to confirm the payment.", @@ -79531,12 +79219,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "open_finance_display_payment_failed": { - "display-name": "OFPI - Payment Failed", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "OFPI - Payment Failed", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When set to \`true\`,you need to confirm the payment by making a PATCH request sending through \`confirm: true\`.", @@ -79551,12 +79237,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "open_finance_display_payment_method_information": { - "display-name": "OFPI - Display Payment Method Information", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "OFPI - Display Payment Method Information", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When set to \`true\`, you need to confirm the payment by making a PATCH request sending through \`confirm: true\`.", @@ -79571,12 +79255,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type. You'll need to send a PATCH request with the institution selected by the customer or their bank accounts (if there are accounts already saved in the Belvo database).", "properties": { "pse_display_payment_method_information": { - "display-name": "Display PSE payment method information", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "Display PSE payment method information", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When the value is \`true\`, you'll need to make a PATCH request sending through \`confirm: true\` to confirm the payment.", @@ -79591,12 +79273,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "open_finance_display_payment_processing": { - "display-name": "OFPI - Payment Processing", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "OFPI - Payment Processing", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When set to \`true\`, you need to confirm the payment by making a PATCH request sending through \`confirm: true\`.", @@ -79611,12 +79291,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "open_finance_display_payment_succeeded": { - "display-name": "OFPI - Payment Succeeded", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "OFPI - Payment Succeeded", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When set to \`true\`, you need to confirm the payment by making a PATCH request sending through \`confirm: true\`.", @@ -79631,11 +79309,9 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "pse_display_token_required": { - "display-name": "Display PSE token required", "type": "optional", }, "ready_to_confirm": { - "display-name": "Display PSE token required", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. This value will return: - \`false\` when a customer wants to pay for the very first time. This is so because you still need to input information about your customer in the following steps to process a payment successfully. @@ -79654,12 +79330,10 @@ For \`login_error\` errors, the description can be one of the following: "docs": "Object detailing the next steps you should follow for a specific \`next_step\` type.", "properties": { "open_finance_display_needs_redirect": { - "display-name": "OFPI - Needs Redirect", "type": "optional", }, "ready_to_confirm": { "default": false, - "display-name": "OFPI - Needs Redirect", "docs": "Boolean that indicates whether the payment intent is ready to be confirmed. **Note:** When set to \`true\`, you need to confirm the payment by making a PATCH request sending through \`confirm: true\`.", @@ -79698,14 +79372,12 @@ For \`login_error\` errors, the description can be one of the following: "docs": undefined, "properties": { "code": { - "display-name": "Not Found", "docs": "A unique error code (\`not_found\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 404 not_found errors.", "type": "optional", }, "message": { - "display-name": "Not Found", "docs": "A short description of the error. For \`not_found\` errors, the description is: @@ -79714,7 +79386,6 @@ For \`not_found\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Not Found", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -79743,7 +79414,6 @@ For \`not_found\` errors, the description is: }, }, "callback_url": { - "display-name": "OFPB", "docs": "The URL to your application that your customer will be directed to once they confirm the payment in their bank application.", "type": "optional", }, @@ -79756,7 +79426,6 @@ For \`not_found\` errors, the description is: "docs": "Details about the payment method.", "properties": { "open_finance": { - "display-name": "OFPI", "type": "optional", }, }, @@ -80023,7 +79692,6 @@ When set to \`false\`, the data won't be persisted and we return a 200 OK respon "docs": undefined, "properties": { "pse": { - "display-name": "PATCH payment method details", "type": "optional", }, }, @@ -80151,7 +79819,6 @@ When set to \`false\`, the data won't be persisted and we return a 200 OK respon }, "charges": { "availability": "deprecated", - "display-name": "Brazil 🇧🇷 OFPI", "docs": "An array of charge objects related to this paymnet intent. If no charges are associated, we return an empty array. **Note**: The charges resource will be deprecated and removed from our API by end of Q1 2023. We recommend not using any data from this resource.", @@ -80212,7 +79879,6 @@ When set to \`false\`, the data won't be persisted and we return a 200 OK respon "type": "LastErrorPaymentError", }, "metadata": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "Optional and customizable object where you can provide any additional key-value pairs for your internal purposes. For example, an internal reference number. ⚠️ **Note**: You can only provide up to 50 keys (keys can have up to 50 characters each and each value can be up to 500 characters). We do not support nested objects, only ASCII values.", @@ -80463,7 +80129,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "charges": { "availability": "deprecated", - "display-name": "Colombia 🇨🇴 PSE", "docs": "An array of charge objects related to this paymnet intent. If no charges are associated, we return an empty array. **Note**: The charges resource will be deprecated and removed from our API by end of Q1 2023. We recommend not using any data from this resource.", @@ -80521,7 +80186,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "last_error": "PaymentIntentPseLastError", "metadata": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "Optional and customizable object where you can provide any additional key-value pairs for your internal purposes. For example, an internal reference number. ⚠️ **Note**: You can only provide up to 50 keys (keys can have up to 50 characters each and each value can be up to 500 characters). We do not support nested objects, only ASCII values.", @@ -80623,14 +80287,12 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "cancel": { - "display-name": "Payment Link Callback URLs", "docs": "The URL that the user should be redirected to if they decide to cancel the payment process or if an error occurs. **Note:** Not required if your integration only generates payment links through the [Belvo Dashboard](https://dashboard.belvo.com/).", "type": "optional", }, "success": { - "display-name": "Payment Link Callback URLs", "docs": "The URL that the user should be redirected to when they complete the payment process successfully. **Note:** Not required if your integration only generates payment links through the [Belvo Dashboard](https://dashboard.belvo.com/).", @@ -80647,12 +80309,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p **Note:** This field will return an empty object if your integration only generates payment links through the [Belvo Dashboard](https://dashboard.belvo.com/).", "properties": { "cancel": { - "display-name": "Payment Link Callback URLs", "docs": "The URL that the user should be redirected to if they decide to cancel the payment process or if an error occurs.", "type": "optional", }, "success": { - "display-name": "Payment Link Callback URLs", "docs": "The URL that the user should be redirected to when they complete the payment process successfully.", "type": "optional", }, @@ -80665,7 +80325,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "access_token": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The Belvo-generated access token for the payment link. **Note:** You'll need the \`access_token\` to make [Get details for a payment link](https://developers.belvo.com/reference/detailcreatepaymentlink) requests.", @@ -80715,7 +80374,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "payment_intent": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "Belvo's unique ID for the payment intent. You can retrieve the complete payment intent by using our [Get details of a payment link](https://developers.belvo.com/reference/detailcreatepaymentlink) request.", "type": "optional", "validation": { @@ -80731,7 +80389,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "status": "EnumPaymentLinksStatus", "updated_at": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The ISO-8601 timestamp of when the payment link was last updated. ", "type": "optional", @@ -80745,7 +80402,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "access_token": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The Belvo-generated access token for the payment link. **Note:** You'll need the \`access_token\` to make [Get details for a payment link](https://developers.belvo.com/reference/detailcreatepaymentlink) requests.", @@ -80795,7 +80451,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "payment_intent": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "Belvo's unique ID for the payment intent. You can retrieve the complete payment intent by using our [Get details of a payment link](https://developers.belvo.com/reference/detailcreatepaymentlink) request.", "type": "optional", "validation": { @@ -80811,7 +80466,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "status": "EnumPaymentLinksStatus", "updated_at": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The ISO-8601 timestamp of when the payment link was last updated. ", "type": "optional", @@ -80825,7 +80479,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "access_token": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The Belvo-generated access token for the payment link. **Note:** You'll need the \`access_token\` to make [Get details for a payment link](https://developers.belvo.com/reference/detailcreatepaymentlink) requests.", @@ -80875,7 +80528,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "payment_intent": { - "display-name": "Brazil 🇧🇷 OFPI", "type": "optional", }, "payment_url": { @@ -80884,7 +80536,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "status": "EnumPaymentLinksStatus", "updated_at": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "The ISO-8601 timestamp of when the payment link was last updated. ", "type": "optional", @@ -80943,7 +80594,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "access_token": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The Belvo-generated access token for the payment link. **Note:** You'll need the \`access_token\` to make [Get details for a payment link](https://developers.belvo.com/reference/detailcreatepaymentlink) requests.", @@ -80993,7 +80643,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "payment_intent": { - "display-name": "Colombia 🇨🇴 PSE", "type": "optional", }, "payment_url": { @@ -81002,7 +80651,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "status": "EnumPaymentLinksStatus", "updated_at": { - "display-name": "Colombia 🇨🇴 PSE", "docs": "The ISO-8601 timestamp of when the payment link was last updated. ", "type": "optional", @@ -81630,14 +81278,12 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "Belvo has a limit regarding the time it takes to log in, retrieve account data, and log out. A timeout occurs when there is a very high amount of data and everything could not be obtained within the allotted time.", "properties": { "code": { - "display-name": "Request Timeout", "docs": "A unique error code (\`request_timeout\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 408 request_timeout errors.", "type": "optional", }, "message": { - "display-name": "Request Timeout", "docs": "A short description of the error. For \`request_timeout\` errors, the description is: @@ -81646,7 +81292,6 @@ For \`request_timeout\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Request Timeout", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -82192,14 +81837,12 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": "This error occurs when you try to resume a request session that has already expired. This is usually because the user took too long to provide their authentication token.", "properties": { "code": { - "display-name": "Session Expired", "docs": "A unique error code (\`session_expired\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 session_expired errors.", "type": "optional", }, "message": { - "display-name": "Session Expired", "docs": "A short description of the error. For \`session_expired\` errors, the description is: @@ -82208,7 +81851,6 @@ For \`session_expired\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Session Expired", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -82475,12 +82117,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "count": { - "display-name": "Tax Declaration Business", "docs": "The total number of results in your Belvo account.", "type": "optional", }, "next": { - "display-name": "Tax Declaration Business", "docs": "The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is \`null\`. In our documentation example, we use \`{endpoint}\` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, \`accounts\` or \`owners\`). @@ -82488,12 +82128,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "previous": { - "display-name": "Tax Declaration Business", "docs": "The URL to the previous page of results. If there is no previous page, the value is \`null\`.", "type": "optional", }, "results": { - "display-name": "Tax Declaration Business", "docs": "Array of Business Tax Declaration objects.", "type": "optional>", }, @@ -82562,12 +82200,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "docs": undefined, "properties": { "count": { - "display-name": "Tax Declaration Individual", "docs": "The total number of results in your Belvo account.", "type": "optional", }, "next": { - "display-name": "Tax Declaration Individual", "docs": "The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is \`null\`. In our documentation example, we use \`{endpoint}\` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, \`accounts\` or \`owners\`). @@ -82575,12 +82211,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "previous": { - "display-name": "Tax Declaration Individual", "docs": "The URL to the previous page of results. If there is no previous page, the value is \`null\`.", "type": "optional", }, "results": { - "display-name": "Tax Declaration Individual", "docs": "Array of Individual Tax Declaration objects.", "type": "optional>", }, @@ -82821,17 +82455,14 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional>", }, "created_at": { - "display-name": "Tax Return Business", "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", "type": "optional", }, "datos_adicionales": { - "display-name": "Tax Return Business", "docs": "Additional data regarding the tax return.", "type": "optional>", }, "deducciones_autorizadas": { - "display-name": "Tax Return Business", "docs": "Details regarding the legal entity's deductions.", "type": "optional>", }, @@ -82844,7 +82475,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional>", }, "dividendos_o_utilidades_distribuidos": { - "display-name": "Tax Return Business", "docs": "Details regarding distributed dividends.", "type": "optional>", }, @@ -82857,7 +82487,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional>", }, "id": { - "display-name": "Tax Return Business", "docs": "Unique identifier created by Belvo used to reference the current Tax Return.", "type": "optional", "validation": { @@ -82905,7 +82534,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "created_at": { - "display-name": "Tax Return Business Monthly", "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", "type": "optional", }, @@ -82926,7 +82554,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional>", }, "id": { - "display-name": "Tax Return Business Monthly", "docs": "Unique identifier created by Belvo used to reference the current Tax Return.", "type": "optional", "validation": { @@ -82951,7 +82578,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "receipt_pdf": { - "display-name": "Tax Return Business Monthly", "docs": "The acknowledgement receipt from the fiscal institution confirming that they received the tax return.", "type": "optional", "validation": { @@ -82979,12 +82605,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "created_at": { - "display-name": "Tax Return Personal", "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", "type": "optional", }, "datos_informativos": { - "display-name": "Tax Return Personal", "docs": "Extra informative data on the tax return.", "type": "optional>", }, @@ -83001,7 +82625,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional>", }, "id": { - "display-name": "Tax Return Personal", "docs": "Unique identifier created by Belvo used to reference the current Tax Return.", "type": "optional", "validation": { @@ -83016,7 +82639,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional>", }, "link": { - "display-name": "Tax Return Personal", "docs": "The \`link.id\` the statement belongs to", "type": "optional", "validation": { @@ -83072,12 +82694,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "created_at": { - "display-name": "Tax Return Personal Monthly", "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", "type": "optional", }, "id": { - "display-name": "Tax Return Personal Monthly", "docs": "Unique identifier created by Belvo used to reference the current Tax Return.", "type": "optional", "validation": { @@ -83110,7 +82730,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, }, "receipt_pdf": { - "display-name": "Tax Return Personal Monthly", "docs": "The acknowledgement receipt from the fiscal institution confirming that they received the tax return.", "type": "optional", "validation": { @@ -83134,12 +82753,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "extra-properties": true, "properties": { "count": { - "display-name": "Tax Return Personal Business Monthly", "docs": "The total number of results in your Belvo account.", "type": "optional", }, "next": { - "display-name": "Tax Return Personal Business Monthly", "docs": "The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is \`null\`. In our documentation example, we use \`{endpoint}\` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, \`accounts\` or \`owners\`). @@ -83147,12 +82764,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "previous": { - "display-name": "Tax Return Personal Business Monthly", "docs": "The URL to the previous page of results. If there is no previous page, the value is \`null\`.", "type": "optional", }, "results": { - "display-name": "Tax Return Personal Business Monthly", "docs": "Array of Monthly Business Tax Return objects.", "type": "optional>", }, @@ -83166,12 +82781,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "extra-properties": true, "properties": { "count": { - "display-name": "Tax Return Personal Business", "docs": "The total number of results in your Belvo account.", "type": "optional", }, "next": { - "display-name": "Tax Return Personal Business", "docs": "The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is \`null\`. In our documentation example, we use \`{endpoint}\` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, \`accounts\` or \`owners\`). @@ -83179,12 +82792,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "previous": { - "display-name": "Tax Return Personal Business", "docs": "The URL to the previous page of results. If there is no previous page, the value is \`null\`.", "type": "optional", }, "results": { - "display-name": "Tax Return Personal Business", "docs": "Array of Business Tax Return objects.", "type": "optional>", }, @@ -83198,7 +82809,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "properties": { "attach_pdf": { "default": false, - "display-name": "Monthly Tax Returns", "docs": "When this is set to \`true\`, you will receive the PDF as a binary string in the response.", "type": "optional", }, @@ -83226,7 +82836,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "save_data": { "default": true, - "display-name": "Monthly Tax Returns", "docs": "Indicates whether or not to persist the data in Belvo. By default, this is set to \`true\` and we return a 201 Created response. When set to \`false\`, the data won't be persisted and we return a 200 OK response.", "type": "optional", @@ -83247,12 +82856,10 @@ When set to \`false\`, the data won't be persisted and we return a 200 OK respon "extra-properties": true, "properties": { "count": { - "display-name": "Tax Return Personal Monthly", "docs": "The total number of results in your Belvo account.", "type": "optional", }, "next": { - "display-name": "Tax Return Personal Monthly", "docs": "The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is \`null\`. In our documentation example, we use \`{endpoint}\` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, \`accounts\` or \`owners\`). @@ -83260,12 +82867,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "previous": { - "display-name": "Tax Return Personal Monthly", "docs": "The URL to the previous page of results. If there is no previous page, the value is \`null\`.", "type": "optional", }, "results": { - "display-name": "Tax Return Personal Monthly", "docs": "Array of Monthly Personal Tax Return objects.", "type": "optional>", }, @@ -83279,12 +82884,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "extra-properties": true, "properties": { "count": { - "display-name": "Tax Return Personal", "docs": "The total number of results in your Belvo account.", "type": "optional", }, "next": { - "display-name": "Tax Return Personal", "docs": "The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is \`null\`. In our documentation example, we use \`{endpoint}\` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, \`accounts\` or \`owners\`). @@ -83292,12 +82895,10 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "type": "optional", }, "previous": { - "display-name": "Tax Return Personal", "docs": "The URL to the previous page of results. If there is no previous page, the value is \`null\`.", "type": "optional", }, "results": { - "display-name": "Tax Return Personal", "docs": "Array of Personal Tax Return objects.", "type": "optional>", }, @@ -83311,7 +82912,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p "properties": { "attach_pdf": { "default": false, - "display-name": "Yearly Tax Returns", "docs": "When this is set to \`true\`, you will receive the PDF as a binary string in the response.", "type": "optional", }, @@ -83327,7 +82927,6 @@ In our documentation example, we use \`{endpoint}\` as a placeholder value. In p }, "save_data": { "default": true, - "display-name": "Yearly Tax Returns", "docs": "Indicates whether or not to persist the data in Belvo. By default, this is set to \`true\` and we return a 201 Created response. When set to \`false\`, the data won't be persisted and we return a 200 OK response.", "type": "optional", @@ -84200,14 +83799,12 @@ You will still need to make a PATCH call to complete the request.", - you make a request for information while Belvo is scraping data from the institution for that user.", "properties": { "code": { - "display-name": "Too Many Sessions", "docs": "A unique error code (\`too_many_sessions\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 too_many_sessions errors.", "type": "optional", }, "message": { - "display-name": "Too Many Sessions", "docs": "A short description of the error. For \`too_many_sessions\` errors, the description is: @@ -84216,7 +83813,6 @@ For \`too_many_sessions\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Too Many Sessions", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -84332,7 +83928,6 @@ For \`too_many_sessions\` errors, the description is: "docs": "Information about the payer's bank account. Belvo returns the bank account ID when the account is already saved in the Belvo database.", "properties": { "bank_account": { - "display-name": "Bank account PSE", "docs": "Belvo's unique identifier for the payer’s bank account.", "type": "optional", "validation": { @@ -84348,7 +83943,6 @@ For \`too_many_sessions\` errors, the description is: }, }, "TransactionBankAccountOfpi": { - "display-name": "Brazil 🇧🇷 OFPI", "docs": "Object containing the payer's bank account information. For OFPI, this field will return an empty object.", "type": "map", }, @@ -84517,14 +84111,12 @@ When set to \`false\`, the data won't be persisted and we return a 200 OK respon "docs": "This error occurs when you try to make an API call using incorrect Belvo API credentials (either your secret key or secret password, or both, are incorrect).", "properties": { "code": { - "display-name": "Unauthorized Error", "docs": "A unique error code (\`authentication_failed\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 401 authentication_failed errors.", "type": "optional", }, "message": { - "display-name": "Unauthorized Error", "docs": "A short description of the error. For \`authentication_failed\` errors, the description is: @@ -84533,7 +84125,6 @@ For \`authentication_failed\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Unauthorized Error", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -84553,14 +84144,12 @@ For \`authentication_failed\` errors, the description is: A Link's status is set to \`unconfirmed_link\` when your user has not completed the Link creation process successfully (for example, they might not provide a valid MFA token).", "properties": { "code": { - "display-name": "Unconfirmed Link", "docs": "A unique error code (\`unconfirmed_link\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 unconfirmed_link errors.", "type": "optional", }, "message": { - "display-name": "Unconfirmed Link", "docs": "A short description of the error. For \`unconfirmed_link\` errors, the description is: @@ -84569,7 +84158,6 @@ For \`unconfirmed_link\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Unconfirmed Link", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -84588,14 +84176,12 @@ For \`unconfirmed_link\` errors, the description is: "docs": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.", "properties": { "code": { - "display-name": "Unexpected Error", "docs": "A unique error code (\`unexpected_error\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 500 unexpected_error errors.", "type": "optional", }, "message": { - "display-name": "Unexpected Error", "docs": "A short description of the error. For \`unexpected_error\` errors, the description is: @@ -84604,7 +84190,6 @@ For \`unexpected_error\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Unexpected Error", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -84623,14 +84208,12 @@ For \`unexpected_error\` errors, the description is: "docs": "This error occurs when you try to access some data operation that Belvo does not support for an institution. For example, trying to access the Balances resource for fiscal institutions.", "properties": { "code": { - "display-name": "Unsupported Operation", "docs": "A unique error code (\`unsupported_operation\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 400 unsupported_operation errors.", "type": "optional", }, "message": { - "display-name": "Unsupported Operation", "docs": "A short description of the error. For \`unsupported_operation\` errors, the description is: @@ -84639,7 +84222,6 @@ For \`unsupported_operation\` errors, the description is: "type": "optional", }, "request_id": { - "display-name": "Unsupported Operation", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { @@ -84658,7 +84240,6 @@ For \`unsupported_operation\` errors, the description is: "docs": "This error occurs when you try to resume a request session that has already expired. This is usually because the user took too long to provide their authentication token.", "properties": { "code": { - "display-name": "Validation Error", "docs": "A unique error code (\`null\`, \`does_not_exist\`, \`required\`) that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle: @@ -84669,12 +84250,10 @@ For \`unsupported_operation\` errors, the description is: "type": "optional", }, "field": { - "display-name": "Validation Error", "docs": "Name of the field where the error was encountered.", "type": "optional", }, "message": { - "display-name": "Validation Error", "docs": "A short description of the error. For \`session_expired\` errors, the description can be (among others): @@ -84686,7 +84265,6 @@ For \`session_expired\` errors, the description can be (among others): "type": "optional", }, "request_id": { - "display-name": "Validation Error", "docs": "A 32-character unique ID of the request (matching a regex pattern of: \`[a-f0-9]{32}\`). Provide this ID when contacting the Belvo support team to accelerate investigations.", "type": "optional", "validation": { diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/deel.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/deel.test.ts.snap index 5832bd3b6da..9389fd5f23a 100644 --- a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/deel.test.ts.snap +++ b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/deel.test.ts.snap @@ -13885,7 +13885,6 @@ exports[`open api parser > deel > docs 1`] = ` "docs": undefined, "properties": { "contract_id": { - "display-name": "The worker for the payment", "docs": "The worker's Deel contract Id.", "type": "optional", }, @@ -26548,7 +26547,6 @@ exports[`open api parser > deel > simple 1`] = ` "docs": undefined, "properties": { "contract_id": { - "display-name": "The worker for the payment", "docs": "The worker's Deel contract Id.", "type": "optional", }, diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/devrev.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/devrev.test.ts.snap index c2c0eb96aac..2ba4c724821 100644 --- a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/devrev.test.ts.snap +++ b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/devrev.test.ts.snap @@ -339,7 +339,6 @@ disabled. "type": "string", }, "toggle": { - "display-name": "dev-org-auth-connections-toggle-request", "type": "optional", }, }, @@ -447,12 +446,10 @@ authenticated user. "body": { "properties": { "aud": { - "display-name": "auth-tokens-create-request", "docs": "The expected audience values with respect to the token.", "type": "optional>", }, "client_id": { - "display-name": "auth-tokens-create-request", "docs": "An identifier that represents the application which is requesting the token. If no client_id is present in the request to generate an application access token (AAT), DevRev will generate a client_id. @@ -461,25 +458,20 @@ This client_id is only associated with an AAT. "type": "optional", }, "expires_in": { - "display-name": "auth-tokens-create-request", "docs": "The expected validity lifetime of the token in number of days. ", "type": "optional", }, "grant_type": { - "display-name": "auth-tokens-create-request", "type": "optional", }, "requested_token_type": { - "display-name": "auth-tokens-create-request", "type": "optional", }, "rev_info": { - "display-name": "auth-tokens-create-request", "type": "optional", }, "scope": { - "display-name": "auth-tokens-create-request", "docs": "The requested set of scopes associated with the issued token. A space-delimited list of values in which the order of values does not matter. @@ -487,18 +479,15 @@ not matter. "type": "optional", }, "subject_token": { - "display-name": "auth-tokens-create-request", "docs": "Represents the entity that requests the token. Not required when requesting an application access token (AAT). ", "type": "optional", }, "subject_token_type": { - "display-name": "auth-tokens-create-request", "type": "optional", }, "token_hint": { - "display-name": "auth-tokens-create-request", "docs": "A hint that identifies the token.", "type": "optional", }, @@ -539,7 +528,6 @@ given Dev organization. "body": { "properties": { "token_id": { - "display-name": "auth-tokens-delete-request", "docs": "The unique identifier for the token under a given Dev organization. If no token ID is provided, then the token ID will be set from the JTI claim of the token in the authorization header. @@ -742,7 +730,6 @@ authenticated user. "body": { "properties": { "requested_token_type": { - "display-name": "auth-tokens-self-delete-request", "type": "optional", }, }, @@ -1562,7 +1549,6 @@ organization. "body": { "properties": { "description": { - "display-name": "rev-orgs-create-request", "docs": "Description of the Rev organization.", "type": "optional", }, @@ -1571,16 +1557,13 @@ organization. "type": "string", }, "domain": { - "display-name": "rev-orgs-create-request", "docs": "Company's domain name. Example - 'devrev.ai'.", "type": "optional", }, "environment": { - "display-name": "rev-orgs-create-request", "type": "optional", }, "external_ref": { - "display-name": "rev-orgs-create-request", "docs": "External ref is a custom unique identifier which is a reference to an unique id for this organization's data in some system of records. @@ -1588,7 +1571,6 @@ records. "type": "optional", }, "tier": { - "display-name": "rev-orgs-create-request", "docs": "The tier of the RevOrg.", "type": "optional", }, @@ -1900,26 +1882,21 @@ them. "body": { "properties": { "description": { - "display-name": "rev-orgs-update-request", "docs": "Description of the Rev organization.", "type": "optional", }, "display_name": { - "display-name": "rev-orgs-update-request", "docs": "Customer chosen name for the Rev organization.", "type": "optional", }, "domain": { - "display-name": "rev-orgs-update-request", "docs": "Company's domain name. Example - 'devrev.ai'.", "type": "optional", }, "environment": { - "display-name": "rev-orgs-update-request", "type": "optional", }, "external_ref": { - "display-name": "rev-orgs-update-request", "docs": "External ref is a custom unique identifier which is a reference to an unique id for this organization's data in some system of records. @@ -1931,7 +1908,6 @@ records. "type": "string", }, "tier": { - "display-name": "rev-orgs-update-request", "docs": "The tier of the RevOrg.", "type": "optional", }, @@ -2028,14 +2004,12 @@ and a logical concept denoted by the tag's name. "body": { "properties": { "allowed_values": { - "display-name": "tags-create-request", "docs": "The allowed values for the tag, or empty if no values are permitted. ", "type": "optional>", }, "description": { - "display-name": "tags-create-request", "docs": "The description for the tag.", "type": "optional", }, @@ -2311,11 +2285,9 @@ used. "body": { "properties": { "allowed_values": { - "display-name": "tags-update-request", "type": "optional", }, "description": { - "display-name": "tags-update-request", "docs": "The updated description of the tag.", "type": "optional", }, @@ -2324,7 +2296,6 @@ used. "type": "string", }, "name": { - "display-name": "tags-update-request", "docs": "The updated name of the tag. The name must be unique across all tags. ", @@ -2762,12 +2733,10 @@ used. "body": { "properties": { "event_types": { - "display-name": "webhooks-create-request", "docs": "The event types that the webhook endpoint will receive.", "type": "optional>", }, "secret": { - "display-name": "webhooks-create-request", "docs": "The secret to use when verifying webhook events. If provided, the secret must be between 8 and 32 bytes (inclusive). If not set, a secret will be automatically generated and provided in the @@ -3032,11 +3001,9 @@ response. "body": { "properties": { "action": { - "display-name": "webhooks-update-request", "type": "optional", }, "event_types": { - "display-name": "webhooks-update-request", "type": "optional", }, "id": { @@ -3044,7 +3011,6 @@ response. "type": "string", }, "secret": { - "display-name": "webhooks-update-request", "docs": "If provided, updates the secret that's used when verifying webhook events, which must be between 8 and 32 bytes (inclusive). Otherwise if empty, then a new secret is generated. If the webhook is active, @@ -3060,7 +3026,6 @@ won't receive any object events until successfully verified. }, }, "url": { - "display-name": "webhooks-update-request", "docs": "The webhook's updated URL. If the webhook is active, then the webhook's status will transition to the 'unverified' state and it won't receive any object events until successfully verified. @@ -5350,7 +5315,6 @@ organizations. "docs": "The response to getting an artifact's download URL.", "properties": { "expires_at": { - "display-name": "artifacts-locate-response", "docs": "The expiration timestamp of the URL.", "type": "optional", }, @@ -5403,16 +5367,13 @@ organizations. "docs": undefined, "properties": { "created_by": { - "display-name": "atom-base", "type": "optional", }, "created_date": { - "display-name": "atom-base", "docs": "Timestamp when the object was created.", "type": "optional", }, "display_id": { - "display-name": "atom-base", "docs": "Human-readable object ID unique to the Dev organization.", "type": "optional", }, @@ -5421,11 +5382,9 @@ organizations. "type": "string", }, "modified_by": { - "display-name": "atom-base", "type": "optional", }, "modified_date": { - "display-name": "atom-base", "docs": "Timestamp when the object was last modified.", "type": "optional", }, @@ -5438,7 +5397,6 @@ organizations. "docs": undefined, "properties": { "display_id": { - "display-name": "atom-base-summary", "docs": "Human-readable object ID unique to the Dev organization.", "type": "optional", }, @@ -5511,17 +5469,14 @@ authentication connection. ", "properties": { "client_id": { - "display-name": "auth-connection-options-azure-ad", "docs": "Client ID for the Azure authentication connection.", "type": "optional", }, "client_secret": { - "display-name": "auth-connection-options-azure-ad", "docs": "Client secret for the Azure authentication connection.", "type": "optional", }, "domain": { - "display-name": "auth-connection-options-azure-ad", "docs": "Domain URL of the Azure authentication connection.", "type": "optional", }, @@ -5536,18 +5491,15 @@ authentication connection. ", "properties": { "client_id": { - "display-name": "auth-connection-options-google-apps", "docs": "Client ID for the Google Apps authentication connection.", "type": "optional", }, "client_secret": { - "display-name": "auth-connection-options-google-apps", "docs": "Client secret for the Google Apps authentication connection. ", "type": "optional", }, "tenant_domain": { - "display-name": "auth-connection-options-google-apps", "docs": "Tenant domain URL of the Google Apps authentication connection. ", "type": "optional", @@ -5563,17 +5515,14 @@ authentication connection. ", "properties": { "client_id": { - "display-name": "auth-connection-options-oidc", "docs": "Client ID for the OIDC authentication connection.", "type": "optional", }, "client_secret": { - "display-name": "auth-connection-options-oidc", "docs": "Client secret for the OIDC authentication connection.", "type": "optional", }, "issuer": { - "display-name": "auth-connection-options-oidc", "docs": "Issuer URL of the OIDC authentication connection.", "type": "optional", }, @@ -5588,12 +5537,10 @@ authentication connection. ", "properties": { "sign_in_endpoint": { - "display-name": "auth-connection-options-saml", "docs": "Sign In endpoint for the SAML authentication connection.", "type": "optional", }, "signing_cert": { - "display-name": "auth-connection-options-saml", "docs": "Signing certificate for the SAML authentication connection. ", "type": "optional", @@ -5604,7 +5551,6 @@ authentication connection. }, }, "AuthConnectionOptionsSocial": { - "display-name": "auth-connection-options-social", "type": "map", }, "AuthConnectionToggle": { @@ -5794,7 +5740,6 @@ token type. "type": "string", }, "client_id": { - "display-name": "auth-tokens-create-response", "docs": "An identifier that represents the application which is requesting the token. Only present in a response corresponding to an application access token (AAT). @@ -5808,12 +5753,10 @@ epoch. "type": "long", }, "refresh_token": { - "display-name": "auth-tokens-create-response", "docs": "A token to refresh the issued token.", "type": "optional", }, "scope": { - "display-name": "auth-tokens-create-response", "docs": "The scopes associated with the issued token. A space-delimited list of values in which the order of values does not matter. ", @@ -5853,12 +5796,10 @@ of values in which the order of values does not matter. "docs": "Carries Rev org info.", "properties": { "display_name": { - "display-name": "auth-tokens-org-traits", "docs": "The display name of the Rev org.", "type": "optional", }, "domain": { - "display-name": "auth-tokens-org-traits", "docs": "The domain of the Rev org.", "type": "optional", }, @@ -5873,16 +5814,13 @@ issue a Rev session token. ", "properties": { "org_ref": { - "display-name": "auth-tokens-rev-info", "docs": "An identifier which uniquely identifies a Rev org.", "type": "optional", }, "org_traits": { - "display-name": "auth-tokens-rev-info", "type": "optional", }, "rev_user_id": { - "display-name": "auth-tokens-rev-info", "docs": "The unique ID of the Rev user.", "type": "optional", }, @@ -5891,7 +5829,6 @@ issue a Rev session token. "type": "string", }, "user_traits": { - "display-name": "auth-tokens-rev-info", "type": "optional", }, }, @@ -5915,17 +5852,14 @@ issue a Rev session token. "docs": "Carries Rev user info.", "properties": { "display_name": { - "display-name": "auth-tokens-user-traits", "docs": "The display name of the Rev user.", "type": "optional", }, "email": { - "display-name": "auth-tokens-user-traits", "docs": "The email address of the Rev user.", "type": "optional", }, "full_name": { - "display-name": "auth-tokens-user-traits", "docs": "The full name of the Rev user.", "type": "optional", }, @@ -6143,14 +6077,12 @@ connection. "type": "list", }, "next_cursor": { - "display-name": "dev-users-list-response", "docs": "The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist. ", "type": "optional", }, "prev_cursor": { - "display-name": "dev-users-list-response", "docs": "The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. ", @@ -6189,7 +6121,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorBadRequestBadRequest": { - "display-name": "error-bad-request-bad-request", "type": "map", }, "ErrorBadRequestInvalidEnumValue": { @@ -6225,7 +6156,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorBadRequestParseError": { - "display-name": "error-bad-request-parse-error", "type": "map", }, "ErrorBadRequestType": { @@ -6248,7 +6178,6 @@ sort order. If not set, then no prior elements exist. "type": "string", }, "reason": { - "display-name": "error-bad-request-value-not-permitted", "docs": "The reason the value isn't permitted.", "type": "optional", }, @@ -6261,7 +6190,6 @@ sort order. If not set, then no prior elements exist. "docs": undefined, "properties": { "message": { - "display-name": "error-base", "docs": "The message associated with the error.", "type": "optional", }, @@ -6281,7 +6209,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorForbiddenForbidden": { - "display-name": "error-forbidden-forbidden", "type": "map", }, "ErrorForbiddenType": "literal<"forbidden">", @@ -6296,7 +6223,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorInternalServerErrorInternalError": { - "display-name": "error-internal-server-error-internal-error", "type": "map", }, "ErrorInternalServerErrorType": "literal<"internal_error">", @@ -6311,7 +6237,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorNotFoundNotFound": { - "display-name": "error-not-found-not-found", "type": "map", }, "ErrorNotFoundType": "literal<"not_found">", @@ -6326,7 +6251,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorServiceUnavailableServiceUnavailable": { - "display-name": "error-service-unavailable-service-unavailable", "type": "map", }, "ErrorServiceUnavailableType": "literal<"service_unavailable">", @@ -6341,7 +6265,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorTooManyRequestsTooManyRequests": { - "display-name": "error-too-many-requests-too-many-requests", "type": "map", }, "ErrorTooManyRequestsType": "literal<"too_many_requests">", @@ -6357,7 +6280,6 @@ sort order. If not set, then no prior elements exist. }, "ErrorUnauthorizedType": "literal<"unauthenticated">", "ErrorUnauthorizedUnauthenticated": { - "display-name": "error-unauthorized-unauthenticated", "type": "map", }, "EventPartCreated": { @@ -6577,7 +6499,6 @@ sort order. If not set, then no prior elements exist. }, }, "ExternalIdentity": { - "display-name": "external-identity", "docs": "External identity of a user.", "type": "map", }, @@ -6811,7 +6732,6 @@ always be returned in the specified sort-by order. "type": "list", }, "target_close_date": { - "display-name": "parts-create-request-enhancement", "docs": "Target close date by which enhancement is expected to be closed. ", "type": "optional", @@ -6834,7 +6754,6 @@ always be returned in the specified sort-by order. }, }, "PartsCreateRequestProduct": { - "display-name": "parts-create-request-product", "type": "map", }, "PartsCreateResponse": { @@ -6850,7 +6769,6 @@ always be returned in the specified sort-by order. }, }, "PartsDeleteResponse": { - "display-name": "parts-delete-response", "type": "map", }, "PartsGetResponse": { @@ -6869,7 +6787,6 @@ always be returned in the specified sort-by order. "docs": undefined, "properties": { "next_cursor": { - "display-name": "parts-list-response", "docs": "The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist. ", @@ -6880,7 +6797,6 @@ sort order. If not set, then no later elements exist. "type": "list", }, "prev_cursor": { - "display-name": "parts-list-response", "docs": "The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. ", @@ -6938,14 +6854,12 @@ sort order. If not set, then no prior elements exist. }, }, "PartsUpdateRequestCapability": { - "display-name": "parts-update-request-capability", "type": "map", }, "PartsUpdateRequestEnhancement": { "docs": undefined, "properties": { "target_close_date": { - "display-name": "parts-update-request-enhancement", "docs": "Updates the target close date of the enhancement.", "type": "optional", }, @@ -6955,14 +6869,12 @@ sort order. If not set, then no prior elements exist. }, }, "PartsUpdateRequestFeature": { - "display-name": "parts-update-request-feature", "type": "map", }, "PartsUpdateRequestOwnedBy": { "docs": undefined, "properties": { "set": { - "display-name": "parts-update-request-owned-by", "docs": "Sets the owner IDs to the provided user IDs. This must not be empty. ", @@ -6974,7 +6886,6 @@ empty. }, }, "PartsUpdateRequestProduct": { - "display-name": "parts-update-request-product", "type": "map", }, "PartsUpdateResponse": { @@ -7042,7 +6953,6 @@ organization. }, }, "RevOrgsDeleteResponse": { - "display-name": "rev-orgs-delete-response", "docs": "The response to deleting a Rev organization.", "type": "map", }, @@ -7063,14 +6973,12 @@ organization. ", "properties": { "next_cursor": { - "display-name": "rev-orgs-list-response", "docs": "The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist. ", "type": "optional", }, "prev_cursor": { - "display-name": "rev-orgs-list-response", "docs": "The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. ", @@ -7126,7 +7034,6 @@ system-generated identifier will be assigned to the user. "type": "string", }, "value": { - "display-name": "set-tag-with-value", "docs": "The value for the object's association with the tag. If specified, the value must be one that's specified in the tag's allowed values. ", @@ -7141,7 +7048,6 @@ the value must be one that's specified in the tag's allowed values. "docs": "Sets an object's initial stage.", "properties": { "name": { - "display-name": "stage-init", "docs": "The name of the stage.", "type": "optional", }, @@ -7154,7 +7060,6 @@ the value must be one that's specified in the tag's allowed values. "docs": "Updates an object's stage.", "properties": { "name": { - "display-name": "stage-update", "docs": "The updated name of the stage, otherwise unchanged if not set. ", "type": "optional", @@ -7194,7 +7099,6 @@ unique. "type": "TagSummary", }, "value": { - "display-name": "tag-with-value", "docs": "The value for the object's association with the tag.", "type": "optional", }, @@ -7216,7 +7120,6 @@ unique. }, }, "TagsDeleteResponse": { - "display-name": "tags-delete-response", "docs": "The response for deleting a tag.", "type": "map", }, @@ -7236,14 +7139,12 @@ unique. "docs": "The response to listing the tags.", "properties": { "next_cursor": { - "display-name": "tags-list-response", "docs": "The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist. ", "type": "optional", }, "prev_cursor": { - "display-name": "tags-list-response", "docs": "The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. ", @@ -7262,7 +7163,6 @@ sort order. If not set, then no prior elements exist. "docs": "Specifies an update to a tag's allowed values.", "properties": { "set": { - "display-name": "tags-update-allowed-values", "docs": "Sets the allowed values for the tag.", "type": "optional>", }, @@ -7357,21 +7257,17 @@ will appear in the response. "docs": undefined, "properties": { "artifacts": { - "display-name": "timeline-entries-create-request-timeline-comment", "docs": "The IDs of the artifacts attached to the comment.", "type": "optional>", }, "body": { - "display-name": "timeline-entries-create-request-timeline-comment", "docs": "The comment's body.", "type": "optional", }, "body_type": { - "display-name": "timeline-entries-create-request-timeline-comment", "type": "optional", }, "snap_kit_body": { - "display-name": "timeline-entries-create-request-timeline-comment", "docs": "The SnapKit body of the comment.", "type": "optional>", }, @@ -7409,14 +7305,12 @@ will appear in the response. "docs": "The response to listing timeline entries for an object.", "properties": { "next_cursor": { - "display-name": "timeline-entries-list-response", "docs": "The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist. ", "type": "optional", }, "prev_cursor": { - "display-name": "timeline-entries-list-response", "docs": "The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. ", @@ -7456,20 +7350,16 @@ sort order. If not set, then no prior elements exist. "docs": undefined, "properties": { "artifacts": { - "display-name": "timeline-entries-update-request-timeline-comment", "type": "optional", }, "body": { - "display-name": "timeline-entries-update-request-timeline-comment", "docs": "The updated comment's body.", "type": "optional", }, "body_type": { - "display-name": "timeline-entries-update-request-timeline-comment", "type": "optional", }, "snap_kit_body": { - "display-name": "timeline-entries-update-request-timeline-comment", "docs": "The SnapKit body of the comment.", "type": "optional>", }, @@ -7482,7 +7372,6 @@ sort order. If not set, then no prior elements exist. "docs": undefined, "properties": { "add": { - "display-name": "timeline-entries-update-request-timeline-comment-artifacts", "docs": "Adds the provided artifacts to the comment. An artifact cannot be added more than once, i.e. nothing is done if the artifact is already attached. Mutually exclusive with \`set\`. @@ -7490,14 +7379,12 @@ already attached. Mutually exclusive with \`set\`. "type": "optional>", }, "remove": { - "display-name": "timeline-entries-update-request-timeline-comment-artifacts", "docs": "Removes the provided artifacts from the comment. If an artifact is not present, then it's ignored. Mututally exclusive with \`set\`. ", "type": "optional>", }, "set": { - "display-name": "timeline-entries-update-request-timeline-comment-artifacts", "docs": "Sets the field to the provided artifacts.", "type": "optional>", }, @@ -7652,55 +7539,42 @@ default visibility. "type": "string", }, "part_created": { - "display-name": "webhook-event-request", "type": "optional", }, "part_deleted": { - "display-name": "webhook-event-request", "type": "optional", }, "part_updated": { - "display-name": "webhook-event-request", "type": "optional", }, "rev_org_created": { - "display-name": "webhook-event-request", "type": "optional", }, "rev_org_deleted": { - "display-name": "webhook-event-request", "type": "optional", }, "rev_org_updated": { - "display-name": "webhook-event-request", "type": "optional", }, "tag_created": { - "display-name": "webhook-event-request", "type": "optional", }, "tag_deleted": { - "display-name": "webhook-event-request", "type": "optional", }, "tag_updated": { - "display-name": "webhook-event-request", "type": "optional", }, "timeline_entry_created": { - "display-name": "webhook-event-request", "type": "optional", }, "timeline_entry_deleted": { - "display-name": "webhook-event-request", "type": "optional", }, "timeline_entry_updated": { - "display-name": "webhook-event-request", "type": "optional", }, "timestamp": { - "display-name": "webhook-event-request", "docs": "Timestamp of the webhook's invocation for the event. Note this should be used to protect against replay attacks, where the event should only be processed if the timestamp isn't stale by several @@ -7709,19 +7583,15 @@ seconds. "type": "optional", }, "type": { - "display-name": "webhook-event-request", "type": "optional", }, "verify": { - "display-name": "webhook-event-request", "type": "optional", }, "webhook_created": { - "display-name": "webhook-event-request", "type": "optional", }, "webhook_deleted": { - "display-name": "webhook-event-request", "type": "optional", }, "webhook_id": { @@ -7729,19 +7599,15 @@ seconds. "type": "string", }, "webhook_updated": { - "display-name": "webhook-event-request", "type": "optional", }, "work_created": { - "display-name": "webhook-event-request", "type": "optional", }, "work_deleted": { - "display-name": "webhook-event-request", "type": "optional", }, "work_updated": { - "display-name": "webhook-event-request", "type": "optional", }, }, @@ -7753,7 +7619,6 @@ seconds. "docs": undefined, "properties": { "challenge": { - "display-name": "webhook-event-response", "docs": "The challenge from the "verify" request, otherwise this should not be set for other request types. ", @@ -7839,7 +7704,6 @@ be set for other request types. }, }, "WebhooksDeleteResponse": { - "display-name": "webhooks-delete-response", "docs": "The response to deleting the webhook.", "type": "map", }, @@ -7881,7 +7745,6 @@ be set for other request types. "docs": undefined, "properties": { "add": { - "display-name": "webhooks-update-request-event-types", "docs": "The event types to add. If a provided event type is already set for the webhook, then nothing is done. Note this is mutually exclusive with 'set'. @@ -7889,7 +7752,6 @@ with 'set'. "type": "optional>", }, "remove": { - "display-name": "webhooks-update-request-event-types", "docs": "The event types to remove. If a provided event type isn't set for the webhook, then nothing is done. Note this is mutually exclusive with 'set'. @@ -7897,7 +7759,6 @@ with 'set'. "type": "optional>", }, "set": { - "display-name": "webhooks-update-request-event-types", "docs": "The updated event types, which will replace the webhook's current event types. Note this is mutually exclusive with 'add' and 'remove'. @@ -8033,11 +7894,9 @@ issues. "docs": undefined, "properties": { "priority": { - "display-name": "works-create-request-issue", "type": "optional", }, "sprint": { - "display-name": "works-create-request-issue", "docs": "The sprint that the issue belongs to.", "type": "optional", }, @@ -8050,17 +7909,14 @@ issues. "docs": undefined, "properties": { "group": { - "display-name": "works-create-request-ticket", "docs": "The group that the ticket is associated with.", "type": "optional", }, "rev_org": { - "display-name": "works-create-request-ticket", "docs": "The Rev organization that the ticket is associated with.", "type": "optional", }, "severity": { - "display-name": "works-create-request-ticket", "type": "optional", }, }, @@ -8081,7 +7937,6 @@ issues. }, }, "WorksDeleteResponse": { - "display-name": "works-delete-response", "type": "map", }, "WorksExportResponse": { @@ -8112,14 +7967,12 @@ issues. "docs": undefined, "properties": { "next_cursor": { - "display-name": "works-list-response", "docs": "The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist. ", "type": "optional", }, "prev_cursor": { - "display-name": "works-list-response", "docs": "The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. ", @@ -8191,7 +8044,6 @@ sort order. If not set, then no prior elements exist. "docs": undefined, "properties": { "set": { - "display-name": "works-update-request-artifact-ids", "docs": "Sets the IDs to the provided artifact IDs.", "type": "optional>", }, @@ -8204,11 +8056,9 @@ sort order. If not set, then no prior elements exist. "docs": undefined, "properties": { "priority": { - "display-name": "works-update-request-issue", "type": "optional", }, "sprint": { - "display-name": "works-update-request-issue", "docs": "Updates the sprint that the issue belongs to.", "type": "optional", }, @@ -8221,7 +8071,6 @@ sort order. If not set, then no prior elements exist. "docs": undefined, "properties": { "set": { - "display-name": "works-update-request-owned-by", "docs": "Sets the owner IDs to the provided user IDs. This must not be empty. ", @@ -8236,7 +8085,6 @@ empty. "docs": undefined, "properties": { "set": { - "display-name": "works-update-request-reported-by", "docs": "Sets the users that reported the work to the provided user IDs. ", "type": "optional>", @@ -8250,7 +8098,6 @@ empty. "docs": undefined, "properties": { "set": { - "display-name": "works-update-request-tags", "docs": "Sets the provided tags on the work item.", "type": "optional>", }, @@ -8263,18 +8110,15 @@ empty. "docs": undefined, "properties": { "group": { - "display-name": "works-update-request-ticket", "docs": "The group that the ticket is associated with.", "type": "optional", }, "rev_org": { - "display-name": "works-update-request-ticket", "docs": "Updates the Rev organization that the ticket is associated with. ", "type": "optional", }, "severity": { - "display-name": "works-update-request-ticket", "type": "optional", }, }, @@ -8295,7 +8139,6 @@ empty. }, }, "empty": { - "display-name": "empty", "type": "map", }, "enhancement": { @@ -8814,7 +8657,6 @@ disabled. "type": "string", }, "toggle": { - "display-name": "dev-org-auth-connections-toggle-request", "type": "optional", }, }, @@ -8922,12 +8764,10 @@ authenticated user. "body": { "properties": { "aud": { - "display-name": "auth-tokens-create-request", "docs": "The expected audience values with respect to the token.", "type": "optional>", }, "client_id": { - "display-name": "auth-tokens-create-request", "docs": "An identifier that represents the application which is requesting the token. If no client_id is present in the request to generate an application access token (AAT), DevRev will generate a client_id. @@ -8936,25 +8776,20 @@ This client_id is only associated with an AAT. "type": "optional", }, "expires_in": { - "display-name": "auth-tokens-create-request", "docs": "The expected validity lifetime of the token in number of days. ", "type": "optional", }, "grant_type": { - "display-name": "auth-tokens-create-request", "type": "optional", }, "requested_token_type": { - "display-name": "auth-tokens-create-request", "type": "optional", }, "rev_info": { - "display-name": "auth-tokens-create-request", "type": "optional", }, "scope": { - "display-name": "auth-tokens-create-request", "docs": "The requested set of scopes associated with the issued token. A space-delimited list of values in which the order of values does not matter. @@ -8962,18 +8797,15 @@ not matter. "type": "optional", }, "subject_token": { - "display-name": "auth-tokens-create-request", "docs": "Represents the entity that requests the token. Not required when requesting an application access token (AAT). ", "type": "optional", }, "subject_token_type": { - "display-name": "auth-tokens-create-request", "type": "optional", }, "token_hint": { - "display-name": "auth-tokens-create-request", "docs": "A hint that identifies the token.", "type": "optional", }, @@ -9014,7 +8846,6 @@ given Dev organization. "body": { "properties": { "token_id": { - "display-name": "auth-tokens-delete-request", "docs": "The unique identifier for the token under a given Dev organization. If no token ID is provided, then the token ID will be set from the JTI claim of the token in the authorization header. @@ -9217,7 +9048,6 @@ authenticated user. "body": { "properties": { "requested_token_type": { - "display-name": "auth-tokens-self-delete-request", "type": "optional", }, }, @@ -10037,7 +9867,6 @@ organization. "body": { "properties": { "description": { - "display-name": "rev-orgs-create-request", "docs": "Description of the Rev organization.", "type": "optional", }, @@ -10046,16 +9875,13 @@ organization. "type": "string", }, "domain": { - "display-name": "rev-orgs-create-request", "docs": "Company's domain name. Example - 'devrev.ai'.", "type": "optional", }, "environment": { - "display-name": "rev-orgs-create-request", "type": "optional", }, "external_ref": { - "display-name": "rev-orgs-create-request", "docs": "External ref is a custom unique identifier which is a reference to an unique id for this organization's data in some system of records. @@ -10063,7 +9889,6 @@ records. "type": "optional", }, "tier": { - "display-name": "rev-orgs-create-request", "docs": "The tier of the RevOrg.", "type": "optional", }, @@ -10375,26 +10200,21 @@ them. "body": { "properties": { "description": { - "display-name": "rev-orgs-update-request", "docs": "Description of the Rev organization.", "type": "optional", }, "display_name": { - "display-name": "rev-orgs-update-request", "docs": "Customer chosen name for the Rev organization.", "type": "optional", }, "domain": { - "display-name": "rev-orgs-update-request", "docs": "Company's domain name. Example - 'devrev.ai'.", "type": "optional", }, "environment": { - "display-name": "rev-orgs-update-request", "type": "optional", }, "external_ref": { - "display-name": "rev-orgs-update-request", "docs": "External ref is a custom unique identifier which is a reference to an unique id for this organization's data in some system of records. @@ -10406,7 +10226,6 @@ records. "type": "string", }, "tier": { - "display-name": "rev-orgs-update-request", "docs": "The tier of the RevOrg.", "type": "optional", }, @@ -10503,14 +10322,12 @@ and a logical concept denoted by the tag's name. "body": { "properties": { "allowed_values": { - "display-name": "tags-create-request", "docs": "The allowed values for the tag, or empty if no values are permitted. ", "type": "optional>", }, "description": { - "display-name": "tags-create-request", "docs": "The description for the tag.", "type": "optional", }, @@ -10786,11 +10603,9 @@ used. "body": { "properties": { "allowed_values": { - "display-name": "tags-update-request", "type": "optional", }, "description": { - "display-name": "tags-update-request", "docs": "The updated description of the tag.", "type": "optional", }, @@ -10799,7 +10614,6 @@ used. "type": "string", }, "name": { - "display-name": "tags-update-request", "docs": "The updated name of the tag. The name must be unique across all tags. ", @@ -11237,12 +11051,10 @@ used. "body": { "properties": { "event_types": { - "display-name": "webhooks-create-request", "docs": "The event types that the webhook endpoint will receive.", "type": "optional>", }, "secret": { - "display-name": "webhooks-create-request", "docs": "The secret to use when verifying webhook events. If provided, the secret must be between 8 and 32 bytes (inclusive). If not set, a secret will be automatically generated and provided in the @@ -11507,11 +11319,9 @@ response. "body": { "properties": { "action": { - "display-name": "webhooks-update-request", "type": "optional", }, "event_types": { - "display-name": "webhooks-update-request", "type": "optional", }, "id": { @@ -11519,7 +11329,6 @@ response. "type": "string", }, "secret": { - "display-name": "webhooks-update-request", "docs": "If provided, updates the secret that's used when verifying webhook events, which must be between 8 and 32 bytes (inclusive). Otherwise if empty, then a new secret is generated. If the webhook is active, @@ -11535,7 +11344,6 @@ won't receive any object events until successfully verified. }, }, "url": { - "display-name": "webhooks-update-request", "docs": "The webhook's updated URL. If the webhook is active, then the webhook's status will transition to the 'unverified' state and it won't receive any object events until successfully verified. @@ -12340,7 +12148,6 @@ organizations. "docs": "The response to getting an artifact's download URL.", "properties": { "expires_at": { - "display-name": "artifacts-locate-response", "docs": "The expiration timestamp of the URL.", "type": "optional", }, @@ -12393,16 +12200,13 @@ organizations. "docs": undefined, "properties": { "created_by": { - "display-name": "atom-base", "type": "optional", }, "created_date": { - "display-name": "atom-base", "docs": "Timestamp when the object was created.", "type": "optional", }, "display_id": { - "display-name": "atom-base", "docs": "Human-readable object ID unique to the Dev organization.", "type": "optional", }, @@ -12411,11 +12215,9 @@ organizations. "type": "string", }, "modified_by": { - "display-name": "atom-base", "type": "optional", }, "modified_date": { - "display-name": "atom-base", "docs": "Timestamp when the object was last modified.", "type": "optional", }, @@ -12428,7 +12230,6 @@ organizations. "docs": undefined, "properties": { "display_id": { - "display-name": "atom-base-summary", "docs": "Human-readable object ID unique to the Dev organization.", "type": "optional", }, @@ -12501,17 +12302,14 @@ authentication connection. ", "properties": { "client_id": { - "display-name": "auth-connection-options-azure-ad", "docs": "Client ID for the Azure authentication connection.", "type": "optional", }, "client_secret": { - "display-name": "auth-connection-options-azure-ad", "docs": "Client secret for the Azure authentication connection.", "type": "optional", }, "domain": { - "display-name": "auth-connection-options-azure-ad", "docs": "Domain URL of the Azure authentication connection.", "type": "optional", }, @@ -12526,18 +12324,15 @@ authentication connection. ", "properties": { "client_id": { - "display-name": "auth-connection-options-google-apps", "docs": "Client ID for the Google Apps authentication connection.", "type": "optional", }, "client_secret": { - "display-name": "auth-connection-options-google-apps", "docs": "Client secret for the Google Apps authentication connection. ", "type": "optional", }, "tenant_domain": { - "display-name": "auth-connection-options-google-apps", "docs": "Tenant domain URL of the Google Apps authentication connection. ", "type": "optional", @@ -12553,17 +12348,14 @@ authentication connection. ", "properties": { "client_id": { - "display-name": "auth-connection-options-oidc", "docs": "Client ID for the OIDC authentication connection.", "type": "optional", }, "client_secret": { - "display-name": "auth-connection-options-oidc", "docs": "Client secret for the OIDC authentication connection.", "type": "optional", }, "issuer": { - "display-name": "auth-connection-options-oidc", "docs": "Issuer URL of the OIDC authentication connection.", "type": "optional", }, @@ -12578,12 +12370,10 @@ authentication connection. ", "properties": { "sign_in_endpoint": { - "display-name": "auth-connection-options-saml", "docs": "Sign In endpoint for the SAML authentication connection.", "type": "optional", }, "signing_cert": { - "display-name": "auth-connection-options-saml", "docs": "Signing certificate for the SAML authentication connection. ", "type": "optional", @@ -12594,7 +12384,6 @@ authentication connection. }, }, "AuthConnectionOptionsSocial": { - "display-name": "auth-connection-options-social", "type": "map", }, "AuthConnectionToggle": { @@ -12784,7 +12573,6 @@ token type. "type": "string", }, "client_id": { - "display-name": "auth-tokens-create-response", "docs": "An identifier that represents the application which is requesting the token. Only present in a response corresponding to an application access token (AAT). @@ -12798,12 +12586,10 @@ epoch. "type": "long", }, "refresh_token": { - "display-name": "auth-tokens-create-response", "docs": "A token to refresh the issued token.", "type": "optional", }, "scope": { - "display-name": "auth-tokens-create-response", "docs": "The scopes associated with the issued token. A space-delimited list of values in which the order of values does not matter. ", @@ -12843,12 +12629,10 @@ of values in which the order of values does not matter. "docs": "Carries Rev org info.", "properties": { "display_name": { - "display-name": "auth-tokens-org-traits", "docs": "The display name of the Rev org.", "type": "optional", }, "domain": { - "display-name": "auth-tokens-org-traits", "docs": "The domain of the Rev org.", "type": "optional", }, @@ -12863,16 +12647,13 @@ issue a Rev session token. ", "properties": { "org_ref": { - "display-name": "auth-tokens-rev-info", "docs": "An identifier which uniquely identifies a Rev org.", "type": "optional", }, "org_traits": { - "display-name": "auth-tokens-rev-info", "type": "optional", }, "rev_user_id": { - "display-name": "auth-tokens-rev-info", "docs": "The unique ID of the Rev user.", "type": "optional", }, @@ -12881,7 +12662,6 @@ issue a Rev session token. "type": "string", }, "user_traits": { - "display-name": "auth-tokens-rev-info", "type": "optional", }, }, @@ -12905,17 +12685,14 @@ issue a Rev session token. "docs": "Carries Rev user info.", "properties": { "display_name": { - "display-name": "auth-tokens-user-traits", "docs": "The display name of the Rev user.", "type": "optional", }, "email": { - "display-name": "auth-tokens-user-traits", "docs": "The email address of the Rev user.", "type": "optional", }, "full_name": { - "display-name": "auth-tokens-user-traits", "docs": "The full name of the Rev user.", "type": "optional", }, @@ -13133,14 +12910,12 @@ connection. "type": "list", }, "next_cursor": { - "display-name": "dev-users-list-response", "docs": "The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist. ", "type": "optional", }, "prev_cursor": { - "display-name": "dev-users-list-response", "docs": "The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. ", @@ -13179,7 +12954,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorBadRequestBadRequest": { - "display-name": "error-bad-request-bad-request", "type": "map", }, "ErrorBadRequestInvalidEnumValue": { @@ -13215,7 +12989,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorBadRequestParseError": { - "display-name": "error-bad-request-parse-error", "type": "map", }, "ErrorBadRequestType": { @@ -13238,7 +13011,6 @@ sort order. If not set, then no prior elements exist. "type": "string", }, "reason": { - "display-name": "error-bad-request-value-not-permitted", "docs": "The reason the value isn't permitted.", "type": "optional", }, @@ -13251,7 +13023,6 @@ sort order. If not set, then no prior elements exist. "docs": undefined, "properties": { "message": { - "display-name": "error-base", "docs": "The message associated with the error.", "type": "optional", }, @@ -13271,7 +13042,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorForbiddenForbidden": { - "display-name": "error-forbidden-forbidden", "type": "map", }, "ErrorForbiddenType": "literal<"forbidden">", @@ -13286,7 +13056,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorInternalServerErrorInternalError": { - "display-name": "error-internal-server-error-internal-error", "type": "map", }, "ErrorInternalServerErrorType": "literal<"internal_error">", @@ -13301,7 +13070,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorNotFoundNotFound": { - "display-name": "error-not-found-not-found", "type": "map", }, "ErrorNotFoundType": "literal<"not_found">", @@ -13316,7 +13084,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorServiceUnavailableServiceUnavailable": { - "display-name": "error-service-unavailable-service-unavailable", "type": "map", }, "ErrorServiceUnavailableType": "literal<"service_unavailable">", @@ -13331,7 +13098,6 @@ sort order. If not set, then no prior elements exist. }, }, "ErrorTooManyRequestsTooManyRequests": { - "display-name": "error-too-many-requests-too-many-requests", "type": "map", }, "ErrorTooManyRequestsType": "literal<"too_many_requests">", @@ -13347,7 +13113,6 @@ sort order. If not set, then no prior elements exist. }, "ErrorUnauthorizedType": "literal<"unauthenticated">", "ErrorUnauthorizedUnauthenticated": { - "display-name": "error-unauthorized-unauthenticated", "type": "map", }, "EventPartCreated": { @@ -13567,7 +13332,6 @@ sort order. If not set, then no prior elements exist. }, }, "ExternalIdentity": { - "display-name": "external-identity", "docs": "External identity of a user.", "type": "map", }, @@ -13801,7 +13565,6 @@ always be returned in the specified sort-by order. "type": "list", }, "target_close_date": { - "display-name": "parts-create-request-enhancement", "docs": "Target close date by which enhancement is expected to be closed. ", "type": "optional", @@ -13824,7 +13587,6 @@ always be returned in the specified sort-by order. }, }, "PartsCreateRequestProduct": { - "display-name": "parts-create-request-product", "type": "map", }, "PartsCreateResponse": { @@ -13840,7 +13602,6 @@ always be returned in the specified sort-by order. }, }, "PartsDeleteResponse": { - "display-name": "parts-delete-response", "type": "map", }, "PartsGetResponse": { @@ -13859,7 +13620,6 @@ always be returned in the specified sort-by order. "docs": undefined, "properties": { "next_cursor": { - "display-name": "parts-list-response", "docs": "The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist. ", @@ -13870,7 +13630,6 @@ sort order. If not set, then no later elements exist. "type": "list", }, "prev_cursor": { - "display-name": "parts-list-response", "docs": "The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. ", @@ -13928,14 +13687,12 @@ sort order. If not set, then no prior elements exist. }, }, "PartsUpdateRequestCapability": { - "display-name": "parts-update-request-capability", "type": "map", }, "PartsUpdateRequestEnhancement": { "docs": undefined, "properties": { "target_close_date": { - "display-name": "parts-update-request-enhancement", "docs": "Updates the target close date of the enhancement.", "type": "optional", }, @@ -13945,14 +13702,12 @@ sort order. If not set, then no prior elements exist. }, }, "PartsUpdateRequestFeature": { - "display-name": "parts-update-request-feature", "type": "map", }, "PartsUpdateRequestOwnedBy": { "docs": undefined, "properties": { "set": { - "display-name": "parts-update-request-owned-by", "docs": "Sets the owner IDs to the provided user IDs. This must not be empty. ", @@ -13964,7 +13719,6 @@ empty. }, }, "PartsUpdateRequestProduct": { - "display-name": "parts-update-request-product", "type": "map", }, "PartsUpdateResponse": { @@ -14032,7 +13786,6 @@ organization. }, }, "RevOrgsDeleteResponse": { - "display-name": "rev-orgs-delete-response", "docs": "The response to deleting a Rev organization.", "type": "map", }, @@ -14053,14 +13806,12 @@ organization. ", "properties": { "next_cursor": { - "display-name": "rev-orgs-list-response", "docs": "The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist. ", "type": "optional", }, "prev_cursor": { - "display-name": "rev-orgs-list-response", "docs": "The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. ", @@ -14116,7 +13867,6 @@ system-generated identifier will be assigned to the user. "type": "string", }, "value": { - "display-name": "set-tag-with-value", "docs": "The value for the object's association with the tag. If specified, the value must be one that's specified in the tag's allowed values. ", @@ -14131,7 +13881,6 @@ the value must be one that's specified in the tag's allowed values. "docs": "Sets an object's initial stage.", "properties": { "name": { - "display-name": "stage-init", "docs": "The name of the stage.", "type": "optional", }, @@ -14144,7 +13893,6 @@ the value must be one that's specified in the tag's allowed values. "docs": "Updates an object's stage.", "properties": { "name": { - "display-name": "stage-update", "docs": "The updated name of the stage, otherwise unchanged if not set. ", "type": "optional", @@ -14184,7 +13932,6 @@ unique. "type": "TagSummary", }, "value": { - "display-name": "tag-with-value", "docs": "The value for the object's association with the tag.", "type": "optional", }, @@ -14206,7 +13953,6 @@ unique. }, }, "TagsDeleteResponse": { - "display-name": "tags-delete-response", "docs": "The response for deleting a tag.", "type": "map", }, @@ -14226,14 +13972,12 @@ unique. "docs": "The response to listing the tags.", "properties": { "next_cursor": { - "display-name": "tags-list-response", "docs": "The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist. ", "type": "optional", }, "prev_cursor": { - "display-name": "tags-list-response", "docs": "The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. ", @@ -14252,7 +13996,6 @@ sort order. If not set, then no prior elements exist. "docs": "Specifies an update to a tag's allowed values.", "properties": { "set": { - "display-name": "tags-update-allowed-values", "docs": "Sets the allowed values for the tag.", "type": "optional>", }, @@ -14347,21 +14090,17 @@ will appear in the response. "docs": undefined, "properties": { "artifacts": { - "display-name": "timeline-entries-create-request-timeline-comment", "docs": "The IDs of the artifacts attached to the comment.", "type": "optional>", }, "body": { - "display-name": "timeline-entries-create-request-timeline-comment", "docs": "The comment's body.", "type": "optional", }, "body_type": { - "display-name": "timeline-entries-create-request-timeline-comment", "type": "optional", }, "snap_kit_body": { - "display-name": "timeline-entries-create-request-timeline-comment", "docs": "The SnapKit body of the comment.", "type": "optional>", }, @@ -14399,14 +14138,12 @@ will appear in the response. "docs": "The response to listing timeline entries for an object.", "properties": { "next_cursor": { - "display-name": "timeline-entries-list-response", "docs": "The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist. ", "type": "optional", }, "prev_cursor": { - "display-name": "timeline-entries-list-response", "docs": "The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. ", @@ -14446,20 +14183,16 @@ sort order. If not set, then no prior elements exist. "docs": undefined, "properties": { "artifacts": { - "display-name": "timeline-entries-update-request-timeline-comment", "type": "optional", }, "body": { - "display-name": "timeline-entries-update-request-timeline-comment", "docs": "The updated comment's body.", "type": "optional", }, "body_type": { - "display-name": "timeline-entries-update-request-timeline-comment", "type": "optional", }, "snap_kit_body": { - "display-name": "timeline-entries-update-request-timeline-comment", "docs": "The SnapKit body of the comment.", "type": "optional>", }, @@ -14472,7 +14205,6 @@ sort order. If not set, then no prior elements exist. "docs": undefined, "properties": { "add": { - "display-name": "timeline-entries-update-request-timeline-comment-artifacts", "docs": "Adds the provided artifacts to the comment. An artifact cannot be added more than once, i.e. nothing is done if the artifact is already attached. Mutually exclusive with \`set\`. @@ -14480,14 +14212,12 @@ already attached. Mutually exclusive with \`set\`. "type": "optional>", }, "remove": { - "display-name": "timeline-entries-update-request-timeline-comment-artifacts", "docs": "Removes the provided artifacts from the comment. If an artifact is not present, then it's ignored. Mututally exclusive with \`set\`. ", "type": "optional>", }, "set": { - "display-name": "timeline-entries-update-request-timeline-comment-artifacts", "docs": "Sets the field to the provided artifacts.", "type": "optional>", }, @@ -14642,55 +14372,42 @@ default visibility. "type": "string", }, "part_created": { - "display-name": "webhook-event-request", "type": "optional", }, "part_deleted": { - "display-name": "webhook-event-request", "type": "optional", }, "part_updated": { - "display-name": "webhook-event-request", "type": "optional", }, "rev_org_created": { - "display-name": "webhook-event-request", "type": "optional", }, "rev_org_deleted": { - "display-name": "webhook-event-request", "type": "optional", }, "rev_org_updated": { - "display-name": "webhook-event-request", "type": "optional", }, "tag_created": { - "display-name": "webhook-event-request", "type": "optional", }, "tag_deleted": { - "display-name": "webhook-event-request", "type": "optional", }, "tag_updated": { - "display-name": "webhook-event-request", "type": "optional", }, "timeline_entry_created": { - "display-name": "webhook-event-request", "type": "optional", }, "timeline_entry_deleted": { - "display-name": "webhook-event-request", "type": "optional", }, "timeline_entry_updated": { - "display-name": "webhook-event-request", "type": "optional", }, "timestamp": { - "display-name": "webhook-event-request", "docs": "Timestamp of the webhook's invocation for the event. Note this should be used to protect against replay attacks, where the event should only be processed if the timestamp isn't stale by several @@ -14699,19 +14416,15 @@ seconds. "type": "optional", }, "type": { - "display-name": "webhook-event-request", "type": "optional", }, "verify": { - "display-name": "webhook-event-request", "type": "optional", }, "webhook_created": { - "display-name": "webhook-event-request", "type": "optional", }, "webhook_deleted": { - "display-name": "webhook-event-request", "type": "optional", }, "webhook_id": { @@ -14719,19 +14432,15 @@ seconds. "type": "string", }, "webhook_updated": { - "display-name": "webhook-event-request", "type": "optional", }, "work_created": { - "display-name": "webhook-event-request", "type": "optional", }, "work_deleted": { - "display-name": "webhook-event-request", "type": "optional", }, "work_updated": { - "display-name": "webhook-event-request", "type": "optional", }, }, @@ -14743,7 +14452,6 @@ seconds. "docs": undefined, "properties": { "challenge": { - "display-name": "webhook-event-response", "docs": "The challenge from the "verify" request, otherwise this should not be set for other request types. ", @@ -14829,7 +14537,6 @@ be set for other request types. }, }, "WebhooksDeleteResponse": { - "display-name": "webhooks-delete-response", "docs": "The response to deleting the webhook.", "type": "map", }, @@ -14871,7 +14578,6 @@ be set for other request types. "docs": undefined, "properties": { "add": { - "display-name": "webhooks-update-request-event-types", "docs": "The event types to add. If a provided event type is already set for the webhook, then nothing is done. Note this is mutually exclusive with 'set'. @@ -14879,7 +14585,6 @@ with 'set'. "type": "optional>", }, "remove": { - "display-name": "webhooks-update-request-event-types", "docs": "The event types to remove. If a provided event type isn't set for the webhook, then nothing is done. Note this is mutually exclusive with 'set'. @@ -14887,7 +14592,6 @@ with 'set'. "type": "optional>", }, "set": { - "display-name": "webhooks-update-request-event-types", "docs": "The updated event types, which will replace the webhook's current event types. Note this is mutually exclusive with 'add' and 'remove'. @@ -15023,11 +14727,9 @@ issues. "docs": undefined, "properties": { "priority": { - "display-name": "works-create-request-issue", "type": "optional", }, "sprint": { - "display-name": "works-create-request-issue", "docs": "The sprint that the issue belongs to.", "type": "optional", }, @@ -15040,17 +14742,14 @@ issues. "docs": undefined, "properties": { "group": { - "display-name": "works-create-request-ticket", "docs": "The group that the ticket is associated with.", "type": "optional", }, "rev_org": { - "display-name": "works-create-request-ticket", "docs": "The Rev organization that the ticket is associated with.", "type": "optional", }, "severity": { - "display-name": "works-create-request-ticket", "type": "optional", }, }, @@ -15071,7 +14770,6 @@ issues. }, }, "WorksDeleteResponse": { - "display-name": "works-delete-response", "type": "map", }, "WorksExportResponse": { @@ -15102,14 +14800,12 @@ issues. "docs": undefined, "properties": { "next_cursor": { - "display-name": "works-list-response", "docs": "The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist. ", "type": "optional", }, "prev_cursor": { - "display-name": "works-list-response", "docs": "The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist. ", @@ -15181,7 +14877,6 @@ sort order. If not set, then no prior elements exist. "docs": undefined, "properties": { "set": { - "display-name": "works-update-request-artifact-ids", "docs": "Sets the IDs to the provided artifact IDs.", "type": "optional>", }, @@ -15194,11 +14889,9 @@ sort order. If not set, then no prior elements exist. "docs": undefined, "properties": { "priority": { - "display-name": "works-update-request-issue", "type": "optional", }, "sprint": { - "display-name": "works-update-request-issue", "docs": "Updates the sprint that the issue belongs to.", "type": "optional", }, @@ -15211,7 +14904,6 @@ sort order. If not set, then no prior elements exist. "docs": undefined, "properties": { "set": { - "display-name": "works-update-request-owned-by", "docs": "Sets the owner IDs to the provided user IDs. This must not be empty. ", @@ -15226,7 +14918,6 @@ empty. "docs": undefined, "properties": { "set": { - "display-name": "works-update-request-reported-by", "docs": "Sets the users that reported the work to the provided user IDs. ", "type": "optional>", @@ -15240,7 +14931,6 @@ empty. "docs": undefined, "properties": { "set": { - "display-name": "works-update-request-tags", "docs": "Sets the provided tags on the work item.", "type": "optional>", }, @@ -15253,18 +14943,15 @@ empty. "docs": undefined, "properties": { "group": { - "display-name": "works-update-request-ticket", "docs": "The group that the ticket is associated with.", "type": "optional", }, "rev_org": { - "display-name": "works-update-request-ticket", "docs": "Updates the Rev organization that the ticket is associated with. ", "type": "optional", }, "severity": { - "display-name": "works-update-request-ticket", "type": "optional", }, }, @@ -15285,7 +14972,6 @@ empty. }, }, "empty": { - "display-name": "empty", "type": "map", }, "enhancement": { diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/discriminated-union-value-title.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/discriminated-union-value-title.test.ts.snap index 9fa87cfa8e9..a5e7a94b72f 100644 --- a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/discriminated-union-value-title.test.ts.snap +++ b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/discriminated-union-value-title.test.ts.snap @@ -28,7 +28,6 @@ exports[`openapi parser > discriminated-union-value-title > docs 1`] = ` "body": { "properties": { "id": { - "display-name": "A simple request title", "docs": "An optional string value. ", "type": "optional", @@ -55,7 +54,6 @@ exports[`openapi parser > discriminated-union-value-title > docs 1`] = ` ", "properties": { "value": { - "display-name": "A simple response title", "docs": "An optional numerical value. ", "type": "optional", @@ -125,7 +123,6 @@ exports[`openapi parser > discriminated-union-value-title > simple 1`] = ` "body": { "properties": { "id": { - "display-name": "A simple request title", "docs": "An optional string value. ", "type": "optional", @@ -152,7 +149,6 @@ exports[`openapi parser > discriminated-union-value-title > simple 1`] = ` ", "properties": { "value": { - "display-name": "A simple response title", "docs": "An optional numerical value. ", "type": "optional", diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/flagright.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/flagright.test.ts.snap index 34385e2b562..d03b3120d17 100644 --- a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/flagright.test.ts.snap +++ b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/flagright.test.ts.snap @@ -1246,17 +1246,14 @@ In order to make individual events retrievable, you also need to pass in a uniqu "body": { "properties": { "eventDescription": { - "display-name": "BusinessUserEvent", "docs": "Event description", "type": "optional", }, "eventId": { - "display-name": "BusinessUserEvent", "docs": "Unique event ID", "type": "optional", }, "reason": { - "display-name": "BusinessUserEvent", "docs": "Reason for the event or a state change", "type": "optional", }, @@ -1272,7 +1269,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "updatedBusinessUserAttributes": { - "display-name": "BusinessUserEvent", "type": "optional", }, "userId": { @@ -2010,17 +2006,14 @@ In order to make individual events retrievable, you also need to pass in a uniqu "body": { "properties": { "eventDescription": { - "display-name": "ConsumerUserEvent", "docs": "Event description", "type": "optional", }, "eventId": { - "display-name": "ConsumerUserEvent", "docs": "Unique event ID", "type": "optional", }, "reason": { - "display-name": "ConsumerUserEvent", "docs": "Reason for the event or a state change", "type": "optional", }, @@ -2036,7 +2029,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "updatedConsumerUserAttributes": { - "display-name": "ConsumerUserEvent", "type": "optional", }, "userId": { @@ -2070,7 +2062,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for ACH payment method", "properties": { "accountNumber": { - "display-name": "ACHDetails", "docs": "Bank account number of the individual", "type": "optional", "validation": { @@ -2081,11 +2072,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "bankAddress": { - "display-name": "ACHDetails", "type": "optional
", }, "bankName": { - "display-name": "ACHDetails", "docs": "Name of the bank", "type": "optional", "validation": { @@ -2096,17 +2085,14 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "beneficiaryName": { - "display-name": "ACHDetails", "docs": "Beneficiary name of the account", "type": "optional", }, "name": { - "display-name": "ACHDetails", "docs": "Name of the account holder", "type": "optional", }, "routingNumber": { - "display-name": "ACHDetails", "docs": "Routing number of the bank", "type": "optional", "validation": { @@ -2178,7 +2164,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "state": { - "display-name": "Address", "docs": "State of the user's residence address", "type": "optional", "validation": { @@ -2189,7 +2174,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "tags": { - "display-name": "Address", "docs": "Additional information that can be added via tags", "type": "optional>", }, @@ -2202,47 +2186,36 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "alertId": { - "display-name": "AlertClosedDetails", "type": "optional", }, "comment": { - "display-name": "AlertClosedDetails", "type": "optional", }, "reasonDescriptionForOther": { - "display-name": "AlertClosedDetails", "type": "optional>", }, "reasons": { - "display-name": "AlertClosedDetails", "type": "optional>", }, "ruleDescription": { - "display-name": "AlertClosedDetails", "type": "optional", }, "ruleId": { - "display-name": "AlertClosedDetails", "type": "optional", }, "ruleInstanceId": { - "display-name": "AlertClosedDetails", "type": "optional", }, "ruleName": { - "display-name": "AlertClosedDetails", "type": "optional", }, "status": { - "display-name": "AlertClosedDetails", "type": "optional", }, "transactionIds": { - "display-name": "AlertClosedDetails", "type": "optional>", }, "userId": { - "display-name": "AlertClosedDetails", "type": "optional", }, }, @@ -2310,11 +2283,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "childUserIds": { - "display-name": "BusinessEntityLink", "type": "optional>", }, "parentUserId": { - "display-name": "BusinessEntityLink", "type": "optional", }, }, @@ -2326,58 +2297,45 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for a business user - optional fields", "properties": { "acquisitionChannel": { - "display-name": "BusinessOptional", "type": "optional", }, "allowedPaymentMethods": { - "display-name": "BusinessOptional", "type": "optional>", }, "directors": { - "display-name": "BusinessOptional", "docs": "Director(s) of the company. Must be at least one", "type": "optional>", }, "kycStatusDetails": { - "display-name": "BusinessOptional", "type": "optional", }, "legalEntity": { - "display-name": "BusinessOptional", "type": "optional", }, "linkedEntities": { - "display-name": "BusinessOptional", "type": "optional", }, "mccDetails": { - "display-name": "BusinessOptional", "type": "optional", }, "riskLevel": { - "display-name": "BusinessOptional", "type": "optional", }, "savedPaymentDetails": { - "display-name": "BusinessOptional", "type": "optional>", }, "shareHolders": { - "display-name": "BusinessOptional", "docs": "Shareholders (beneficiaries) of the company that hold at least 25% ownership. Can be another company or an individual", "type": "optional>", }, "tags": { - "display-name": "BusinessOptional", "docs": "Additional information that can be added via tags", "type": "optional>", }, "transactionLimits": { - "display-name": "BusinessOptional", "type": "optional", }, "userStateDetails": { - "display-name": "BusinessOptional", "type": "optional", }, }, @@ -2468,27 +2426,22 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for credit or debit card details", "properties": { "3dsDone": { - "display-name": "CardDetails", "docs": "Whether 3ds was successfully enforced for the transaction", "name": "_3dsDone", "type": "optional", }, "cardAuthenticated": { - "display-name": "CardDetails", "docs": "Authentication of Card", "type": "optional", }, "cardBrand": { - "display-name": "CardDetails", "docs": "Brand of Card", "type": "optional", }, "cardExpiry": { - "display-name": "CardDetails", "type": "optional", }, "cardFingerprint": { - "display-name": "CardDetails", "docs": "Unique card fingerprint that helps identify a specific card without having to use explicit card number. This is likely available at your card payment scheme provider", "type": "optional", "validation": { @@ -2499,16 +2452,13 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "cardFunding": { - "display-name": "CardDetails", "docs": "Funding of Card", "type": "optional", }, "cardIssuedCountry": { - "display-name": "CardDetails", "type": "optional", }, "cardLast4Digits": { - "display-name": "CardDetails", "docs": "Last 4 digits of Card", "type": "optional", "validation": { @@ -2519,23 +2469,18 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "cardType": { - "display-name": "CardDetails", "type": "optional", }, "merchantDetails": { - "display-name": "CardDetails", "type": "optional", }, "nameOnCard": { - "display-name": "CardDetails", "type": "optional", }, "paymentChannel": { - "display-name": "CardDetails", "type": "optional", }, "transactionReferenceField": { - "display-name": "CardDetails", "docs": "Reference for the transaction", "type": "optional", "validation": { @@ -2589,11 +2534,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "month": { - "display-name": "CardExpiry", "type": "optional", }, "year": { - "display-name": "CardExpiry", "type": "optional", }, }, @@ -2605,19 +2548,15 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "MCC": { - "display-name": "CardMerchantDetails", "type": "optional", }, "category": { - "display-name": "CardMerchantDetails", "type": "optional", }, "city": { - "display-name": "CardMerchantDetails", "type": "optional", }, "country": { - "display-name": "CardMerchantDetails", "type": "optional", "validation": { "format": undefined, @@ -2627,15 +2566,12 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "id": { - "display-name": "CardMerchantDetails", "type": "optional", }, "postCode": { - "display-name": "CardMerchantDetails", "type": "optional", }, "state": { - "display-name": "CardMerchantDetails", "type": "optional", }, }, @@ -2653,31 +2589,24 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "caseId": { - "display-name": "CaseClosedDetails", "type": "optional", }, "comment": { - "display-name": "CaseClosedDetails", "type": "optional", }, "reasonDescriptionForOther": { - "display-name": "CaseClosedDetails", "type": "optional>", }, "reasons": { - "display-name": "CaseClosedDetails", "type": "optional>", }, "status": { - "display-name": "CaseClosedDetails", "type": "optional", }, "transactionIds": { - "display-name": "CaseClosedDetails", "type": "optional>", }, "userId": { - "display-name": "CaseClosedDetails", "type": "optional", }, }, @@ -2697,12 +2626,10 @@ In order to make individual events retrievable, you also need to pass in a uniqu "type": "CaseManagementEventCaseStatusReason", }, "caseStatusReasonDescription": { - "display-name": "CaseManagementEvent", "docs": "Case status reason description", "type": "optional", }, "eventId": { - "display-name": "CaseManagementEvent", "docs": "Event ID the case pertains to", "type": "optional", }, @@ -2718,7 +2645,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "transactionId": { - "display-name": "CaseManagementEvent", "docs": "Transaction ID the case pertains to", "type": "optional", "validation": { @@ -2729,7 +2655,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "userId": { - "display-name": "CaseManagementEvent", "docs": "User ID the case pertains to", "type": "optional", }, @@ -2764,19 +2689,15 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "checkIdentifier": { - "display-name": "CheckDetails", "type": "optional", }, "checkNumber": { - "display-name": "CheckDetails", "type": "optional", }, "deliveryStatus": { - "display-name": "CheckDetails", "type": "optional", }, "etaTimestamp": { - "display-name": "CheckDetails", "type": "optional", "validation": { "exclusiveMax": undefined, @@ -2787,11 +2708,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "name": { - "display-name": "CheckDetails", "type": "optional", }, "shippingAddress": { - "display-name": "CheckDetails", "type": "optional
", }, }, @@ -2821,15 +2740,12 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for business user company financial details", "properties": { "expectedTransactionAmountPerMonth": { - "display-name": "CompanyFinancialDetails", "type": "optional", }, "expectedTurnoverPerMonth": { - "display-name": "CompanyFinancialDetails", "type": "optional", }, "tags": { - "display-name": "CompanyFinancialDetails", "docs": "Additional information that can be added via tags", "type": "optional>", }, @@ -2842,7 +2758,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for business user company general details", "properties": { "businessIndustry": { - "display-name": "CompanyGeneralDetails", "docs": "The industry the business operates in for a business customer", "type": "optional>", }, @@ -2857,21 +2772,17 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "mainProductsServicesSold": { - "display-name": "CompanyGeneralDetails", "docs": "The key products and services provided by the company", "type": "optional>", }, "tags": { - "display-name": "CompanyGeneralDetails", "docs": "Additional information that can be added via tags", "type": "optional>", }, "userRegistrationStatus": { - "display-name": "CompanyGeneralDetails", "type": "optional", }, "userSegment": { - "display-name": "CompanyGeneralDetails", "docs": "Segmentation of the business user", "type": "optional", }, @@ -2898,7 +2809,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for business user company registration details", "properties": { "dateOfRegistration": { - "display-name": "CompanyRegistrationDetails", "type": "optional", "validation": { "format": undefined, @@ -2908,7 +2818,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "legalEntityType": { - "display-name": "CompanyRegistrationDetails", "docs": "Type of legal entity. Ex: Limited Liability", "type": "optional", }, @@ -2927,12 +2836,10 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "tags": { - "display-name": "CompanyRegistrationDetails", "docs": "Additional information that can be added via tags", "type": "optional>", }, "taxIdentifier": { - "display-name": "CompanyRegistrationDetails", "docs": "Tax ID number of the registered entity", "type": "optional", }, @@ -2955,7 +2862,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "lastName": { - "display-name": "ConsumerName", "docs": "Last name of the user", "type": "optional", "validation": { @@ -2966,7 +2872,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "middleName": { - "display-name": "ConsumerName", "docs": "Middle name of the user", "type": "optional", "validation": { @@ -3003,27 +2908,22 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for business user contact information details", "properties": { "addresses": { - "display-name": "ContactDetails", "docs": "Address(es) of the company", "type": "optional>", }, "contactNumbers": { - "display-name": "ContactDetails", "docs": "Phone numbers to contact a given business customer", "type": "optional>", }, "emailIds": { - "display-name": "ContactDetails", "docs": "Email addresses of the contacts for a given business customer", "type": "optional>", }, "faxNumbers": { - "display-name": "ContactDetails", "docs": "Fax numbers to contact a business customer", "type": "optional>", }, "websites": { - "display-name": "ContactDetails", "docs": "Website of the company", "type": "optional>", }, @@ -3596,7 +3496,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for device data", "properties": { "appVersion": { - "display-name": "DeviceData", "docs": "The version of the app your user is using on their device at a given timestamp for an event or transaction", "type": "optional", "validation": { @@ -3607,12 +3506,10 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "batteryLevel": { - "display-name": "DeviceData", "docs": "Battery level of the device used for a transaction or event at a given timestamp", "type": "optional", }, "deviceIdentifier": { - "display-name": "DeviceData", "docs": "Device identifier number", "type": "optional", "validation": { @@ -3623,17 +3520,14 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "deviceLatitude": { - "display-name": "DeviceData", "docs": "Device latitude at a give timestamp for an event or transaction", "type": "optional", }, "deviceLongitude": { - "display-name": "DeviceData", "docs": "Device longitude at a give timestamp for an event or transaction", "type": "optional", }, "deviceMaker": { - "display-name": "DeviceData", "docs": "The maker of the device at a given timestamp for an event or transaction", "type": "optional", "validation": { @@ -3644,7 +3538,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "deviceModel": { - "display-name": "DeviceData", "docs": "The model of the device at a given timestamp for an event or transaction", "type": "optional", "validation": { @@ -3655,7 +3548,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "deviceYear": { - "display-name": "DeviceData", "docs": "The year the device was manufactured at a given timestamp for an event or transaction", "type": "optional", "validation": { @@ -3666,7 +3558,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "ipAddress": { - "display-name": "DeviceData", "docs": "IP address of the device at a given timestamp for an event or transaction", "type": "optional", "validation": { @@ -3677,7 +3568,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "operatingSystem": { - "display-name": "DeviceData", "docs": "Operating system of the device at a given timestamp for an event or transaction", "type": "optional", "validation": { @@ -3688,7 +3578,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "vpnUsed": { - "display-name": "DeviceData", "docs": "Whether VPN was used at a given timestamp for an event or transaction", "type": "optional", }, @@ -3701,11 +3590,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for list of executed rules", "properties": { "labels": { - "display-name": "ExecutedRulesResult", "type": "optional>", }, "nature": { - "display-name": "ExecutedRulesResult", "type": "optional", }, "ruleAction": { @@ -3724,7 +3611,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ruleHit": "boolean", "ruleHitMeta": { - "display-name": "ExecutedRulesResult", "type": "optional", }, "ruleId": { @@ -3814,7 +3700,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for any generic bank account", "properties": { "accountNumber": { - "display-name": "GenericBankAccountDetails", "docs": "Bank account number", "type": "optional", "validation": { @@ -3825,21 +3710,17 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "accountType": { - "display-name": "GenericBankAccountDetails", "docs": "Bank account type. E.g. Checking, Savings etc.", "type": "optional", }, "bankAddress": { - "display-name": "GenericBankAccountDetails", "type": "optional
", }, "bankCode": { - "display-name": "GenericBankAccountDetails", "docs": "Unique identifier of the bank. In some countries, this can be the same as the bank's SWIFT code", "type": "optional", }, "bankName": { - "display-name": "GenericBankAccountDetails", "docs": "Name of the bank", "type": "optional", "validation": { @@ -3850,16 +3731,13 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "name": { - "display-name": "GenericBankAccountDetails", "docs": "Name of the account holder", "type": "optional", }, "paymentChannel": { - "display-name": "GenericBankAccountDetails", "type": "optional", }, "specialInstructions": { - "display-name": "GenericBankAccountDetails", "docs": "Special instructions to be specified if any", "type": "optional", }, @@ -3872,11 +3750,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for list of hit rules", "properties": { "labels": { - "display-name": "HitRulesDetails", "type": "optional>", }, "nature": { - "display-name": "HitRulesDetails", "type": "optional", }, "ruleAction": { @@ -3894,7 +3770,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "ruleHitMeta": { - "display-name": "HitRulesDetails", "type": "optional", }, "ruleId": { @@ -3927,7 +3802,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Standardized model for Bank Details", "properties": { "BIC": { - "display-name": "IBANDetails", "docs": "Identifier for the bank. Can be routing number, BIK number, SWIFT code, BIC number etc.", "type": "optional", "validation": { @@ -3938,21 +3812,17 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "IBAN": { - "display-name": "IBANDetails", "docs": "Account number of the user. Can be account number, IBAN number etc.", "type": "optional", }, "bankAddress": { - "display-name": "IBANDetails", "type": "optional
", }, "bankBranchCode": { - "display-name": "IBANDetails", "docs": "Branch code of the bank. In some countries, this can be the same as the bank's SWIFT code", "type": "optional", }, "bankName": { - "display-name": "IBANDetails", "docs": "Name of the bank", "type": "optional", "validation": { @@ -3963,20 +3833,16 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "country": { - "display-name": "IBANDetails", "type": "optional", }, "name": { - "display-name": "IBANDetails", "docs": "Name of the bank account holder", "type": "optional", }, "paymentChannel": { - "display-name": "IBANDetails", "type": "optional", }, "tags": { - "display-name": "IBANDetails", "type": "optional", }, }, @@ -4006,11 +3872,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "reason": { - "display-name": "KYCStatusDetails", "type": "optional", }, "status": { - "display-name": "KYCStatusDetails", "type": "optional", }, }, @@ -4022,7 +3886,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "LegalDocument model generalizes User's identity document type (ex: Passport)", "properties": { "documentExpirationDate": { - "display-name": "LegalDocument", "docs": "User's identity document expiration date (UNIX timestamp in milliseconds)", "type": "optional", }, @@ -4031,7 +3894,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "type": "CountryCode", }, "documentIssuedDate": { - "display-name": "LegalDocument", "docs": "User's identity document issuance date (UNIX timestamp in milliseconds)", "type": "optional", }, @@ -4056,11 +3918,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "nameOnDocument": { - "display-name": "LegalDocument", "type": "optional", }, "tags": { - "display-name": "LegalDocument", "docs": "Additional information that can be added via tags", "type": "optional>", }, @@ -4073,7 +3933,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for business user legal entity details", "properties": { "companyFinancialDetails": { - "display-name": "LegalEntity", "type": "optional", }, "companyGeneralDetails": { @@ -4081,15 +3940,12 @@ In order to make individual events retrievable, you also need to pass in a uniqu "type": "CompanyGeneralDetails", }, "companyRegistrationDetails": { - "display-name": "LegalEntity", "type": "optional", }, "contactDetails": { - "display-name": "LegalEntity", "type": "optional", }, "reasonForAccountOpening": { - "display-name": "LegalEntity", "docs": "Reason for opening the account at financial institution", "type": "optional>", }, @@ -4102,12 +3958,10 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Payload of a list, new or existed", "properties": { "items": { - "display-name": "ListData", "docs": "List items", "type": "optional>", }, "metadata": { - "display-name": "ListData", "type": "optional", }, }, @@ -4139,7 +3993,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "listId": "string", "listType": "ListType", "metadata": { - "display-name": "ListHeader", "type": "optional", }, "size": "double", @@ -4154,7 +4007,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "properties": { "key": "string", "metadata": { - "display-name": "ListItem", "type": "optional", }, }, @@ -4163,7 +4015,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "ListKeyMetadata": { - "display-name": "ListKeyMetadata", "type": "map", }, "ListMetadata": { @@ -4171,21 +4022,17 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extra-properties": true, "properties": { "checksum": { - "display-name": "ListMetadata", "type": "optional", }, "description": { - "display-name": "ListMetadata", "docs": "List description", "type": "optional", }, "name": { - "display-name": "ListMetadata", "docs": "List name", "type": "optional", }, "status": { - "display-name": "ListMetadata", "type": "optional", }, }, @@ -4229,7 +4076,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "type": "double", }, "description": { - "display-name": "MCCDetails", "docs": "Merchant Description", "type": "optional", }, @@ -4287,7 +4133,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "properties": { "isPepHit": "boolean", "pepCountry": { - "display-name": "PEPStatus", "type": "optional", "validation": { "format": undefined, @@ -4321,7 +4166,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for a generic individual - different from User model by not having userId field", "properties": { "contactDetails": { - "display-name": "Person", "type": "optional", }, "generalDetails": { @@ -4329,16 +4173,13 @@ In order to make individual events retrievable, you also need to pass in a uniqu "type": "UserDetails", }, "legalDocuments": { - "display-name": "Person", "docs": "User's legal identity documents - See Document Model for details", "type": "optional>", }, "pepStatus": { - "display-name": "Person", "type": "optional>", }, "tags": { - "display-name": "Person", "docs": "Additional information that can be added via tags", "type": "optional>", }, @@ -4419,7 +4260,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for results from Risk Scoring", "properties": { "customerRiskAssessment": { - "display-name": "RiskScoringResult", "docs": "Quantified dynamic risk score", "type": "optional", }, @@ -4546,7 +4386,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for SWIFT payment method", "properties": { "accountNumber": { - "display-name": "SWIFTDetails", "docs": "Account number", "type": "optional", "validation": { @@ -4557,16 +4396,13 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "accountType": { - "display-name": "SWIFTDetails", "docs": "Account type. E.g. Checking, Savings etc.", "type": "optional", }, "bankAddress": { - "display-name": "SWIFTDetails", "type": "optional
", }, "bankName": { - "display-name": "SWIFTDetails", "docs": "Name of the bank", "type": "optional", "validation": { @@ -4577,17 +4413,14 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "name": { - "display-name": "SWIFTDetails", "docs": "Name of the account holder", "type": "optional", }, "specialInstructions": { - "display-name": "SWIFTDetails", "docs": "Special instructions if any", "type": "optional", }, "swiftCode": { - "display-name": "SWIFTDetails", "docs": "SWIFT code of the financial institution", "type": "optional", "validation": { @@ -4611,7 +4444,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "entityType": { - "display-name": "SanctionsDetails", "type": "optional", }, "name": "string", @@ -4688,7 +4520,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for transaction amount details", "properties": { "country": { - "display-name": "TransactionAmountDetails", "type": "optional", }, "transactionAmount": { @@ -4708,19 +4539,15 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "day": { - "display-name": "TransactionAmountLimit", "type": "optional", }, "month": { - "display-name": "TransactionAmountLimit", "type": "optional", }, "week": { - "display-name": "TransactionAmountLimit", "type": "optional", }, "year": { - "display-name": "TransactionAmountLimit", "type": "optional", }, }, @@ -4732,12 +4559,10 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for transaction base Payload", "properties": { "destinationUserId": { - "display-name": "TransactionBase", "docs": "UserId for transaction's destination. In other words, where the value is being transferred to.", "type": "optional", }, "originUserId": { - "display-name": "TransactionBase", "docs": "UserId for where the transaction originates from", "type": "optional", }, @@ -4763,7 +4588,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "type": { - "display-name": "TransactionBase", "type": "optional", }, }, @@ -4775,19 +4599,15 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "day": { - "display-name": "TransactionCountLimit", "type": "optional", }, "month": { - "display-name": "TransactionCountLimit", "type": "optional", }, "week": { - "display-name": "TransactionCountLimit", "type": "optional", }, "year": { - "display-name": "TransactionCountLimit", "type": "optional", }, }, @@ -4812,15 +4632,12 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "averageTransactionAmountLimit": { - "display-name": "TransactionLimit", "type": "optional", }, "transactionAmountLimit": { - "display-name": "TransactionLimit", "type": "optional", }, "transactionCountLimit": { - "display-name": "TransactionLimit", "type": "optional", }, }, @@ -4832,31 +4649,24 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for transaction limits for a given user", "properties": { "maximumDailyTransactionLimit": { - "display-name": "TransactionLimits", "type": "optional", }, "maximumMonthlyTransactionLimit": { - "display-name": "TransactionLimits", "type": "optional", }, "maximumQuarterlyTransactionLimit": { - "display-name": "TransactionLimits", "type": "optional", }, "maximumTransactionLimit": { - "display-name": "TransactionLimits", "type": "optional", }, "maximumWeeklyTransactionLimit": { - "display-name": "TransactionLimits", "type": "optional", }, "maximumYearlyTransactionLimit": { - "display-name": "TransactionLimits", "type": "optional", }, "paymentMethodLimits": { - "display-name": "TransactionLimits", "type": "optional", }, }, @@ -4929,39 +4739,31 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for transaction additional payload", "properties": { "destinationAmountDetails": { - "display-name": "TransactionUpdatable", "type": "optional", }, "destinationPaymentDetails": { - "display-name": "TransactionUpdatable", "docs": "Payment details of the destination. It can be a bank account number, wallet ID, card fingerprint etc.", "type": "optional", }, "deviceData": { - "display-name": "TransactionUpdatable", "type": "optional", }, "originAmountDetails": { - "display-name": "TransactionUpdatable", "type": "optional", }, "originPaymentDetails": { - "display-name": "TransactionUpdatable", "docs": "Payment details of the origin. It can be a bank account number, wallet ID, card fingerprint etc.", "type": "optional", }, "productType": { - "display-name": "TransactionUpdatable", "docs": "Type of produce being used by the consumer (ex wallets, payments etc)", "type": "optional", }, "promotionCodeUsed": { - "display-name": "TransactionUpdatable", "docs": "Whether a promotion code was used or not the transaction", "type": "optional", }, "reference": { - "display-name": "TransactionUpdatable", "docs": "Reference field for the transaction indicating the purpose of the transaction etc.", "type": "optional", "validation": { @@ -4972,17 +4774,14 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "relatedTransactionIds": { - "display-name": "TransactionUpdatable", "docs": "IDs of transactions related to this transaction. Ex: refund, split bills", "type": "optional>", }, "tags": { - "display-name": "TransactionUpdatable", "docs": "Additional information that can be added via tags", "type": "optional>", }, "transactionState": { - "display-name": "TransactionUpdatable", "type": "optional", }, }, @@ -5103,7 +4902,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for UPI payment method", "properties": { "bankProvider": { - "display-name": "UPIDetails", "docs": "Bank provider name", "type": "optional", "validation": { @@ -5114,7 +4912,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "interfaceProvider": { - "display-name": "UPIDetails", "docs": "Interface provider name", "type": "optional", "validation": { @@ -5125,7 +4922,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "name": { - "display-name": "UPIDetails", "docs": "Name of the account holder", "type": "optional", }, @@ -5175,7 +4971,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "userDetails": { - "display-name": "UserBase", "type": "optional", }, "userId": { @@ -5197,15 +4992,12 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for consumer user personal details", "properties": { "countryOfNationality": { - "display-name": "UserDetails", "type": "optional", }, "countryOfResidence": { - "display-name": "UserDetails", "type": "optional", }, "dateOfBirth": { - "display-name": "UserDetails", "docs": "Date of birth of the user (YYYY-MM-DD)", "type": "optional", "validation": { @@ -5216,7 +5008,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "gender": { - "display-name": "UserDetails", "docs": "Gender of the individual - Male, Female or Non-Binary", "type": "optional", }, @@ -5259,49 +5050,38 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for User details", "properties": { "acquisitionChannel": { - "display-name": "UserOptional", "type": "optional", }, "contactDetails": { - "display-name": "UserOptional", "type": "optional", }, "kycStatusDetails": { - "display-name": "UserOptional", "type": "optional", }, "legalDocuments": { - "display-name": "UserOptional", "docs": "User's legal identity documents - See Document Model for details", "type": "optional>", }, "pepStatus": { - "display-name": "UserOptional", "type": "optional>", }, "reasonForAccountOpening": { - "display-name": "UserOptional", "type": "optional>", }, "riskLevel": { - "display-name": "UserOptional", "type": "optional", }, "tags": { - "display-name": "UserOptional", "docs": "Additional information that can be added via tags", "type": "optional>", }, "transactionLimits": { - "display-name": "UserOptional", "type": "optional", }, "userSegment": { - "display-name": "UserOptional", "type": "optional", }, "userStateDetails": { - "display-name": "UserOptional", "type": "optional", }, }, @@ -5348,7 +5128,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "reason": { - "display-name": "UserStateDetails", "type": "optional", }, "state": { @@ -5356,7 +5135,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "type": "UserState", }, "userId": { - "display-name": "UserStateDetails", "type": "optional", }, }, @@ -5381,21 +5159,17 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Standardized model for a Generic wallet transaction", "properties": { "name": { - "display-name": "WalletDetails", "docs": "Name of the account holder for a specific wallet", "type": "optional", }, "paymentChannel": { - "display-name": "WalletDetails", "docs": "Payment Channel used through wallet", "type": "optional", }, "tags": { - "display-name": "WalletDetails", "type": "optional", }, "walletId": { - "display-name": "WalletDetails", "docs": "Unique ID of the wallet", "type": "optional", "validation": { @@ -5406,7 +5180,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "walletPhoneNumber": { - "display-name": "WalletDetails", "docs": "Phone number associated with the wallet, if any", "type": "optional", }, @@ -6626,17 +6399,14 @@ In order to make individual events retrievable, you also need to pass in a uniqu "body": { "properties": { "eventDescription": { - "display-name": "BusinessUserEvent", "docs": "Event description", "type": "optional", }, "eventId": { - "display-name": "BusinessUserEvent", "docs": "Unique event ID", "type": "optional", }, "reason": { - "display-name": "BusinessUserEvent", "docs": "Reason for the event or a state change", "type": "optional", }, @@ -6652,7 +6422,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "updatedBusinessUserAttributes": { - "display-name": "BusinessUserEvent", "type": "optional", }, "userId": { @@ -7390,17 +7159,14 @@ In order to make individual events retrievable, you also need to pass in a uniqu "body": { "properties": { "eventDescription": { - "display-name": "ConsumerUserEvent", "docs": "Event description", "type": "optional", }, "eventId": { - "display-name": "ConsumerUserEvent", "docs": "Unique event ID", "type": "optional", }, "reason": { - "display-name": "ConsumerUserEvent", "docs": "Reason for the event or a state change", "type": "optional", }, @@ -7416,7 +7182,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "updatedConsumerUserAttributes": { - "display-name": "ConsumerUserEvent", "type": "optional", }, "userId": { @@ -7450,7 +7215,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for ACH payment method", "properties": { "accountNumber": { - "display-name": "ACHDetails", "docs": "Bank account number of the individual", "type": "optional", "validation": { @@ -7461,11 +7225,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "bankAddress": { - "display-name": "ACHDetails", "type": "optional
", }, "bankName": { - "display-name": "ACHDetails", "docs": "Name of the bank", "type": "optional", "validation": { @@ -7476,17 +7238,14 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "beneficiaryName": { - "display-name": "ACHDetails", "docs": "Beneficiary name of the account", "type": "optional", }, "name": { - "display-name": "ACHDetails", "docs": "Name of the account holder", "type": "optional", }, "routingNumber": { - "display-name": "ACHDetails", "docs": "Routing number of the bank", "type": "optional", "validation": { @@ -7558,7 +7317,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "state": { - "display-name": "Address", "docs": "State of the user's residence address", "type": "optional", "validation": { @@ -7569,7 +7327,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "tags": { - "display-name": "Address", "docs": "Additional information that can be added via tags", "type": "optional>", }, @@ -7582,47 +7339,36 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "alertId": { - "display-name": "AlertClosedDetails", "type": "optional", }, "comment": { - "display-name": "AlertClosedDetails", "type": "optional", }, "reasonDescriptionForOther": { - "display-name": "AlertClosedDetails", "type": "optional>", }, "reasons": { - "display-name": "AlertClosedDetails", "type": "optional>", }, "ruleDescription": { - "display-name": "AlertClosedDetails", "type": "optional", }, "ruleId": { - "display-name": "AlertClosedDetails", "type": "optional", }, "ruleInstanceId": { - "display-name": "AlertClosedDetails", "type": "optional", }, "ruleName": { - "display-name": "AlertClosedDetails", "type": "optional", }, "status": { - "display-name": "AlertClosedDetails", "type": "optional", }, "transactionIds": { - "display-name": "AlertClosedDetails", "type": "optional>", }, "userId": { - "display-name": "AlertClosedDetails", "type": "optional", }, }, @@ -7690,11 +7436,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "childUserIds": { - "display-name": "BusinessEntityLink", "type": "optional>", }, "parentUserId": { - "display-name": "BusinessEntityLink", "type": "optional", }, }, @@ -7706,58 +7450,45 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for a business user - optional fields", "properties": { "acquisitionChannel": { - "display-name": "BusinessOptional", "type": "optional", }, "allowedPaymentMethods": { - "display-name": "BusinessOptional", "type": "optional>", }, "directors": { - "display-name": "BusinessOptional", "docs": "Director(s) of the company. Must be at least one", "type": "optional>", }, "kycStatusDetails": { - "display-name": "BusinessOptional", "type": "optional", }, "legalEntity": { - "display-name": "BusinessOptional", "type": "optional", }, "linkedEntities": { - "display-name": "BusinessOptional", "type": "optional", }, "mccDetails": { - "display-name": "BusinessOptional", "type": "optional", }, "riskLevel": { - "display-name": "BusinessOptional", "type": "optional", }, "savedPaymentDetails": { - "display-name": "BusinessOptional", "type": "optional>", }, "shareHolders": { - "display-name": "BusinessOptional", "docs": "Shareholders (beneficiaries) of the company that hold at least 25% ownership. Can be another company or an individual", "type": "optional>", }, "tags": { - "display-name": "BusinessOptional", "docs": "Additional information that can be added via tags", "type": "optional>", }, "transactionLimits": { - "display-name": "BusinessOptional", "type": "optional", }, "userStateDetails": { - "display-name": "BusinessOptional", "type": "optional", }, }, @@ -7848,27 +7579,22 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for credit or debit card details", "properties": { "3dsDone": { - "display-name": "CardDetails", "docs": "Whether 3ds was successfully enforced for the transaction", "name": "_3dsDone", "type": "optional", }, "cardAuthenticated": { - "display-name": "CardDetails", "docs": "Authentication of Card", "type": "optional", }, "cardBrand": { - "display-name": "CardDetails", "docs": "Brand of Card", "type": "optional", }, "cardExpiry": { - "display-name": "CardDetails", "type": "optional", }, "cardFingerprint": { - "display-name": "CardDetails", "docs": "Unique card fingerprint that helps identify a specific card without having to use explicit card number. This is likely available at your card payment scheme provider", "type": "optional", "validation": { @@ -7879,16 +7605,13 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "cardFunding": { - "display-name": "CardDetails", "docs": "Funding of Card", "type": "optional", }, "cardIssuedCountry": { - "display-name": "CardDetails", "type": "optional", }, "cardLast4Digits": { - "display-name": "CardDetails", "docs": "Last 4 digits of Card", "type": "optional", "validation": { @@ -7899,23 +7622,18 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "cardType": { - "display-name": "CardDetails", "type": "optional", }, "merchantDetails": { - "display-name": "CardDetails", "type": "optional", }, "nameOnCard": { - "display-name": "CardDetails", "type": "optional", }, "paymentChannel": { - "display-name": "CardDetails", "type": "optional", }, "transactionReferenceField": { - "display-name": "CardDetails", "docs": "Reference for the transaction", "type": "optional", "validation": { @@ -7969,11 +7687,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "month": { - "display-name": "CardExpiry", "type": "optional", }, "year": { - "display-name": "CardExpiry", "type": "optional", }, }, @@ -7985,19 +7701,15 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "MCC": { - "display-name": "CardMerchantDetails", "type": "optional", }, "category": { - "display-name": "CardMerchantDetails", "type": "optional", }, "city": { - "display-name": "CardMerchantDetails", "type": "optional", }, "country": { - "display-name": "CardMerchantDetails", "type": "optional", "validation": { "format": undefined, @@ -8007,15 +7719,12 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "id": { - "display-name": "CardMerchantDetails", "type": "optional", }, "postCode": { - "display-name": "CardMerchantDetails", "type": "optional", }, "state": { - "display-name": "CardMerchantDetails", "type": "optional", }, }, @@ -8033,31 +7742,24 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "caseId": { - "display-name": "CaseClosedDetails", "type": "optional", }, "comment": { - "display-name": "CaseClosedDetails", "type": "optional", }, "reasonDescriptionForOther": { - "display-name": "CaseClosedDetails", "type": "optional>", }, "reasons": { - "display-name": "CaseClosedDetails", "type": "optional>", }, "status": { - "display-name": "CaseClosedDetails", "type": "optional", }, "transactionIds": { - "display-name": "CaseClosedDetails", "type": "optional>", }, "userId": { - "display-name": "CaseClosedDetails", "type": "optional", }, }, @@ -8077,12 +7779,10 @@ In order to make individual events retrievable, you also need to pass in a uniqu "type": "CaseManagementEventCaseStatusReason", }, "caseStatusReasonDescription": { - "display-name": "CaseManagementEvent", "docs": "Case status reason description", "type": "optional", }, "eventId": { - "display-name": "CaseManagementEvent", "docs": "Event ID the case pertains to", "type": "optional", }, @@ -8098,7 +7798,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "transactionId": { - "display-name": "CaseManagementEvent", "docs": "Transaction ID the case pertains to", "type": "optional", "validation": { @@ -8109,7 +7808,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "userId": { - "display-name": "CaseManagementEvent", "docs": "User ID the case pertains to", "type": "optional", }, @@ -8144,19 +7842,15 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "checkIdentifier": { - "display-name": "CheckDetails", "type": "optional", }, "checkNumber": { - "display-name": "CheckDetails", "type": "optional", }, "deliveryStatus": { - "display-name": "CheckDetails", "type": "optional", }, "etaTimestamp": { - "display-name": "CheckDetails", "type": "optional", "validation": { "exclusiveMax": undefined, @@ -8167,11 +7861,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "name": { - "display-name": "CheckDetails", "type": "optional", }, "shippingAddress": { - "display-name": "CheckDetails", "type": "optional
", }, }, @@ -8201,15 +7893,12 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for business user company financial details", "properties": { "expectedTransactionAmountPerMonth": { - "display-name": "CompanyFinancialDetails", "type": "optional", }, "expectedTurnoverPerMonth": { - "display-name": "CompanyFinancialDetails", "type": "optional", }, "tags": { - "display-name": "CompanyFinancialDetails", "docs": "Additional information that can be added via tags", "type": "optional>", }, @@ -8222,7 +7911,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for business user company general details", "properties": { "businessIndustry": { - "display-name": "CompanyGeneralDetails", "docs": "The industry the business operates in for a business customer", "type": "optional>", }, @@ -8237,21 +7925,17 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "mainProductsServicesSold": { - "display-name": "CompanyGeneralDetails", "docs": "The key products and services provided by the company", "type": "optional>", }, "tags": { - "display-name": "CompanyGeneralDetails", "docs": "Additional information that can be added via tags", "type": "optional>", }, "userRegistrationStatus": { - "display-name": "CompanyGeneralDetails", "type": "optional", }, "userSegment": { - "display-name": "CompanyGeneralDetails", "docs": "Segmentation of the business user", "type": "optional", }, @@ -8278,7 +7962,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for business user company registration details", "properties": { "dateOfRegistration": { - "display-name": "CompanyRegistrationDetails", "type": "optional", "validation": { "format": undefined, @@ -8288,7 +7971,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "legalEntityType": { - "display-name": "CompanyRegistrationDetails", "docs": "Type of legal entity. Ex: Limited Liability", "type": "optional", }, @@ -8307,12 +7989,10 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "tags": { - "display-name": "CompanyRegistrationDetails", "docs": "Additional information that can be added via tags", "type": "optional>", }, "taxIdentifier": { - "display-name": "CompanyRegistrationDetails", "docs": "Tax ID number of the registered entity", "type": "optional", }, @@ -8335,7 +8015,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "lastName": { - "display-name": "ConsumerName", "docs": "Last name of the user", "type": "optional", "validation": { @@ -8346,7 +8025,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "middleName": { - "display-name": "ConsumerName", "docs": "Middle name of the user", "type": "optional", "validation": { @@ -8383,27 +8061,22 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for business user contact information details", "properties": { "addresses": { - "display-name": "ContactDetails", "docs": "Address(es) of the company", "type": "optional>", }, "contactNumbers": { - "display-name": "ContactDetails", "docs": "Phone numbers to contact a given business customer", "type": "optional>", }, "emailIds": { - "display-name": "ContactDetails", "docs": "Email addresses of the contacts for a given business customer", "type": "optional>", }, "faxNumbers": { - "display-name": "ContactDetails", "docs": "Fax numbers to contact a business customer", "type": "optional>", }, "websites": { - "display-name": "ContactDetails", "docs": "Website of the company", "type": "optional>", }, @@ -8976,7 +8649,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for device data", "properties": { "appVersion": { - "display-name": "DeviceData", "docs": "The version of the app your user is using on their device at a given timestamp for an event or transaction", "type": "optional", "validation": { @@ -8987,12 +8659,10 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "batteryLevel": { - "display-name": "DeviceData", "docs": "Battery level of the device used for a transaction or event at a given timestamp", "type": "optional", }, "deviceIdentifier": { - "display-name": "DeviceData", "docs": "Device identifier number", "type": "optional", "validation": { @@ -9003,17 +8673,14 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "deviceLatitude": { - "display-name": "DeviceData", "docs": "Device latitude at a give timestamp for an event or transaction", "type": "optional", }, "deviceLongitude": { - "display-name": "DeviceData", "docs": "Device longitude at a give timestamp for an event or transaction", "type": "optional", }, "deviceMaker": { - "display-name": "DeviceData", "docs": "The maker of the device at a given timestamp for an event or transaction", "type": "optional", "validation": { @@ -9024,7 +8691,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "deviceModel": { - "display-name": "DeviceData", "docs": "The model of the device at a given timestamp for an event or transaction", "type": "optional", "validation": { @@ -9035,7 +8701,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "deviceYear": { - "display-name": "DeviceData", "docs": "The year the device was manufactured at a given timestamp for an event or transaction", "type": "optional", "validation": { @@ -9046,7 +8711,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "ipAddress": { - "display-name": "DeviceData", "docs": "IP address of the device at a given timestamp for an event or transaction", "type": "optional", "validation": { @@ -9057,7 +8721,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "operatingSystem": { - "display-name": "DeviceData", "docs": "Operating system of the device at a given timestamp for an event or transaction", "type": "optional", "validation": { @@ -9068,7 +8731,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "vpnUsed": { - "display-name": "DeviceData", "docs": "Whether VPN was used at a given timestamp for an event or transaction", "type": "optional", }, @@ -9081,11 +8743,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for list of executed rules", "properties": { "labels": { - "display-name": "ExecutedRulesResult", "type": "optional>", }, "nature": { - "display-name": "ExecutedRulesResult", "type": "optional", }, "ruleAction": { @@ -9104,7 +8764,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ruleHit": "boolean", "ruleHitMeta": { - "display-name": "ExecutedRulesResult", "type": "optional", }, "ruleId": { @@ -9194,7 +8853,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for any generic bank account", "properties": { "accountNumber": { - "display-name": "GenericBankAccountDetails", "docs": "Bank account number", "type": "optional", "validation": { @@ -9205,21 +8863,17 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "accountType": { - "display-name": "GenericBankAccountDetails", "docs": "Bank account type. E.g. Checking, Savings etc.", "type": "optional", }, "bankAddress": { - "display-name": "GenericBankAccountDetails", "type": "optional
", }, "bankCode": { - "display-name": "GenericBankAccountDetails", "docs": "Unique identifier of the bank. In some countries, this can be the same as the bank's SWIFT code", "type": "optional", }, "bankName": { - "display-name": "GenericBankAccountDetails", "docs": "Name of the bank", "type": "optional", "validation": { @@ -9230,16 +8884,13 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "name": { - "display-name": "GenericBankAccountDetails", "docs": "Name of the account holder", "type": "optional", }, "paymentChannel": { - "display-name": "GenericBankAccountDetails", "type": "optional", }, "specialInstructions": { - "display-name": "GenericBankAccountDetails", "docs": "Special instructions to be specified if any", "type": "optional", }, @@ -9252,11 +8903,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for list of hit rules", "properties": { "labels": { - "display-name": "HitRulesDetails", "type": "optional>", }, "nature": { - "display-name": "HitRulesDetails", "type": "optional", }, "ruleAction": { @@ -9274,7 +8923,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "ruleHitMeta": { - "display-name": "HitRulesDetails", "type": "optional", }, "ruleId": { @@ -9307,7 +8955,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Standardized model for Bank Details", "properties": { "BIC": { - "display-name": "IBANDetails", "docs": "Identifier for the bank. Can be routing number, BIK number, SWIFT code, BIC number etc.", "type": "optional", "validation": { @@ -9318,21 +8965,17 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "IBAN": { - "display-name": "IBANDetails", "docs": "Account number of the user. Can be account number, IBAN number etc.", "type": "optional", }, "bankAddress": { - "display-name": "IBANDetails", "type": "optional
", }, "bankBranchCode": { - "display-name": "IBANDetails", "docs": "Branch code of the bank. In some countries, this can be the same as the bank's SWIFT code", "type": "optional", }, "bankName": { - "display-name": "IBANDetails", "docs": "Name of the bank", "type": "optional", "validation": { @@ -9343,20 +8986,16 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "country": { - "display-name": "IBANDetails", "type": "optional", }, "name": { - "display-name": "IBANDetails", "docs": "Name of the bank account holder", "type": "optional", }, "paymentChannel": { - "display-name": "IBANDetails", "type": "optional", }, "tags": { - "display-name": "IBANDetails", "type": "optional", }, }, @@ -9386,11 +9025,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "reason": { - "display-name": "KYCStatusDetails", "type": "optional", }, "status": { - "display-name": "KYCStatusDetails", "type": "optional", }, }, @@ -9402,7 +9039,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "LegalDocument model generalizes User's identity document type (ex: Passport)", "properties": { "documentExpirationDate": { - "display-name": "LegalDocument", "docs": "User's identity document expiration date (UNIX timestamp in milliseconds)", "type": "optional", }, @@ -9411,7 +9047,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "type": "CountryCode", }, "documentIssuedDate": { - "display-name": "LegalDocument", "docs": "User's identity document issuance date (UNIX timestamp in milliseconds)", "type": "optional", }, @@ -9436,11 +9071,9 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "nameOnDocument": { - "display-name": "LegalDocument", "type": "optional", }, "tags": { - "display-name": "LegalDocument", "docs": "Additional information that can be added via tags", "type": "optional>", }, @@ -9453,7 +9086,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for business user legal entity details", "properties": { "companyFinancialDetails": { - "display-name": "LegalEntity", "type": "optional", }, "companyGeneralDetails": { @@ -9461,15 +9093,12 @@ In order to make individual events retrievable, you also need to pass in a uniqu "type": "CompanyGeneralDetails", }, "companyRegistrationDetails": { - "display-name": "LegalEntity", "type": "optional", }, "contactDetails": { - "display-name": "LegalEntity", "type": "optional", }, "reasonForAccountOpening": { - "display-name": "LegalEntity", "docs": "Reason for opening the account at financial institution", "type": "optional>", }, @@ -9482,12 +9111,10 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Payload of a list, new or existed", "properties": { "items": { - "display-name": "ListData", "docs": "List items", "type": "optional>", }, "metadata": { - "display-name": "ListData", "type": "optional", }, }, @@ -9519,7 +9146,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "listId": "string", "listType": "ListType", "metadata": { - "display-name": "ListHeader", "type": "optional", }, "size": "double", @@ -9534,7 +9160,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "properties": { "key": "string", "metadata": { - "display-name": "ListItem", "type": "optional", }, }, @@ -9543,7 +9168,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "ListKeyMetadata": { - "display-name": "ListKeyMetadata", "type": "map", }, "ListMetadata": { @@ -9551,21 +9175,17 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extra-properties": true, "properties": { "checksum": { - "display-name": "ListMetadata", "type": "optional", }, "description": { - "display-name": "ListMetadata", "docs": "List description", "type": "optional", }, "name": { - "display-name": "ListMetadata", "docs": "List name", "type": "optional", }, "status": { - "display-name": "ListMetadata", "type": "optional", }, }, @@ -9609,7 +9229,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "type": "double", }, "description": { - "display-name": "MCCDetails", "docs": "Merchant Description", "type": "optional", }, @@ -9667,7 +9286,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "properties": { "isPepHit": "boolean", "pepCountry": { - "display-name": "PEPStatus", "type": "optional", "validation": { "format": undefined, @@ -9701,7 +9319,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for a generic individual - different from User model by not having userId field", "properties": { "contactDetails": { - "display-name": "Person", "type": "optional", }, "generalDetails": { @@ -9709,16 +9326,13 @@ In order to make individual events retrievable, you also need to pass in a uniqu "type": "UserDetails", }, "legalDocuments": { - "display-name": "Person", "docs": "User's legal identity documents - See Document Model for details", "type": "optional>", }, "pepStatus": { - "display-name": "Person", "type": "optional>", }, "tags": { - "display-name": "Person", "docs": "Additional information that can be added via tags", "type": "optional>", }, @@ -9799,7 +9413,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for results from Risk Scoring", "properties": { "customerRiskAssessment": { - "display-name": "RiskScoringResult", "docs": "Quantified dynamic risk score", "type": "optional", }, @@ -9926,7 +9539,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for SWIFT payment method", "properties": { "accountNumber": { - "display-name": "SWIFTDetails", "docs": "Account number", "type": "optional", "validation": { @@ -9937,16 +9549,13 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "accountType": { - "display-name": "SWIFTDetails", "docs": "Account type. E.g. Checking, Savings etc.", "type": "optional", }, "bankAddress": { - "display-name": "SWIFTDetails", "type": "optional
", }, "bankName": { - "display-name": "SWIFTDetails", "docs": "Name of the bank", "type": "optional", "validation": { @@ -9957,17 +9566,14 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "name": { - "display-name": "SWIFTDetails", "docs": "Name of the account holder", "type": "optional", }, "specialInstructions": { - "display-name": "SWIFTDetails", "docs": "Special instructions if any", "type": "optional", }, "swiftCode": { - "display-name": "SWIFTDetails", "docs": "SWIFT code of the financial institution", "type": "optional", "validation": { @@ -9991,7 +9597,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "entityType": { - "display-name": "SanctionsDetails", "type": "optional", }, "name": "string", @@ -10068,7 +9673,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for transaction amount details", "properties": { "country": { - "display-name": "TransactionAmountDetails", "type": "optional", }, "transactionAmount": { @@ -10088,19 +9692,15 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "day": { - "display-name": "TransactionAmountLimit", "type": "optional", }, "month": { - "display-name": "TransactionAmountLimit", "type": "optional", }, "week": { - "display-name": "TransactionAmountLimit", "type": "optional", }, "year": { - "display-name": "TransactionAmountLimit", "type": "optional", }, }, @@ -10112,12 +9712,10 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for transaction base Payload", "properties": { "destinationUserId": { - "display-name": "TransactionBase", "docs": "UserId for transaction's destination. In other words, where the value is being transferred to.", "type": "optional", }, "originUserId": { - "display-name": "TransactionBase", "docs": "UserId for where the transaction originates from", "type": "optional", }, @@ -10143,7 +9741,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "type": { - "display-name": "TransactionBase", "type": "optional", }, }, @@ -10155,19 +9752,15 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "day": { - "display-name": "TransactionCountLimit", "type": "optional", }, "month": { - "display-name": "TransactionCountLimit", "type": "optional", }, "week": { - "display-name": "TransactionCountLimit", "type": "optional", }, "year": { - "display-name": "TransactionCountLimit", "type": "optional", }, }, @@ -10192,15 +9785,12 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "averageTransactionAmountLimit": { - "display-name": "TransactionLimit", "type": "optional", }, "transactionAmountLimit": { - "display-name": "TransactionLimit", "type": "optional", }, "transactionCountLimit": { - "display-name": "TransactionLimit", "type": "optional", }, }, @@ -10212,31 +9802,24 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for transaction limits for a given user", "properties": { "maximumDailyTransactionLimit": { - "display-name": "TransactionLimits", "type": "optional", }, "maximumMonthlyTransactionLimit": { - "display-name": "TransactionLimits", "type": "optional", }, "maximumQuarterlyTransactionLimit": { - "display-name": "TransactionLimits", "type": "optional", }, "maximumTransactionLimit": { - "display-name": "TransactionLimits", "type": "optional", }, "maximumWeeklyTransactionLimit": { - "display-name": "TransactionLimits", "type": "optional", }, "maximumYearlyTransactionLimit": { - "display-name": "TransactionLimits", "type": "optional", }, "paymentMethodLimits": { - "display-name": "TransactionLimits", "type": "optional", }, }, @@ -10309,39 +9892,31 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for transaction additional payload", "properties": { "destinationAmountDetails": { - "display-name": "TransactionUpdatable", "type": "optional", }, "destinationPaymentDetails": { - "display-name": "TransactionUpdatable", "docs": "Payment details of the destination. It can be a bank account number, wallet ID, card fingerprint etc.", "type": "optional", }, "deviceData": { - "display-name": "TransactionUpdatable", "type": "optional", }, "originAmountDetails": { - "display-name": "TransactionUpdatable", "type": "optional", }, "originPaymentDetails": { - "display-name": "TransactionUpdatable", "docs": "Payment details of the origin. It can be a bank account number, wallet ID, card fingerprint etc.", "type": "optional", }, "productType": { - "display-name": "TransactionUpdatable", "docs": "Type of produce being used by the consumer (ex wallets, payments etc)", "type": "optional", }, "promotionCodeUsed": { - "display-name": "TransactionUpdatable", "docs": "Whether a promotion code was used or not the transaction", "type": "optional", }, "reference": { - "display-name": "TransactionUpdatable", "docs": "Reference field for the transaction indicating the purpose of the transaction etc.", "type": "optional", "validation": { @@ -10352,17 +9927,14 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "relatedTransactionIds": { - "display-name": "TransactionUpdatable", "docs": "IDs of transactions related to this transaction. Ex: refund, split bills", "type": "optional>", }, "tags": { - "display-name": "TransactionUpdatable", "docs": "Additional information that can be added via tags", "type": "optional>", }, "transactionState": { - "display-name": "TransactionUpdatable", "type": "optional", }, }, @@ -10483,7 +10055,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for UPI payment method", "properties": { "bankProvider": { - "display-name": "UPIDetails", "docs": "Bank provider name", "type": "optional", "validation": { @@ -10494,7 +10065,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "interfaceProvider": { - "display-name": "UPIDetails", "docs": "Interface provider name", "type": "optional", "validation": { @@ -10505,7 +10075,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "name": { - "display-name": "UPIDetails", "docs": "Name of the account holder", "type": "optional", }, @@ -10555,7 +10124,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "userDetails": { - "display-name": "UserBase", "type": "optional", }, "userId": { @@ -10577,15 +10145,12 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for consumer user personal details", "properties": { "countryOfNationality": { - "display-name": "UserDetails", "type": "optional", }, "countryOfResidence": { - "display-name": "UserDetails", "type": "optional", }, "dateOfBirth": { - "display-name": "UserDetails", "docs": "Date of birth of the user (YYYY-MM-DD)", "type": "optional", "validation": { @@ -10596,7 +10161,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "gender": { - "display-name": "UserDetails", "docs": "Gender of the individual - Male, Female or Non-Binary", "type": "optional", }, @@ -10639,49 +10203,38 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Model for User details", "properties": { "acquisitionChannel": { - "display-name": "UserOptional", "type": "optional", }, "contactDetails": { - "display-name": "UserOptional", "type": "optional", }, "kycStatusDetails": { - "display-name": "UserOptional", "type": "optional", }, "legalDocuments": { - "display-name": "UserOptional", "docs": "User's legal identity documents - See Document Model for details", "type": "optional>", }, "pepStatus": { - "display-name": "UserOptional", "type": "optional>", }, "reasonForAccountOpening": { - "display-name": "UserOptional", "type": "optional>", }, "riskLevel": { - "display-name": "UserOptional", "type": "optional", }, "tags": { - "display-name": "UserOptional", "docs": "Additional information that can be added via tags", "type": "optional>", }, "transactionLimits": { - "display-name": "UserOptional", "type": "optional", }, "userSegment": { - "display-name": "UserOptional", "type": "optional", }, "userStateDetails": { - "display-name": "UserOptional", "type": "optional", }, }, @@ -10728,7 +10281,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": undefined, "properties": { "reason": { - "display-name": "UserStateDetails", "type": "optional", }, "state": { @@ -10736,7 +10288,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu "type": "UserState", }, "userId": { - "display-name": "UserStateDetails", "type": "optional", }, }, @@ -10761,21 +10312,17 @@ In order to make individual events retrievable, you also need to pass in a uniqu "docs": "Standardized model for a Generic wallet transaction", "properties": { "name": { - "display-name": "WalletDetails", "docs": "Name of the account holder for a specific wallet", "type": "optional", }, "paymentChannel": { - "display-name": "WalletDetails", "docs": "Payment Channel used through wallet", "type": "optional", }, "tags": { - "display-name": "WalletDetails", "type": "optional", }, "walletId": { - "display-name": "WalletDetails", "docs": "Unique ID of the wallet", "type": "optional", "validation": { @@ -10786,7 +10333,6 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, }, "walletPhoneNumber": { - "display-name": "WalletDetails", "docs": "Phone number associated with the wallet, if any", "type": "optional", }, diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/humanloop.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/humanloop.test.ts.snap index fc4baa6ec60..2862f76a539 100644 --- a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/humanloop.test.ts.snap +++ b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/humanloop.test.ts.snap @@ -199,7 +199,6 @@ exists, it will be ignored.", "body": { "properties": { "action": { - "display-name": "DatasetRequest", "docs": "The action to take with the provided Datapoints. - If \`"set"\`, the created version will only contain the Datapoints provided in this request. @@ -210,7 +209,6 @@ If \`"add"\` or \`"remove"\`, one of the \`version_id\` or \`environment\` query "type": "optional", }, "commit_message": { - "display-name": "DatasetRequest", "docs": "Message describing the changes made. If provided, a committed version of the Dataset is created. Otherwise, an uncommitted version is created.", "type": "optional", }, @@ -220,7 +218,6 @@ If \`"add"\` or \`"remove"\`, one of the \`version_id\` or \`environment\` query "type": "list", }, "name": { - "display-name": "DatasetRequest", "docs": "Name of the Dataset, which is used as a unique identifier.", "type": "optional", }, @@ -755,7 +752,6 @@ By default the deployed version of the Dataset is returned. Use the query parame "body": { "properties": { "name": { - "display-name": "UpdateDatasetRequest", "docs": "Name of the Dataset, which is used as a unique identifier.", "type": "optional", }, @@ -1710,17 +1706,14 @@ an exception will be raised.", "body": { "properties": { "commit_message": { - "display-name": "EvaluatorRequest", "docs": "Message describing the changes made.", "type": "optional", }, "directory_id": { - "display-name": "EvaluatorRequest", "docs": "Unique identifier for the Directory of the Evaluator.", "type": "optional", }, "name": { - "display-name": "EvaluatorRequest", "docs": "Name of the Evaluator, which is used as a unique identifier.", "type": "optional", }, @@ -1963,7 +1956,6 @@ an exception will be raised.", "body": { "properties": { "datapoint_ids": { - "display-name": "RunSyncEvaluationRequest", "docs": "The IDs of the evaluation datapoints on which to run the draft evaluator. ", "type": "optional>", }, @@ -1972,7 +1964,6 @@ an exception will be raised.", "type": "Evaluator", }, "evaluator_version_id": { - "display-name": "RunSyncEvaluationRequest", "docs": "The ID of the Evaluator Version being debugged if it already exists and is being edited.", "type": "optional", }, @@ -1981,12 +1972,10 @@ an exception will be raised.", "type": "string", }, "log_ids": { - "display-name": "RunSyncEvaluationRequest", "docs": "The IDs of the logs on which to run the draft evaluator.Provide one of \`log_ids\` or \`datapoint_ids\`.", "type": "optional>", }, "prompt_version_id": { - "display-name": "RunSyncEvaluationRequest", "docs": "The ID of the Prompt Version to use generate datapoints for the evaluation datapoints. Only required if \`datapoint\` is provided; has no effect otherwise.", "type": "optional", }, @@ -2490,12 +2479,10 @@ By default the deployed version of the Evaluator is returned. Use the query para "body": { "properties": { "directory_id": { - "display-name": "UpdateEvaluatorRequest", "docs": "Unique identifier for the Directory of the Evaluator.", "type": "optional", }, "name": { - "display-name": "UpdateEvaluatorRequest", "docs": "Name of the Evaluator, which is used as a unique identifier.", "type": "optional", }, @@ -3093,7 +3080,6 @@ in the case where you are storing or deriving your Prompt details in code.", "body": { "properties": { "batches": { - "display-name": "PromptCallRequest", "docs": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations", "type": "optional>", }, @@ -3103,86 +3089,70 @@ in the case where you are storing or deriving your Prompt details in code.", "type": "optional", }, "inputs": { - "display-name": "PromptCallRequest", "docs": "The inputs passed to the prompt template.", "type": "optional>", }, "logprobs": { - "display-name": "PromptCallRequest", "docs": "Include the log probabilities of the top n tokens in the provider_response", "type": "optional", }, "messages": { - "display-name": "PromptCallRequest", "docs": "The messages passed to the to provider chat endpoint.", "type": "optional>", }, "metadata": { - "display-name": "PromptCallRequest", "docs": "Any additional metadata to record.", "type": "optional>", }, "num_samples": { "default": 1, - "display-name": "PromptCallRequest", "docs": "The number of generations.", "type": "optional", }, "parent_id": { - "display-name": "PromptCallRequest", "docs": "Unique identifier for the parent Log in a Session. Should only be provided if \`session_id\` is provided. If provided, the Log will be nested under the parent Log within the Session.", "type": "optional", }, "prompt": { - "display-name": "PromptCallRequest", "docs": "Details of your Prompt. A new Prompt version will be created if the provided details are new.", "type": "optional", }, "provider_api_keys": { - "display-name": "PromptCallRequest", "docs": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization.", "type": "optional", }, "return_inputs": { "default": true, - "display-name": "PromptCallRequest", "docs": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true.", "type": "optional", }, "save": { "default": true, - "display-name": "PromptCallRequest", "docs": "Whether the request/response payloads will be stored on Humanloop.", "type": "optional", }, "session_id": { - "display-name": "PromptCallRequest", "docs": "Unique identifier for the Session to associate the Log to. Allows you to record multiple Logs to a Session (using an ID kept by your internal systems) by passing the same \`session_id\` in subsequent log requests. ", "type": "optional", }, "source": { - "display-name": "PromptCallRequest", "docs": "Identifies where the model was called from.", "type": "optional", }, "source_datapoint_id": { - "display-name": "PromptCallRequest", "docs": "Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.", "type": "optional", }, "stream": { "default": false, - "display-name": "PromptCallRequest", "docs": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently.", "type": "optional", }, "suffix": { - "display-name": "PromptCallRequest", "docs": "The suffix that comes after a completion of inserted text. Useful for completions that act like inserts.", "type": "optional", }, "tool_choice": { - "display-name": "PromptCallRequest", "docs": "Controls how the model uses tools. The following options are supported: - \`'none'\` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt. - \`'auto'\` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt. @@ -3191,7 +3161,6 @@ in the case where you are storing or deriving your Prompt details in code.", "type": "optional", }, "user": { - "display-name": "PromptCallRequest", "docs": "End-user ID related to the Log.", "type": "optional", }, @@ -3425,34 +3394,28 @@ an exception will be raised.", "body": { "properties": { "commit_message": { - "display-name": "PromptRequest", "docs": "Message describing the changes made.", "type": "optional", }, "directory_id": { - "display-name": "PromptRequest", "docs": "Unique identifier for the Directory of the Prompt. ", "type": "optional", }, "endpoint": { - "display-name": "PromptRequest", "docs": "The provider model endpoint used.", "type": "optional", }, "frequency_penalty": { "default": 0, - "display-name": "PromptRequest", "docs": "Number between -2.0 and 2.0. Positive values penalize new tokens based on how frequently they appear in the generation so far.", "type": "optional", }, "linked_tools": { - "display-name": "PromptRequest", "docs": "The IDs of the Tools in your organization that the model can choose to call if Tool calling is supported. The default deployed version of that tool is called.", "type": "optional>", }, "max_tokens": { "default": -1, - "display-name": "PromptRequest", "docs": "The maximum number of tokens to generate. Provide max_tokens=-1 to dynamically calculate the maximum number of tokens to generate given the length of the prompt", "type": "optional", }, @@ -3461,60 +3424,49 @@ an exception will be raised.", "type": "string", }, "name": { - "display-name": "PromptRequest", "docs": "Name of the Prompt, which is used as a unique identifier.", "type": "optional", }, "other": { - "display-name": "PromptRequest", "docs": "Other parameter values to be passed to the provider call.", "type": "optional>", }, "presence_penalty": { "default": 0, - "display-name": "PromptRequest", "docs": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the generation so far.", "type": "optional", }, "provider": { - "display-name": "PromptRequest", "docs": "The company providing the underlying model service.", "type": "optional", }, "response_format": { - "display-name": "PromptRequest", "docs": "The format of the response. Only \`{"type": "json_object"}\` is currently supported for chat.", "type": "optional", }, "seed": { - "display-name": "PromptRequest", "docs": "If specified, model will make a best effort to sample deterministically, but it is not guaranteed.", "type": "optional", }, "stop": { - "display-name": "PromptRequest", "docs": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", "type": "optional", }, "temperature": { "default": 1, - "display-name": "PromptRequest", "docs": "What sampling temperature to use when making a generation. Higher values means the model will be more creative.", "type": "optional", }, "template": { - "display-name": "PromptRequest", "docs": "For chat endpoint, provide a Chat template. For completion endpoint, provide a Prompt template. Input variables within the template should be specified with double curly bracket syntax: {{INPUT_NAME}}.", "type": "optional