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] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Nasser Anssari <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Mohammad Noor Abu Khleif <[email protected]>

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"
   }
 }

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 \&quot;Hello $partnerName\&quot; response for an authenticated request
 <Greeting>
 
@@ -52,7 +54,3 @@ ExpediaGroupApiError
 #### Throws
 
 ExpediaGroupApiError
-
-#### Defined in
-
-client/apis/ExemplarClient.ts:66

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 |
+| <a id="endpoint-1"></a> `endpoint` | `readonly` | `string` | `Constant.ENDPOINT` | core/src/client/AxiosClientConfigurations.ts:25 |
+| <a id="requesttimeout-1"></a> `requestTimeout` | `readonly` | `number` | `Constant.TEN_SECONDS_IN_MILLIS` | core/src/client/AxiosClientConfigurations.ts:26 |

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)

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)

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 |
+| <a id="authendpoint"></a> `authEndpoint?` | `string` | core/src/client/Client.ts:66 |
+| <a id="endpoint"></a> `endpoint?` | `string` | core/src/client/Client.ts:65 |
+| <a id="key"></a> `key` | `string` | core/src/client/Client.ts:67 |
+| <a id="requesttimeout"></a> `requestTimeout?` | `number` | core/src/client/Client.ts:69 |
+| <a id="secret"></a> `secret` | `string` | core/src/client/Client.ts:68 |

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)

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 |
+| <a id="detail"></a> `detail` | `string` | A human-readable explanation of the cause, specific to this cause occurrence. | models/ErrorCause.ts:37 |
+| <a id="location"></a> `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 |
+| <a id="name"></a> `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 |
+| <a id="type"></a> `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 |
+| <a id="value"></a> `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 |

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 |
+| <a id="message"></a> `message?` | `string` | models/Greeting.ts:26 |

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 |
+| <a id="causes"></a> `causes?` | [`ErrorCause`](ErrorCause.md)[] | An array of cause objects, that identify the specific causes of the error. | models/ModelError.ts:48 |
+| <a id="detail"></a> `detail` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/ModelError.ts:40 |
+| <a id="type"></a> `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 |

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)

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 |
+| <a id="detail"></a> `detail` | `string` | models/ErrorCause.ts:67 |
+| <a id="location"></a> `location?` | [`ErrorCauseLocationEnum`](../type-aliases/ErrorCauseLocationEnum.md) | models/ErrorCause.ts:68 |
+| <a id="name"></a> `name?` | `string` | models/ErrorCause.ts:69 |
+| <a id="type"></a> `type` | `string` | models/ErrorCause.ts:66 |
+| <a id="value"></a> `value?` | `string` | models/ErrorCause.ts:70 |

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 |
+| <a id="message"></a> `message?` | `string` | models/Greeting.ts:34 |

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 |
+| <a id="causes"></a> `causes?` | [`ErrorCause`](../classes/ErrorCause.md)[] | models/ModelError.ts:60 |
+| <a id="detail"></a> `detail` | `string` | models/ModelError.ts:59 |
+| <a id="type"></a> `type` | `string` | models/ModelError.ts:58 |

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