From a5113995d22ddc80d280ae5fbf16a62db1deff46 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 5 Jan 2025 13:19:00 +0300 Subject: [PATCH] chore(deps-dev): Bump typedoc-plugin-markdown from 4.3.3 to 4.4.1 in /generator/src/main/resources/dependencies (#519) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Nasser Anssari Co-authored-by: github-actions[bot] Co-authored-by: Mohammad Noor Abu Khleif --- .../main/resources/dependencies/package.json | 2 +- .../client/classes/ExemplarClient.md | 14 ++++++-------- .../core/classes/AxiosClientConfigurations.md | 12 ++++++------ .../client/core/classes/Client.md | 2 ++ .../exemplar-docs/client/core/index.md | 6 ++---- .../core/interfaces/ClientConfigurations.md | 12 +++++++----- .../resources/exemplar-docs/client/index.md | 6 ++---- .../exemplar-docs/models/classes/ErrorCause.md | 18 +++++++++--------- .../exemplar-docs/models/classes/Greeting.md | 10 +++++----- .../exemplar-docs/models/classes/ModelError.md | 14 +++++++------- .../resources/exemplar-docs/models/index.md | 8 +++----- .../models/interfaces/ErrorCauseProperties.md | 12 +++++++----- .../models/interfaces/GreetingProperties.md | 4 +++- .../models/interfaces/ModelErrorProperties.md | 8 +++++--- .../type-aliases/ErrorCauseLocationEnum.md | 4 +--- 15 files changed, 66 insertions(+), 66 deletions(-) diff --git a/generator/src/main/resources/dependencies/package.json b/generator/src/main/resources/dependencies/package.json index 48c21487..d9305fec 100644 --- a/generator/src/main/resources/dependencies/package.json +++ b/generator/src/main/resources/dependencies/package.json @@ -13,7 +13,7 @@ "prettier": "3.4.2", "prettier-plugin-organize-imports": "4.1.0", "typedoc": "0.27.6", - "typedoc-plugin-markdown": "4.3.3", + "typedoc-plugin-markdown": "4.4.1", "typedoc-plugin-missing-exports": "3.1.0" } } diff --git a/generator/src/test/resources/exemplar-docs/client/classes/ExemplarClient.md b/generator/src/test/resources/exemplar-docs/client/classes/ExemplarClient.md index 0acf03f0..8539511d 100644 --- a/generator/src/test/resources/exemplar-docs/client/classes/ExemplarClient.md +++ b/generator/src/test/resources/exemplar-docs/client/classes/ExemplarClient.md @@ -2,6 +2,8 @@ # Class: ExemplarClient +Defined in: client/apis/ExemplarClient.ts:37 + ## Extends - [`Client`](../core/classes/Client.md) @@ -12,6 +14,8 @@ > **new ExemplarClient**(`configurations`): [`ExemplarClient`](ExemplarClient.md) +Defined in: client/apis/ExemplarClient.ts:45 + #### Parameters ##### configurations @@ -26,16 +30,14 @@ `Client.constructor` -#### Defined in - -client/apis/ExemplarClient.ts:45 - ## Methods ### greetings() > **greetings**(): `Promise`\<[`Greeting`](../../models/classes/Greeting.md)\> +Defined in: client/apis/ExemplarClient.ts:66 + Get a \"Hello $partnerName\" response for an authenticated request @@ -52,7 +54,3 @@ ExpediaGroupApiError #### Throws ExpediaGroupApiError - -#### Defined in - -client/apis/ExemplarClient.ts:66 diff --git a/generator/src/test/resources/exemplar-docs/client/core/classes/AxiosClientConfigurations.md b/generator/src/test/resources/exemplar-docs/client/core/classes/AxiosClientConfigurations.md index 35743a72..2e691c59 100644 --- a/generator/src/test/resources/exemplar-docs/client/core/classes/AxiosClientConfigurations.md +++ b/generator/src/test/resources/exemplar-docs/client/core/classes/AxiosClientConfigurations.md @@ -2,12 +2,16 @@ # Class: AxiosClientConfigurations +Defined in: core/src/client/AxiosClientConfigurations.ts:23 + ## Constructors ### new AxiosClientConfigurations() > **new AxiosClientConfigurations**(`endpoint`, `requestTimeout`): [`AxiosClientConfigurations`](AxiosClientConfigurations.md) +Defined in: core/src/client/AxiosClientConfigurations.ts:24 + #### Parameters ##### endpoint @@ -22,13 +26,9 @@ [`AxiosClientConfigurations`](AxiosClientConfigurations.md) -#### Defined in - -core/src/client/AxiosClientConfigurations.ts:24 - ## Properties | Property | Modifier | Type | Default value | Defined in | | ------ | ------ | ------ | ------ | ------ | -| `endpoint` | `readonly` | `string` | `Constant.ENDPOINT` | core/src/client/AxiosClientConfigurations.ts:25 | -| `requestTimeout` | `readonly` | `number` | `Constant.TEN_SECONDS_IN_MILLIS` | core/src/client/AxiosClientConfigurations.ts:26 | +| `endpoint` | `readonly` | `string` | `Constant.ENDPOINT` | core/src/client/AxiosClientConfigurations.ts:25 | +| `requestTimeout` | `readonly` | `number` | `Constant.TEN_SECONDS_IN_MILLIS` | core/src/client/AxiosClientConfigurations.ts:26 | diff --git a/generator/src/test/resources/exemplar-docs/client/core/classes/Client.md b/generator/src/test/resources/exemplar-docs/client/core/classes/Client.md index 837b44e5..4194f14a 100644 --- a/generator/src/test/resources/exemplar-docs/client/core/classes/Client.md +++ b/generator/src/test/resources/exemplar-docs/client/core/classes/Client.md @@ -2,6 +2,8 @@ # Class: `abstract` Client +Defined in: core/src/client/Client.ts:28 + ## Extended by - [`ExemplarClient`](../../classes/ExemplarClient.md) diff --git a/generator/src/test/resources/exemplar-docs/client/core/index.md b/generator/src/test/resources/exemplar-docs/client/core/index.md index 0d877a6f..c6fa4636 100644 --- a/generator/src/test/resources/exemplar-docs/client/core/index.md +++ b/generator/src/test/resources/exemplar-docs/client/core/index.md @@ -2,13 +2,11 @@ # core -## Index - -### Classes +## Classes - [AxiosClientConfigurations](classes/AxiosClientConfigurations.md) - [Client](classes/Client.md) -### Interfaces +## Interfaces - [ClientConfigurations](interfaces/ClientConfigurations.md) diff --git a/generator/src/test/resources/exemplar-docs/client/core/interfaces/ClientConfigurations.md b/generator/src/test/resources/exemplar-docs/client/core/interfaces/ClientConfigurations.md index 66743156..f6b3c821 100644 --- a/generator/src/test/resources/exemplar-docs/client/core/interfaces/ClientConfigurations.md +++ b/generator/src/test/resources/exemplar-docs/client/core/interfaces/ClientConfigurations.md @@ -2,12 +2,14 @@ # Interface: ClientConfigurations +Defined in: core/src/client/Client.ts:64 + ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `authEndpoint?` | `string` | core/src/client/Client.ts:66 | -| `endpoint?` | `string` | core/src/client/Client.ts:65 | -| `key` | `string` | core/src/client/Client.ts:67 | -| `requestTimeout?` | `number` | core/src/client/Client.ts:69 | -| `secret` | `string` | core/src/client/Client.ts:68 | +| `authEndpoint?` | `string` | core/src/client/Client.ts:66 | +| `endpoint?` | `string` | core/src/client/Client.ts:65 | +| `key` | `string` | core/src/client/Client.ts:67 | +| `requestTimeout?` | `number` | core/src/client/Client.ts:69 | +| `secret` | `string` | core/src/client/Client.ts:68 | diff --git a/generator/src/test/resources/exemplar-docs/client/index.md b/generator/src/test/resources/exemplar-docs/client/index.md index 7855f4c4..fb50ab9d 100644 --- a/generator/src/test/resources/exemplar-docs/client/index.md +++ b/generator/src/test/resources/exemplar-docs/client/index.md @@ -2,12 +2,10 @@ # client -## Index - -### Modules +## Modules - [core](core/index.md) -### Classes +## Classes - [ExemplarClient](classes/ExemplarClient.md) diff --git a/generator/src/test/resources/exemplar-docs/models/classes/ErrorCause.md b/generator/src/test/resources/exemplar-docs/models/classes/ErrorCause.md index e35d73d7..673292b4 100644 --- a/generator/src/test/resources/exemplar-docs/models/classes/ErrorCause.md +++ b/generator/src/test/resources/exemplar-docs/models/classes/ErrorCause.md @@ -2,6 +2,8 @@ # Class: ErrorCause +Defined in: models/ErrorCause.ts:27 + The object used to describe a cause for an error, containing both human-readable and in a machine-readable information. ## Constructors @@ -10,6 +12,8 @@ The object used to describe a cause for an error, containing both human-readable > **new ErrorCause**(`errorCause`): [`ErrorCause`](ErrorCause.md) +Defined in: models/ErrorCause.ts:54 + #### Parameters ##### errorCause @@ -20,16 +24,12 @@ The object used to describe a cause for an error, containing both human-readable [`ErrorCause`](ErrorCause.md) -#### Defined in - -models/ErrorCause.ts:54 - ## Properties | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| `detail` | `string` | A human-readable explanation of the cause, specific to this cause occurrence. | models/ErrorCause.ts:37 | -| `location?` | [`ErrorCauseLocationEnum`](../type-aliases/ErrorCauseLocationEnum.md) | The location of the element in the request that identifies this specific cause. When specified, the `name` will be specified and when applicable, the `value` as well. Can be one of: * `header` - When an error has been identified in one of the request headers. * `path` - When an error has been identified in one of the path parameters. * `query` - When an error has been identified in one of the query parameters. * `body` - When an error has been identified in the request body. | models/ErrorCause.ts:42 | -| `name?` | `string` | The name of the element for this cause. When specified, the `location` will be specified and when applicable, the `value` as well. This name is a function of the value of the `location` property: * When the `location` is set to `header`, this will be the name of the request header (e.g. `Content-Type`). * When the `location` is set to `path`, this will be the name of the path parameter (e.g. in a path defined as `/users/{user_id}`, the value would be `user_id`). * When the `location` is set to `query`, this will be the name of the query string parameter (e.g. `offset`). * When the `location` is set to `body`, this will one of the field names specified in the body of the request. * For a top level field, it should only be set to the field name (e.g. `firstName`). * For a field in a nested object, it may contain the path to reach the field (e.g. `address.city`). * For a field in an object part of collection, it may contain the index in the collection (e.g. `permissions[0].name`). | models/ErrorCause.ts:47 | -| `type` | `string` | A URI reference, compliant with the standard EG error type format, which identifies the cause type. It provides a machine-readable identifier for the cause type. The cause type will be aligned with the error type. The URI can either be absolute or relative to the API\'s base URI. When dereferenced, it provides human-readable documentation for the cause type. | models/ErrorCause.ts:32 | -| `value?` | `string` | A string representation of the erroneous value of the element identified in `name`, perceived to be the cause of the error. When specified, the `location` and `name` should be specified as well. This value may be omitted in cases where it cannot be provided (e.g. missing require field), or the erroneous value cannot be represented as a string. | models/ErrorCause.ts:52 | +| `detail` | `string` | A human-readable explanation of the cause, specific to this cause occurrence. | models/ErrorCause.ts:37 | +| `location?` | [`ErrorCauseLocationEnum`](../type-aliases/ErrorCauseLocationEnum.md) | The location of the element in the request that identifies this specific cause. When specified, the `name` will be specified and when applicable, the `value` as well. Can be one of: * `header` - When an error has been identified in one of the request headers. * `path` - When an error has been identified in one of the path parameters. * `query` - When an error has been identified in one of the query parameters. * `body` - When an error has been identified in the request body. | models/ErrorCause.ts:42 | +| `name?` | `string` | The name of the element for this cause. When specified, the `location` will be specified and when applicable, the `value` as well. This name is a function of the value of the `location` property: * When the `location` is set to `header`, this will be the name of the request header (e.g. `Content-Type`). * When the `location` is set to `path`, this will be the name of the path parameter (e.g. in a path defined as `/users/{user_id}`, the value would be `user_id`). * When the `location` is set to `query`, this will be the name of the query string parameter (e.g. `offset`). * When the `location` is set to `body`, this will one of the field names specified in the body of the request. * For a top level field, it should only be set to the field name (e.g. `firstName`). * For a field in a nested object, it may contain the path to reach the field (e.g. `address.city`). * For a field in an object part of collection, it may contain the index in the collection (e.g. `permissions[0].name`). | models/ErrorCause.ts:47 | +| `type` | `string` | A URI reference, compliant with the standard EG error type format, which identifies the cause type. It provides a machine-readable identifier for the cause type. The cause type will be aligned with the error type. The URI can either be absolute or relative to the API\'s base URI. When dereferenced, it provides human-readable documentation for the cause type. | models/ErrorCause.ts:32 | +| `value?` | `string` | A string representation of the erroneous value of the element identified in `name`, perceived to be the cause of the error. When specified, the `location` and `name` should be specified as well. This value may be omitted in cases where it cannot be provided (e.g. missing require field), or the erroneous value cannot be represented as a string. | models/ErrorCause.ts:52 | diff --git a/generator/src/test/resources/exemplar-docs/models/classes/Greeting.md b/generator/src/test/resources/exemplar-docs/models/classes/Greeting.md index 750bbf67..132e2838 100644 --- a/generator/src/test/resources/exemplar-docs/models/classes/Greeting.md +++ b/generator/src/test/resources/exemplar-docs/models/classes/Greeting.md @@ -2,12 +2,16 @@ # Class: Greeting +Defined in: models/Greeting.ts:24 + ## Constructors ### new Greeting() > **new Greeting**(`greeting`): [`Greeting`](Greeting.md) +Defined in: models/Greeting.ts:28 + #### Parameters ##### greeting @@ -18,12 +22,8 @@ [`Greeting`](Greeting.md) -#### Defined in - -models/Greeting.ts:28 - ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `message?` | `string` | models/Greeting.ts:26 | +| `message?` | `string` | models/Greeting.ts:26 | diff --git a/generator/src/test/resources/exemplar-docs/models/classes/ModelError.md b/generator/src/test/resources/exemplar-docs/models/classes/ModelError.md index 60687900..746bc2e4 100644 --- a/generator/src/test/resources/exemplar-docs/models/classes/ModelError.md +++ b/generator/src/test/resources/exemplar-docs/models/classes/ModelError.md @@ -2,6 +2,8 @@ # Class: ModelError +Defined in: models/ModelError.ts:30 + The object used the describe an error, containing both human-readable and in a machine-readable information. ## Constructors @@ -10,6 +12,8 @@ The object used the describe an error, containing both human-readable and in a m > **new ModelError**(`error`): [`ModelError`](ModelError.md) +Defined in: models/ModelError.ts:50 + #### Parameters ##### error @@ -20,14 +24,10 @@ The object used the describe an error, containing both human-readable and in a m [`ModelError`](ModelError.md) -#### Defined in - -models/ModelError.ts:50 - ## Properties | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| `causes?` | [`ErrorCause`](ErrorCause.md)[] | An array of cause objects, that identify the specific causes of the error. | models/ModelError.ts:48 | -| `detail` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/ModelError.ts:40 | -| `type` | `string` | A URI reference, compliant with the standard EG error type format, which identifies the error type. It provides a machine-readable identifier for the error type. The error type will be aligned with the HTTP status code of the response. The URI can either be absolute or relative to the API\'s base URI. When dereferenced, it can also provide human-readable documentation for the error type. | models/ModelError.ts:35 | +| `causes?` | [`ErrorCause`](ErrorCause.md)[] | An array of cause objects, that identify the specific causes of the error. | models/ModelError.ts:48 | +| `detail` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/ModelError.ts:40 | +| `type` | `string` | A URI reference, compliant with the standard EG error type format, which identifies the error type. It provides a machine-readable identifier for the error type. The error type will be aligned with the HTTP status code of the response. The URI can either be absolute or relative to the API\'s base URI. When dereferenced, it can also provide human-readable documentation for the error type. | models/ModelError.ts:35 | diff --git a/generator/src/test/resources/exemplar-docs/models/index.md b/generator/src/test/resources/exemplar-docs/models/index.md index 99eb3de2..7add6e03 100644 --- a/generator/src/test/resources/exemplar-docs/models/index.md +++ b/generator/src/test/resources/exemplar-docs/models/index.md @@ -2,20 +2,18 @@ # models -## Index - -### Classes +## Classes - [ErrorCause](classes/ErrorCause.md) - [Greeting](classes/Greeting.md) - [ModelError](classes/ModelError.md) -### Interfaces +## Interfaces - [ErrorCauseProperties](interfaces/ErrorCauseProperties.md) - [GreetingProperties](interfaces/GreetingProperties.md) - [ModelErrorProperties](interfaces/ModelErrorProperties.md) -### Type Aliases +## Type Aliases - [ErrorCauseLocationEnum](type-aliases/ErrorCauseLocationEnum.md) diff --git a/generator/src/test/resources/exemplar-docs/models/interfaces/ErrorCauseProperties.md b/generator/src/test/resources/exemplar-docs/models/interfaces/ErrorCauseProperties.md index 1f1e73f8..d201870e 100644 --- a/generator/src/test/resources/exemplar-docs/models/interfaces/ErrorCauseProperties.md +++ b/generator/src/test/resources/exemplar-docs/models/interfaces/ErrorCauseProperties.md @@ -2,12 +2,14 @@ # Interface: ErrorCauseProperties +Defined in: models/ErrorCause.ts:65 + ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `detail` | `string` | models/ErrorCause.ts:67 | -| `location?` | [`ErrorCauseLocationEnum`](../type-aliases/ErrorCauseLocationEnum.md) | models/ErrorCause.ts:68 | -| `name?` | `string` | models/ErrorCause.ts:69 | -| `type` | `string` | models/ErrorCause.ts:66 | -| `value?` | `string` | models/ErrorCause.ts:70 | +| `detail` | `string` | models/ErrorCause.ts:67 | +| `location?` | [`ErrorCauseLocationEnum`](../type-aliases/ErrorCauseLocationEnum.md) | models/ErrorCause.ts:68 | +| `name?` | `string` | models/ErrorCause.ts:69 | +| `type` | `string` | models/ErrorCause.ts:66 | +| `value?` | `string` | models/ErrorCause.ts:70 | diff --git a/generator/src/test/resources/exemplar-docs/models/interfaces/GreetingProperties.md b/generator/src/test/resources/exemplar-docs/models/interfaces/GreetingProperties.md index 3a2260cc..35ff6834 100644 --- a/generator/src/test/resources/exemplar-docs/models/interfaces/GreetingProperties.md +++ b/generator/src/test/resources/exemplar-docs/models/interfaces/GreetingProperties.md @@ -2,8 +2,10 @@ # Interface: GreetingProperties +Defined in: models/Greeting.ts:33 + ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `message?` | `string` | models/Greeting.ts:34 | +| `message?` | `string` | models/Greeting.ts:34 | diff --git a/generator/src/test/resources/exemplar-docs/models/interfaces/ModelErrorProperties.md b/generator/src/test/resources/exemplar-docs/models/interfaces/ModelErrorProperties.md index eba3aebb..ef77c379 100644 --- a/generator/src/test/resources/exemplar-docs/models/interfaces/ModelErrorProperties.md +++ b/generator/src/test/resources/exemplar-docs/models/interfaces/ModelErrorProperties.md @@ -2,10 +2,12 @@ # Interface: ModelErrorProperties +Defined in: models/ModelError.ts:57 + ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| `causes?` | [`ErrorCause`](../classes/ErrorCause.md)[] | models/ModelError.ts:60 | -| `detail` | `string` | models/ModelError.ts:59 | -| `type` | `string` | models/ModelError.ts:58 | +| `causes?` | [`ErrorCause`](../classes/ErrorCause.md)[] | models/ModelError.ts:60 | +| `detail` | `string` | models/ModelError.ts:59 | +| `type` | `string` | models/ModelError.ts:58 | diff --git a/generator/src/test/resources/exemplar-docs/models/type-aliases/ErrorCauseLocationEnum.md b/generator/src/test/resources/exemplar-docs/models/type-aliases/ErrorCauseLocationEnum.md index 552d054a..21a1504e 100644 --- a/generator/src/test/resources/exemplar-docs/models/type-aliases/ErrorCauseLocationEnum.md +++ b/generator/src/test/resources/exemplar-docs/models/type-aliases/ErrorCauseLocationEnum.md @@ -4,6 +4,4 @@ > **ErrorCauseLocationEnum**: `"header"` \| `"path"` \| `"query"` \| `"body"` -## Defined in - -models/ErrorCause.ts:63 +Defined in: models/ErrorCause.ts:63