Skip to content

Commit 5361076

Browse files
committed
docs(express): set x-internal: false on 4 operations
Add @public JSDoc tag to the 3 routes that were missing an explicit visibility declaration. The 4th route (GET /api/v2/ping) already had @public. The @public tag generates x-internal: false in the synced express.yaml OpenAPI spec, satisfying the openapi-spec-quality lint rule. Routes updated: - POST /api/v1/wallets/simplecreate - POST /api/v1/walletshare/{shareId}/acceptShare - POST /api/v2/{coin}/verifyaddress Ticket: DX-1065 Session-Id: 2350e389-b3c4-46ab-abd0-4bb17ef1df96 Task-Id: a2a9ad52-5781-4878-856b-c2484c5eb158
1 parent 2dba4cc commit 5361076

3 files changed

Lines changed: 3 additions & 0 deletions

File tree

modules/express/src/typedRoutes/api/v1/acceptShare.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ export const AcceptShareResponse = t.type({
8787
*
8888
* @operationId express.v1.wallet.acceptShare
8989
* @tag Express
90+
* @public
9091
*/
9192
export const PostAcceptShare = httpRoute({
9293
path: '/api/v1/walletshare/{shareId}/acceptShare',

modules/express/src/typedRoutes/api/v1/simpleCreate.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ export const SimpleCreateResponse = t.intersection([
7373
*
7474
* @operationId express.v1.wallet.simplecreate
7575
* @tag Express
76+
* @public
7677
*/
7778
export const PostSimpleCreate = httpRoute({
7879
path: '/api/v1/wallets/simplecreate',

modules/express/src/typedRoutes/api/v2/verifyCoinAddress.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ export const VerifyAddressV2Body = {
3030
*
3131
* @operationId express.verifycoinaddress
3232
* @tag Express
33+
* @public
3334
*/
3435
export const PostVerifyCoinAddress = httpRoute({
3536
path: '/api/v2/{coin}/verifyaddress',

0 commit comments

Comments
 (0)