Skip to content

Commit

Permalink
feat: route doc descriptions (#322)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ChrisPdgn
ChrisPdgn authored Sep 15, 2022
1 parent 0fef34a commit 981643b
Show file tree
Hide file tree
Showing 25 changed files with 133 additions and 29 deletions.
16 changes: 12 additions & 4 deletions modules/authentication/src/admin/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ export class AdminHandlers {
{
path: '/users',
action: ConduitRouteActions.GET,
description: `Returns queried users and their total count.`,
queryParams: {
skip: ConduitNumber.Optional,
limit: ConduitNumber.Optional,
Expand All @@ -78,6 +79,7 @@ export class AdminHandlers {
{
path: '/users',
action: ConduitRouteActions.POST,
description: `Creates a new user using email/password.`,
bodyParams: {
email: ConduitString.Required,
password: ConduitString.Required,
Expand All @@ -90,6 +92,7 @@ export class AdminHandlers {
{
path: '/users/:id',
action: ConduitRouteActions.PATCH,
description: `Updates user's fields.`,
urlParams: {
id: { type: RouteOptionType.String, required: true },
},
Expand All @@ -108,6 +111,7 @@ export class AdminHandlers {
{
path: '/users',
action: ConduitRouteActions.DELETE,
description: `Deletes queried users.`,
queryParams: {
ids: { type: [TYPE.String], required: true }, // handler array check is still required
},
Expand All @@ -119,6 +123,7 @@ export class AdminHandlers {
{
path: '/users/:id',
action: ConduitRouteActions.DELETE,
description: `Deletes a user.`,
urlParams: {
id: { type: RouteOptionType.String, required: true },
},
Expand All @@ -130,6 +135,7 @@ export class AdminHandlers {
{
path: '/users/:id/block',
action: ConduitRouteActions.POST,
description: `Blocks/inactivates a user.`,
urlParams: {
id: { type: RouteOptionType.String, required: true },
},
Expand All @@ -141,6 +147,7 @@ export class AdminHandlers {
{
path: '/users/:id/unblock',
action: ConduitRouteActions.POST,
description: `Unblocks/activates a user.`,
urlParams: {
id: { type: RouteOptionType.String, required: true },
},
Expand All @@ -152,6 +159,7 @@ export class AdminHandlers {
{
path: '/users/toggle',
action: ConduitRouteActions.POST,
description: `Blocks/unblocks queried users.`,
bodyParams: {
ids: { type: [TYPE.String], required: true }, // handler array check is still required
block: ConduitBoolean.Required,
Expand All @@ -171,7 +179,7 @@ export class AdminHandlers {
sort: ConduitString.Optional,
},
name: 'GetServices',
description: 'Returns registered services',
description: 'Returns queried registered services.',
},
new ConduitRouteReturnDefinition('GetServices', {
services: [Service.getInstance().fields],
Expand All @@ -187,7 +195,7 @@ export class AdminHandlers {
name: ConduitString.Required,
},
name: 'CreateService',
description: 'Registers a new service',
description: 'Registers a new service.',
},
new ConduitRouteReturnDefinition('CreateService', {
name: ConduitString.Required,
Expand All @@ -203,7 +211,7 @@ export class AdminHandlers {
id: ConduitString.Required,
},
name: 'DeleteService',
description: 'Deletes a service',
description: 'Deletes a service.',
},
new ConduitRouteReturnDefinition('DeleteService', 'String'),
'deleteService',
Expand All @@ -216,7 +224,7 @@ export class AdminHandlers {
serviceId: ConduitString.Required,
},
name: 'RenewServiceToken',
description: 'Renews a service token',
description: 'Renews a service token.',
},
new ConduitRouteReturnDefinition('RenewServiceToken', {
name: ConduitString.Required,
Expand Down
1 change: 1 addition & 0 deletions modules/authentication/src/handlers/common.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ export class CommonHandlers implements IAuthenticationStrategy {
{
path: '/logout',
action: ConduitRouteActions.POST,
description: `Logs out authenticated user.`,
middlewares: ['authMiddleware'],
},
new ConduitRouteReturnDefinition('LogoutResponse', 'String'),
Expand Down
9 changes: 5 additions & 4 deletions modules/authentication/src/handlers/local.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ export class LocalHandlers implements IAuthenticationStrategy {
{
path: '/forgot-password',
action: ConduitRouteActions.POST,
description: `Generates a password reset token and forwards a verification link to the user's email address.`,
bodyParams: {
email: ConduitString.Required,
},
Expand All @@ -94,7 +95,7 @@ export class LocalHandlers implements IAuthenticationStrategy {
path: '/reset-password',
action: ConduitRouteActions.POST,
description: `Used after the user clicks on the 'forgot password' link and
requires the token from the url and the new password`,
requires the token from the url and the new password.`,
bodyParams: {
passwordResetToken: ConduitString.Required,
password: ConduitString.Required,
Expand All @@ -108,7 +109,7 @@ export class LocalHandlers implements IAuthenticationStrategy {
{
path: '/local/resend-verification',
action: ConduitRouteActions.POST,
description: `Used to resend email verification after new user is created`,
description: `Used to resend email verification after new user is created.`,
bodyParams: {
email: ConduitString.Required,
},
Expand Down Expand Up @@ -153,7 +154,7 @@ export class LocalHandlers implements IAuthenticationStrategy {
{
path: '/hook/verify-email/:verificationToken',
action: ConduitRouteActions.GET,
description: `A webhook used to verify user email. This bypasses the need for clientid/secret`,
description: `A webhook used to verify user email. This bypasses the need for client id/secret.`,
urlParams: {
verificationToken: ConduitString.Required,
},
Expand All @@ -166,7 +167,7 @@ export class LocalHandlers implements IAuthenticationStrategy {
{
path: '/hook/verify-change-email/:verificationToken',
action: ConduitRouteActions.GET,
description: `A webhook used to verify an email address change. This bypasses the need for clientid/secret`,
description: `A webhook used to verify an email address change. This bypasses the need for client id/secret.`,
urlParams: {
verificationToken: ConduitString.Required,
},
Expand Down
2 changes: 1 addition & 1 deletion modules/authentication/src/handlers/phone.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export class PhoneHandlers implements IAuthenticationStrategy {
{
path: '/phone/verify',
action: ConduitRouteActions.POST,
description: `Verifies the token which is used for phone authentication`,
description: `Verifies the token which is used for phone authentication.`,
bodyParams: {
code: ConduitString.Required,
phone: ConduitString.Required,
Expand Down
5 changes: 5 additions & 0 deletions modules/chat/src/admin/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ export class AdminHandlers {
{
path: '/rooms',
action: ConduitRouteActions.GET,
description: `Returns queried chat rooms.`,
queryParams: {
skip: ConduitNumber.Optional,
limit: ConduitNumber.Optional,
Expand All @@ -66,6 +67,7 @@ export class AdminHandlers {
{
path: '/rooms',
action: ConduitRouteActions.POST,
description: `Creates a new chat room.`,
bodyParams: {
name: ConduitString.Required,
participants: { type: [TYPE.String], required: true }, // handler array check is still required
Expand All @@ -78,6 +80,7 @@ export class AdminHandlers {
{
path: '/rooms',
action: ConduitRouteActions.DELETE,
description: `Deletes queried chat rooms.`,
queryParams: {
ids: { type: [TYPE.String], required: true },
},
Expand All @@ -89,6 +92,7 @@ export class AdminHandlers {
{
path: '/messages',
action: ConduitRouteActions.GET,
description: `Returns queried messages.`,
queryParams: {
skip: ConduitNumber.Optional,
limit: ConduitNumber.Optional,
Expand All @@ -108,6 +112,7 @@ export class AdminHandlers {
{
path: '/messages',
action: ConduitRouteActions.DELETE,
description: `Deletes queried messages.`,
queryParams: {
ids: { type: [TYPE.String], required: true }, // handler array check is still required
},
Expand Down
20 changes: 12 additions & 8 deletions modules/chat/src/routes/InvitationRoutes.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ export class InvitationRoutes {
this.routingManager.route(
{
path: '/hook/invitations/:answer/:invitationToken',
description: `A webhook used to respond to a chat room invitation
requiring the invitation token.`,
action: ConduitRouteActions.GET,
urlParams: {
answer: ConduitString.Required,
Expand All @@ -35,6 +37,7 @@ export class InvitationRoutes {
{
path: '/invitations/:answer/:id',
action: ConduitRouteActions.GET,
description: `Responds to a chat room invitation requiring the invitation token id.`,
urlParams: {
id: ConduitString.Required,
answer: ConduitString.Required,
Expand All @@ -48,6 +51,7 @@ export class InvitationRoutes {
{
path: '/invitations/received',
action: ConduitRouteActions.GET,
description: `Returns current user's received invitations and their total count.`,
queryParams: {
skip: ConduitNumber.Optional,
limit: ConduitNumber.Optional,
Expand All @@ -68,6 +72,7 @@ export class InvitationRoutes {
limit: ConduitNumber.Optional,
},
action: ConduitRouteActions.GET,
description: `Returns queried invitations the current user has sent.`,
middlewares: ['authMiddleware'],
},
new ConduitRouteReturnDefinition('SentInvitationsResponse', {
Expand All @@ -80,6 +85,7 @@ export class InvitationRoutes {
{
path: '/invitations/cancel/:id',
action: ConduitRouteActions.DELETE,
description: `Cancels an invitation the current user has sent.`,
urlParams: {
id: ConduitString.Required,
},
Expand All @@ -93,12 +99,11 @@ export class InvitationRoutes {
async answerInvitation(call: ParsedRouterRequest): Promise<UnparsedRouterResponse> {
const { id, answer } = call.request.params;
const { user } = call.request.context;
const invitationTokenDoc: InvitationToken | null = await InvitationToken.getInstance().findOne(
{
const invitationTokenDoc: InvitationToken | null =
await InvitationToken.getInstance().findOne({
_id: id,
receiver: user._id,
},
);
});
if (isNil(invitationTokenDoc)) {
throw new GrpcError(status.NOT_FOUND, 'Invitation not valid');
}
Expand Down Expand Up @@ -129,12 +134,11 @@ export class InvitationRoutes {
): Promise<UnparsedRouterResponse> {
const { invitationToken, answer } = call.request.params;
const { user } = call.request.context;
const invitationTokenDoc: InvitationToken | null = await InvitationToken.getInstance().findOne(
{
const invitationTokenDoc: InvitationToken | null =
await InvitationToken.getInstance().findOne({
token: invitationToken,
receiver: user._id,
},
);
});
if (isNil(invitationTokenDoc)) {
throw new GrpcError(status.NOT_FOUND, 'Invitation not valid');
}
Expand Down
9 changes: 9 additions & 0 deletions modules/chat/src/routes/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,7 @@ export class ChatRoutes {
{
path: '/rooms',
action: ConduitRouteActions.POST,
description: `Creates a new room.`,
bodyParams: {
roomName: ConduitString.Required,
users: [TYPE.String],
Expand All @@ -447,6 +448,7 @@ export class ChatRoutes {
{
path: '/rooms/:roomId/addUsers',
action: ConduitRouteActions.UPDATE,
description: `Adds users to a chat room.`,
urlParams: {
roomId: ConduitString.Required,
},
Expand All @@ -463,6 +465,7 @@ export class ChatRoutes {
{
path: '/leave/:roomId',
action: ConduitRouteActions.UPDATE,
description: `Removes current user from a chat room.`,
urlParams: {
roomId: ConduitString.Required,
},
Expand All @@ -476,6 +479,7 @@ export class ChatRoutes {
{
path: '/rooms/:id',
action: ConduitRouteActions.GET,
description: `Returns a chat room.`,
urlParams: {
id: ConduitString.Required,
},
Expand All @@ -488,6 +492,7 @@ export class ChatRoutes {
{
path: '/rooms',
action: ConduitRouteActions.GET,
description: `Returns queried chat rooms.`,
queryParams: {
skip: ConduitNumber.Optional,
limit: ConduitNumber.Optional,
Expand All @@ -505,6 +510,7 @@ export class ChatRoutes {
{
path: '/messages/:id',
action: ConduitRouteActions.GET,
description: `Returns a message.`,
urlParams: {
id: ConduitString.Required,
},
Expand All @@ -518,6 +524,7 @@ export class ChatRoutes {
{
path: '/messages',
action: ConduitRouteActions.GET,
description: `Returns queried messages and their total count.`,
queryParams: {
roomId: ConduitString.Optional,
skip: ConduitNumber.Optional,
Expand All @@ -538,6 +545,7 @@ export class ChatRoutes {
{
path: '/messages/:messageId',
action: ConduitRouteActions.DELETE,
description: `Deletes a message.`,
urlParams: {
messageId: ConduitString.Required,
},
Expand All @@ -553,6 +561,7 @@ export class ChatRoutes {
{
path: '/messages/:messageId',
action: ConduitRouteActions.UPDATE,
description: `Updates content of a message.`,
urlParams: {
messageId: ConduitString.Required,
},
Expand Down
Loading

0 comments on commit 981643b

Please sign in to comment.