feat(openapi): add @public tag to all 11 master express operations

starfy84 · starfy84 · commit 8c7e5dbe5e54 · 2026-05-12T21:20:27.000Z
Add @public JSDoc tag to each of the 11 route definitions so that the openapi-generator emits x-internal: false, making visibility explicit for the static-analysis lint rule. Also upgrade @api-ts/openapi-generator from ^5.7.0 (devDeps) to ^6.1.0 which supports the @public tag, and move the duplicate dependencies entry to devDependencies where it belongs. Regenerate masterBitgoExpress.json with the updated spec. Ticket: DX-1060 Session-Id: 204a12b3-8a39-467d-b9e8-9a181d38f9a7 Task-Id: d5693757-17d5-4e8d-863a-d636485f9c97
diff --git a/masterBitgoExpress.json b/masterBitgoExpress.json
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -24,7 +24,6 @@
   },
   "dependencies": {
     "@api-ts/io-ts-http": "^3.2.1",
-    "@api-ts/openapi-generator": "^6.0.1",
     "@api-ts/response": "^2.1.0",
     "@api-ts/superagent-wrapper": "^1.3.3",
     "@api-ts/typed-express-router": "2.0.0",
@@ -151,7 +150,7 @@
     "lodash": "^4.18.0"
   },
   "devDependencies": {
-    "@api-ts/openapi-generator": "^5.7.0",
+    "@api-ts/openapi-generator": "^6.1.0",
     "@commitlint/cli": "^19.8.1",
     "@semantic-release/commit-analyzer": "^11.1.0",
     "@semantic-release/release-notes-generator": "^12.1.0",
diff --git a/src/masterBitgoExpress/routers/accelerateRoute.ts b/src/masterBitgoExpress/routers/accelerateRoute.ts
@@ -86,6 +86,7 @@ const AccelerateResponse: HttpResponse = {
  *
  * @tag Advanced Wallets
  * @operationId advancedwallet.accelerate.tx
+ * @public
  */
 export const AccelerateRoute = httpRoute({
   method: 'POST',
diff --git a/src/masterBitgoExpress/routers/awmExpressHealth.ts b/src/masterBitgoExpress/routers/awmExpressHealth.ts
@@ -28,6 +28,7 @@ const PingAwmResponse: HttpResponse = {
  *
  * @tag Advanced Wallets
  * @operationId advancedwallet.mbe.awm.ping
+ * @public
  */
 const PingAwmRoute = httpRoute({
   method: 'POST',
diff --git a/src/masterBitgoExpress/routers/consolidateRoute.ts b/src/masterBitgoExpress/routers/consolidateRoute.ts
@@ -45,6 +45,7 @@ export const ConsolidateResponse: HttpResponse = {
  *
  * @tag Advanced Wallets
  * @operationId advancedwallet.consolidate
+ * @public
  */
 export const ConsolidateRoute = httpRoute({
   method: 'POST',
diff --git a/src/masterBitgoExpress/routers/consolidateUnspentsRoute.ts b/src/masterBitgoExpress/routers/consolidateUnspentsRoute.ts
@@ -84,6 +84,7 @@ export const ConsolidateUnspentsResponse: HttpResponse = {
  *
  * @tag Advanced Wallets
  * @operationId advancedwallet.consolidate.unspents
+ * @public
  */
 export const ConsolidateUnspentsRoute = httpRoute({
   method: 'POST',
diff --git a/src/masterBitgoExpress/routers/generateWalletRoute.ts b/src/masterBitgoExpress/routers/generateWalletRoute.ts
@@ -350,6 +350,7 @@ const GenerateWalletRequest = {
  *
  * @tag Advanced Wallets
  * @operationId advancedwallet.generate
+ * @public
  */
 export const WalletGenerateRoute = httpRoute({
   method: 'POST',
diff --git a/src/masterBitgoExpress/routers/healthCheck.ts b/src/masterBitgoExpress/routers/healthCheck.ts
@@ -22,6 +22,7 @@ const VersionResponse: HttpResponse = {
  *
  * @tag Advanced Wallets
  * @operationId advancedwallet.mbe.ping
+ * @public
  */
 const PingRoute = httpRoute({
   method: 'POST',
@@ -38,6 +39,7 @@ const PingRoute = httpRoute({
  *
  * @tag Advanced Wallets
  * @operationId advancedwallet.mbe.version
+ * @public
  */
 const VersionRoute = httpRoute({
   method: 'GET',
diff --git a/src/masterBitgoExpress/routers/recoveryConsolidationsRoute.ts b/src/masterBitgoExpress/routers/recoveryConsolidationsRoute.ts
@@ -127,6 +127,7 @@ const RecoveryConsolidationsWalletResponse: HttpResponse = {
  *
  * @tag Advanced Wallets
  * @operationId advancedwallet.consolidate.recovery
+ * @public
  */
 export const RecoveryConsolidationsRoute = httpRoute({
   method: 'POST',
diff --git a/src/masterBitgoExpress/routers/recoveryRoute.ts b/src/masterBitgoExpress/routers/recoveryRoute.ts
@@ -299,6 +299,7 @@ const RecoveryWalletRequest = {
  *
  * @tag Advanced Wallets
  * @operationId advancedwallet.recovery
+ * @public
  */
 export const RecoveryRoute = httpRoute({
   method: 'POST',
diff --git a/src/masterBitgoExpress/routers/sendManyRoute.ts b/src/masterBitgoExpress/routers/sendManyRoute.ts
@@ -222,6 +222,7 @@ export const SendManyResponse: HttpResponse = {
  *
  * @tag Advanced Wallets
  * @operationId advancedwallet.sendmany
+ * @public
  */
 export const SendManyRoute = httpRoute({
   method: 'POST',
diff --git a/src/masterBitgoExpress/routers/signAndSendMpcRoute.ts b/src/masterBitgoExpress/routers/signAndSendMpcRoute.ts
@@ -29,6 +29,7 @@ export const SignMpcResponse: HttpResponse = {
  *
  * @tag Advanced Wallets
  * @operationId advancedwallet.sign.tx.tss
+ * @public
  */
 export const SignAndSendMpcRoute = httpRoute({
   method: 'POST',

Original file line number	Diff line number	Diff line change
`@@ -86,6 +86,7 @@ const AccelerateResponse: HttpResponse = {`
`86`	`86`	`*`
`87`	`87`	`* @tag Advanced Wallets`
`88`	`88`	`* @operationId advancedwallet.accelerate.tx`
	`89`	`+ * @public`
`89`	`90`	`*/`
`90`	`91`	`export const AccelerateRoute = httpRoute({`
`91`	`92`	`method: 'POST',`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ const PingAwmResponse: HttpResponse = {`
`28`	`28`	`*`
`29`	`29`	`* @tag Advanced Wallets`
`30`	`30`	`* @operationId advancedwallet.mbe.awm.ping`
	`31`	`+ * @public`
`31`	`32`	`*/`
`32`	`33`	`const PingAwmRoute = httpRoute({`
`33`	`34`	`method: 'POST',`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ export const ConsolidateResponse: HttpResponse = {`
`45`	`45`	`*`
`46`	`46`	`* @tag Advanced Wallets`
`47`	`47`	`* @operationId advancedwallet.consolidate`
	`48`	`+ * @public`
`48`	`49`	`*/`
`49`	`50`	`export const ConsolidateRoute = httpRoute({`
`50`	`51`	`method: 'POST',`
Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,7 @@ export const ConsolidateUnspentsResponse: HttpResponse = {`
`84`	`84`	`*`
`85`	`85`	`* @tag Advanced Wallets`
`86`	`86`	`* @operationId advancedwallet.consolidate.unspents`
	`87`	`+ * @public`
`87`	`88`	`*/`
`88`	`89`	`export const ConsolidateUnspentsRoute = httpRoute({`
`89`	`90`	`method: 'POST',`
Original file line number	Diff line number	Diff line change
`@@ -350,6 +350,7 @@ const GenerateWalletRequest = {`
`350`	`350`	`*`
`351`	`351`	`* @tag Advanced Wallets`
`352`	`352`	`* @operationId advancedwallet.generate`
	`353`	`+ * @public`
`353`	`354`	`*/`
`354`	`355`	`export const WalletGenerateRoute = httpRoute({`
`355`	`356`	`method: 'POST',`
Original file line number	Diff line number	Diff line change
`@@ -127,6 +127,7 @@ const RecoveryConsolidationsWalletResponse: HttpResponse = {`
`127`	`127`	`*`
`128`	`128`	`* @tag Advanced Wallets`
`129`	`129`	`* @operationId advancedwallet.consolidate.recovery`
	`130`	`+ * @public`
`130`	`131`	`*/`
`131`	`132`	`export const RecoveryConsolidationsRoute = httpRoute({`
`132`	`133`	`method: 'POST',`