public-offering
/
cal.pub0.org
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updates Availability and Attendees swagger docs, hotfixes Booking API doc (#241) 

- Adds swagger definition and swagger fixes to /availability and
/attendees
- Also fixes Booking API endpoint definition (startTime -> start,
endTime -> end)
pull/9078/head
Syed Ali Shahbaz 2023-03-10 19:29:24 +05:30 committed by GitHub
parent 59c25d41fd
commit e54e1aa72e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 106 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
pages/api/attendees/[id]/_delete.ts
View File

@ -11,6 +11,12 @@ import { schemaQueryIdParseInt } from "~/lib/validations/shared/queryIdTransform
* operationId: removeAttendeeById
* summary: Remove an existing attendee
* parameters:
* - in: query
* name: apiKey
* required: true
* schema:
* type: string
* description: Your API key
* - in: path
* name: id
* schema:
@ -21,7 +27,7 @@ import { schemaQueryIdParseInt } from "~/lib/validations/shared/queryIdTransform
* - attendees
* responses:
* 201:
* description: OK, attendee removed successfuly
* description: OK, attendee removed successfully
* 400:
* description: Bad request. Attendee id is invalid.
* 401:

7
pages/api/attendees/[id]/_get.ts
View File

@ -12,13 +12,18 @@ import { schemaQueryIdParseInt } from "~/lib/validations/shared/queryIdTransform
* operationId: getAttendeeById
* summary: Find an attendee
* parameters:
* - in: query
* name: apiKey
* required: true
* schema:
* type: string
* description: Your API key
* - in: path
* name: id
* schema:
* type: integer
* required: true
* description: ID of the attendee to get
* example: 3
* tags:
* - attendees
* responses:

28
pages/api/attendees/[id]/_patch.ts
View File

@ -11,8 +11,8 @@ import { schemaQueryIdParseInt } from "~/lib/validations/shared/queryIdTransform
* @swagger
* /attendees/{id}:
* patch:
* summary: Edit an existing attendee
* operationId: editAttendeeById
* summary: Edit an existing attendee
* requestBody:
* description: Edit an existing attendee related to one of your bookings
* required: true
@ -23,31 +23,35 @@ import { schemaQueryIdParseInt } from "~/lib/validations/shared/queryIdTransform
* properties:
* email:
* type: string
* example: email@example.com
* format: email
* name:
* type: string
* example: John Doe
* timeZone:
* type: string
* example: Europe/London
* parameters:
* - in: path
* name: id
* schema:
* type: integer
* example: 3
* required: true
* description: ID of the attendee to edit
* - in: query
* name: apiKey
* required: true
* schema:
* type: string
* description: Your API key
* - in: path
* name: id
* schema:
* type: integer
* required: true
* description: ID of the attendee to get
* tags:
* - attendees
* responses:
* 201:
* description: OK, attendee edited successfuly
* description: OK, attendee edited successfully
* 400:
* description: Bad request. Attendee body is invalid.
* 401:
* description: Authorization information is missing or invalid.
*/
export async function patchHandler(req: NextApiRequest) {
const { prisma, query, body } = req;
const { id } = schemaQueryIdParseInt.parse(query);

7
pages/api/attendees/_get.ts
View File

@ -12,6 +12,13 @@ import { schemaAttendeeReadPublic } from "~/lib/validations/attendee";
* get:
* operationId: listAttendees
* summary: Find all attendees
* parameters:
* - in: query
* name: apiKey
* required: true
* schema:
* type: string
* description: Your API key
* tags:
* - attendees
* responses:

12
pages/api/attendees/_post.ts
View File

@ -11,6 +11,13 @@ import { schemaAttendeeCreateBodyParams, schemaAttendeeReadPublic } from "~/lib/
* post:
* operationId: addAttendee
* summary: Creates a new attendee
* parameters:
* - in: query
* name: apiKey
* required: true
* schema:
* type: string
* description: Your API key
* requestBody:
* description: Create a new attendee related to one of your bookings
* required: true
@ -26,16 +33,13 @@ import { schemaAttendeeCreateBodyParams, schemaAttendeeReadPublic } from "~/lib/
* properties:
* bookingId:
* type: number
* example: 1
* email:
* type: string
* example: email@example.com
* format: email
* name:
* type: string
* example: John Doe
* timeZone:
* type: string
* example: Europe/London
* tags:
* - attendees
* responses:

56
pages/api/availability/_get.ts
View File

@ -7,6 +7,62 @@ import { defaultResponder } from "@calcom/lib/server";
import { availabilityUserSelect } from "@calcom/prisma";
import { stringOrNumber } from "@calcom/prisma/zod-utils";
/**
* @swagger
* /availability:
* get:
* summary: Find user or team availability
* parameters:
* - in: query
* name: apiKey
* required: true
* schema:
* type: string
* description: Your API key
* - in: query
* name: userId
* schema:
* type: integer
* description: ID of the user to fetch the availability for
* - in: query
* name: teamId
* schema:
* type: integer
* description: ID of the team to fetch the availability for
* - in: query
* name: username
* schema:
* type: string
* description: username of the user to fetch the availability for
* - in: query
* name: dateFrom
* schema:
* type: string
* format: date
* description: Start Date of the availability query
* - in: query
* name: dateTo
* schema:
* type: string
* format: date
* description: End Date of the availability query
* - in: query
* name: eventTypeId
* schema:
* type: integer
* description: Event Type ID of the event type to fetch the availability for
* operationId: availability
* tags:
* - availability
* responses:
* 200:
* description: OK
* 401:
* description: Authorization information is missing or invalid.
* 404:
* description: User not found | Team not found | Team has no members
*/
const availabilitySchema = z
.object({
userId: stringOrNumber.optional(),

4
pages/api/bookings/[id]/_patch.ts
View File

@ -24,11 +24,11 @@ import { schemaQueryIdParseInt } from "~/lib/validations/shared/queryIdTransform
* title:
* type: string
* description: 'Booking event title'
* startTime:
* start:
* type: string
* format: date-time
* description: 'Start time of the Event'
* endTime:
* end:
* type: string
* format: date-time
* description: 'End time of the Event'

8
pages/api/bookings/_post.ts
View File

@ -24,17 +24,17 @@ import { defaultResponder } from "@calcom/lib/server";
* schema:
* type: object
* required:
* - startTime
* - endTime
* - start
* - end
* properties:
* title:
* type: string
* description: 'Booking event title'
* startTime:
* start:
* type: string
* format: date-time
* description: 'Start time of the Event'
* endTime:
* end:
* type: string
* format: date-time
* description: 'End time of the Event'