Remove GET /availabilities (#188)

Follows-up on earlier discussions about the relationships of
/availabilities and /schedules.

`GET /schedules/:id` returns a schedule with associated availabilities
in the `availabilities` property. It gives more context and less
consumer work to perform GET actions using this endpoint. Other
endpoints of this collection do make sense.

Proposing also to rename the /availabilities collection to
/availability; given after this it always involves one and only one
/availability record in CRUD.
This commit is contained in:
Alex van Andel
2022-10-21 00:58:20 +01:00
committed by GitHub
parent debc8dbafb
commit dee0f6a415
3 changed files with 5 additions and 61 deletions
-58
View File
@@ -1,58 +0,0 @@
import type { NextApiRequest } from "next";
import { HttpError } from "@calcom/lib/http-error";
import { defaultResponder } from "@calcom/lib/server";
import { schemaAvailabilityReadBodyParams } from "@lib/validations/availability";
/**
* @swagger
* /availabilities:
* get:
* operationId: listAvailabilities
* summary: Find all availabilities
* tags:
* - availabilities
* externalDocs:
* url: https://docs.cal.com/availability
* responses:
* 200:
* description: OK
* 401:
* description: Authorization information is missing or invalid.
* 404:
* description: No availabilities were found
*/
async function handler(req: NextApiRequest) {
const { userId, isAdmin, prisma } = req;
const body = schemaAvailabilityReadBodyParams.parse(req.body || {});
if (body.userId && !isAdmin)
throw new HttpError({
statusCode: 401,
message: "Unauthorized: Only admins can request other users' availabilities",
});
const userIds = Array.isArray(body.userId) ? body.userId : [body.userId || userId];
let availabilities = await prisma.availability.findMany({
where: { Schedule: { userId: { in: userIds } } },
include: { Schedule: { select: { userId: true } } },
...(Array.isArray(body.userId) && { orderBy: { userId: "asc" } }),
});
/**
* IDK if this a special requirement but, since availabilities aren't directly related to a user.
* We manually override the `userId` field so the user doesn't need to query the scheduleId just
* to get the user that it belongs to... OR... we can just access `availability.Schedule.userId` instead
* but at this point I'm afraid to break something so we will have both for now... ¯\_(ツ)_/¯
*/
availabilities = availabilities.map((a) => ({ ...a, userId: a.Schedule?.userId || null }));
if (!availabilities.length)
throw new HttpError({ statusCode: 404, message: "No Availabilities were found" });
return { availabilities };
}
export default defaultResponder(handler);
+1 -2
View File
@@ -2,9 +2,8 @@ import { defaultHandler } from "@calcom/lib/server";
import { withMiddleware } from "@lib/helpers/withMiddleware";
export default withMiddleware("HTTP_GET_OR_POST")(
export default withMiddleware()(
defaultHandler({
GET: import("./_get"),
POST: import("./_post"),
})
);
+4 -1
View File
@@ -114,7 +114,10 @@ const swaggerHandler = withSwagger({
{ name: "schedules" },
{ name: "teams" },
{ name: "memberships" },
{ name: "availabilities" },
{
name: "availabilities",
description: "Allows modifying unique availabilities tied to a schedule.",
},
{ name: "custom-inputs" },
{ name: "event-references" },
{ name: "booking-references" },