Skip to content

Commit 0fa06ad

Browse files
vmccartystarfy84
authored andcommitted
docs: fixed JS Doc location
Ticket: TW-138
1 parent 031e5b1 commit 0fa06ad

File tree

3 files changed

+76
-63
lines changed

3 files changed

+76
-63
lines changed

src/advancedWalletManager/routers/healthCheck.ts

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -22,31 +22,35 @@ const VersionResponse: HttpResponse = {
2222
* @operationId v1.health.ping
2323
* @private
2424
*/
25+
const PingRoute = httpRoute({
26+
method: 'POST',
27+
path: '/ping',
28+
request: httpRequest({}),
29+
response: PingResponse,
30+
description: 'Health check endpoint that returns server status',
31+
});
32+
33+
/**
34+
* Version Check
35+
*
36+
* @tag Advanced Wallets
37+
* @operationId v1.health.version
38+
* @private
39+
*/
40+
const VersionRoute = httpRoute({
41+
method: 'GET',
42+
path: '/version',
43+
request: httpRequest({}),
44+
response: VersionResponse,
45+
description: 'Returns the current version of the server',
46+
});
47+
2548
export const HealthCheckApiSpec = apiSpec({
2649
'v1.health.ping': {
27-
post: httpRoute({
28-
method: 'POST',
29-
path: '/ping',
30-
request: httpRequest({}),
31-
response: PingResponse,
32-
description: 'Health check endpoint that returns server status',
33-
}),
50+
post: PingRoute,
3451
},
35-
/**
36-
* Version Check
37-
*
38-
* @tag Advanced Wallets
39-
* @operationId v1.health.version
40-
* @private
41-
*/
4252
'v1.health.version': {
43-
get: httpRoute({
44-
method: 'GET',
45-
path: '/version',
46-
request: httpRequest({}),
47-
response: VersionResponse,
48-
description: 'Returns the current version of the server',
49-
}),
53+
get: VersionRoute,
5054
},
5155
});
5256

src/masterBitgoExpress/routers/awmExpressHealth.ts

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -36,31 +36,35 @@ const VersionAwmResponse: HttpResponse = {
3636
* @operationId v1.advancedwalletmanager.ping
3737
* @private
3838
*/
39+
const PingAwmRoute = httpRoute({
40+
method: 'POST',
41+
path: '/ping/advancedWalletManager',
42+
request: httpRequest({}),
43+
response: PingAwmResponse,
44+
description: 'Ping the advanced wallet manager server',
45+
});
46+
47+
/**
48+
* Version Check
49+
*
50+
* @tag Advanced Wallets
51+
* @operationId v1.advancedwalletmanager.version
52+
* @private
53+
*/
54+
const VersionAwmRoute = httpRoute({
55+
method: 'GET',
56+
path: '/version/advancedWalletManager',
57+
request: httpRequest({}),
58+
response: VersionAwmResponse,
59+
description: 'Get the version of the advanced wallet manager server',
60+
});
61+
3962
export const AdvancedWalletManagerHealthSpec = apiSpec({
4063
'v1.advancedwalletmanager.ping': {
41-
post: httpRoute({
42-
method: 'POST',
43-
path: '/ping/advancedWalletManager',
44-
request: httpRequest({}),
45-
response: PingAwmResponse,
46-
description: 'Ping the advanced wallet manager server',
47-
}),
64+
post: PingAwmRoute,
4865
},
49-
/**
50-
* Version Check
51-
*
52-
* @tag Advanced Wallets
53-
* @operationId v1.advancedwalletmanager.version
54-
* @private
55-
*/
5666
'v1.advancedwalletmanager.version': {
57-
get: httpRoute({
58-
method: 'GET',
59-
path: '/version/advancedWalletManager',
60-
request: httpRequest({}),
61-
response: VersionAwmResponse,
62-
description: 'Get the version of the advanced wallet manager server',
63-
}),
67+
get: VersionAwmRoute,
6468
},
6569
});
6670

src/masterBitgoExpress/routers/healthCheck.ts

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -22,31 +22,36 @@ const VersionResponse: HttpResponse = {
2222
* @operationId v1.health.ping
2323
* @private
2424
*/
25+
const PingRoute = httpRoute({
26+
method: 'POST',
27+
path: '/ping',
28+
request: httpRequest({}),
29+
response: PingResponse,
30+
description: 'Health check endpoint that returns server status',
31+
});
32+
33+
/**
34+
* Version Check
35+
*
36+
* @tag Advanced Wallets
37+
* @operationId v1.health.version
38+
* @private
39+
*/
40+
const VersionRoute = httpRoute({
41+
method: 'GET',
42+
path: '/version',
43+
request: httpRequest({}),
44+
response: VersionResponse,
45+
description: 'Returns the current version of the server',
46+
});
47+
2548
export const HealthCheckApiSpec = apiSpec({
2649
'v1.health.ping': {
27-
post: httpRoute({
28-
method: 'POST',
29-
path: '/ping',
30-
request: httpRequest({}),
31-
response: PingResponse,
32-
description: 'Health check endpoint that returns server status',
33-
}),
50+
post: PingRoute,
3451
},
35-
/**
36-
* Version Check
37-
*
38-
* @tag Advanced Wallets
39-
* @operationId v1.health.version
40-
* @private
41-
*/
52+
4253
'v1.health.version': {
43-
get: httpRoute({
44-
method: 'GET',
45-
path: '/version',
46-
request: httpRequest({}),
47-
response: VersionResponse,
48-
description: 'Returns the current version of the server',
49-
}),
54+
get: VersionRoute,
5055
},
5156
});
5257

0 commit comments

Comments
 (0)