Skip to content

Commit 3d78cdc

Browse files
committed
add jsdocs to userController.apiKey routes
1 parent e8dcb59 commit 3d78cdc

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

server/controllers/user.controller/apiKey.ts

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,15 @@ function generateApiKey(): Promise<string> {
2323
});
2424
}
2525

26-
/** POST /account/api-keys, UserController.createApiKey */
26+
/**
27+
* - Method: `POST`
28+
* - Endpoint: `/account/api-keys`
29+
* - Authenticated: `true`
30+
* - Id: `UserController.createApiKey`
31+
*
32+
* Description:
33+
* - Create API key
34+
*/
2735
export const createApiKey: RequestHandler<
2836
{},
2937
ApiKeyResponseOrError,
@@ -75,7 +83,15 @@ export const createApiKey: RequestHandler<
7583
}
7684
};
7785

78-
/** DELETE /account/api-keys/:keyId, UserController.removeApiKey */
86+
/**
87+
* - Method: `DELETE`
88+
* - Endpoint: `/account/api-keys/:keyId`
89+
* - Authenticated: `true`
90+
* - Id: `UserController.removeApiKey`
91+
*
92+
* Description:
93+
* - Remove API key
94+
*/
7995
export const removeApiKey: RequestHandler<
8096
RemoveApiKeyRequestParams,
8197
ApiKeyResponseOrError

0 commit comments

Comments
 (0)