From 0b8146e794258b31b9f0836e0fb1c934561b4b11 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 28 Nov 2024 11:12:17 +0000 Subject: [PATCH 1/3] chore(deps-dev): Bump typedoc and typedoc-plugin-markdown Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) and [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown). These dependencies needed to be updated together. Updates `typedoc` from 0.26.11 to 0.27.1 - [Release notes](https://github.com/TypeStrong/TypeDoc/releases) - [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md) - [Commits](https://github.com/TypeStrong/TypeDoc/compare/v0.26.11...v0.27.1) Updates `typedoc-plugin-markdown` from 4.2.10 to 4.3.0 - [Release notes](https://github.com/typedoc2md/typedoc-plugin-markdown/releases) - [Changelog](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/CHANGELOG.md) - [Commits](https://github.com/typedoc2md/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@4.3.0/packages/typedoc-plugin-markdown) --- updated-dependencies: - dependency-name: typedoc dependency-type: direct:development update-type: version-update:semver-minor - dependency-name: typedoc-plugin-markdown dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- generator/src/main/resources/dependencies/package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/generator/src/main/resources/dependencies/package.json b/generator/src/main/resources/dependencies/package.json index 5745168f..bf5f0a86 100644 --- a/generator/src/main/resources/dependencies/package.json +++ b/generator/src/main/resources/dependencies/package.json @@ -12,8 +12,8 @@ "devDependencies": { "prettier": "3.4.1", "prettier-plugin-organize-imports": "4.1.0", - "typedoc": "0.26.11", - "typedoc-plugin-markdown": "4.2.10", + "typedoc": "0.27.1", + "typedoc-plugin-markdown": "4.3.0", "typedoc-plugin-missing-exports": "3.1.0" } } From c7d2d1811b651aa60801a8be3c9bf110552aa423 Mon Sep 17 00:00:00 2001 From: Nasser Anssari Date: Sun, 1 Dec 2024 17:16:56 +0300 Subject: [PATCH 2/3] fix: remove removed typedoc option --- .../main/resources/templates/expediagroup-sdk/typedoc.mustache | 1 - 1 file changed, 1 deletion(-) diff --git a/generator/src/main/resources/templates/expediagroup-sdk/typedoc.mustache b/generator/src/main/resources/templates/expediagroup-sdk/typedoc.mustache index d855841a..7c43f0f3 100644 --- a/generator/src/main/resources/templates/expediagroup-sdk/typedoc.mustache +++ b/generator/src/main/resources/templates/expediagroup-sdk/typedoc.mustache @@ -10,7 +10,6 @@ "excludeInternal": true, "excludeExternals": true, "excludeReferences": true, - "hideParameterTypesInTitle": true, "hideGenerator": true, "githubPages": false, "readme": "none", From 58d3e94a5cb53a8a9c084f6cfe52f373d7dece3d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sun, 1 Dec 2024 14:18:58 +0000 Subject: [PATCH 3/3] chore(docs): update docs --- .../exemplar-docs/client/classes/ExemplarClient.md | 4 +++- .../client/core/classes/AxiosClientConfigurations.md | 8 ++++++-- .../resources/exemplar-docs/models/classes/ErrorCause.md | 4 +++- .../resources/exemplar-docs/models/classes/Greeting.md | 4 +++- .../resources/exemplar-docs/models/classes/ModelError.md | 4 +++- 5 files changed, 18 insertions(+), 6 deletions(-) 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 0b5590c8..0acf03f0 100644 --- a/generator/src/test/resources/exemplar-docs/client/classes/ExemplarClient.md +++ b/generator/src/test/resources/exemplar-docs/client/classes/ExemplarClient.md @@ -14,7 +14,9 @@ #### Parameters -• **configurations**: [`ClientConfigurations`](../core/interfaces/ClientConfigurations.md) +##### configurations + +[`ClientConfigurations`](../core/interfaces/ClientConfigurations.md) #### Returns 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 21bb4437..35743a72 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 @@ -10,9 +10,13 @@ #### Parameters -• **endpoint**: `string` = `Constant.ENDPOINT` +##### endpoint -• **requestTimeout**: `number` = `Constant.TEN_SECONDS_IN_MILLIS` +`string` = `Constant.ENDPOINT` + +##### requestTimeout + +`number` = `Constant.TEN_SECONDS_IN_MILLIS` #### Returns 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 238381fe..e35d73d7 100644 --- a/generator/src/test/resources/exemplar-docs/models/classes/ErrorCause.md +++ b/generator/src/test/resources/exemplar-docs/models/classes/ErrorCause.md @@ -12,7 +12,9 @@ The object used to describe a cause for an error, containing both human-readable #### Parameters -• **errorCause**: [`ErrorCauseProperties`](../interfaces/ErrorCauseProperties.md) +##### errorCause + +[`ErrorCauseProperties`](../interfaces/ErrorCauseProperties.md) #### Returns 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 3717b457..750bbf67 100644 --- a/generator/src/test/resources/exemplar-docs/models/classes/Greeting.md +++ b/generator/src/test/resources/exemplar-docs/models/classes/Greeting.md @@ -10,7 +10,9 @@ #### Parameters -• **greeting**: [`GreetingProperties`](../interfaces/GreetingProperties.md) +##### greeting + +[`GreetingProperties`](../interfaces/GreetingProperties.md) #### Returns 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 3c45913d..60687900 100644 --- a/generator/src/test/resources/exemplar-docs/models/classes/ModelError.md +++ b/generator/src/test/resources/exemplar-docs/models/classes/ModelError.md @@ -12,7 +12,9 @@ The object used the describe an error, containing both human-readable and in a m #### Parameters -• **error**: [`ModelErrorProperties`](../interfaces/ModelErrorProperties.md) +##### error + +[`ModelErrorProperties`](../interfaces/ModelErrorProperties.md) #### Returns