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

Improves Destination Calendar docs in swagger (#235) 

Adds swagger definition to `destination-calendar` endpoint
pull/9078/head
Syed Ali Shahbaz 2023-02-09 05:46:32 +05:30 committed by GitHub
parent f170f17f2c
commit 2248d7069f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 94 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
pages/api/destination-calendars/[id].ts
View File

@ -40,8 +40,14 @@ export async function destionationCalendarById(
* type: integer
* required: true
* description: ID of the destination calendar to get
* - in: query
* name: apiKey
* required: true
* schema:
* type: string
* description: Your API key
* tags:
* - destination-calendars
* - destination-calendars
* responses:
* 200:
* description: OK
@ -58,8 +64,34 @@ export async function destionationCalendarById(
* type: integer
* required: true
* description: ID of the destination calendar to edit
* - in: query
* name: apiKey
* required: true
* schema:
* type: string
* description: Your API key
* requestBody:
* description: Create a new booking related to one of your event-types
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* integration:
* type: string
* description: 'The integration'
* externalId:
* type: string
* description: 'The external ID of the integration'
* eventTypeId:
* type: integer
* description: 'The ID of the eventType it is associated with'
* bookingId:
* type: integer
* description: 'The booking ID it is associated with'
* tags:
* - destination-calendars
* - destination-calendars
* responses:
* 201:
* description: OK, destinationCalendar edited successfuly
@ -76,8 +108,14 @@ export async function destionationCalendarById(
* type: integer
* required: true
* description: ID of the destination calendar to delete
* - in: query
* name: apiKey
* required: true
* schema:
* type: string
* description: Your API key
* tags:
* - destination-calendars
* - destination-calendars
* responses:
* 201:
* description: OK, destinationCalendar removed successfuly
@ -110,8 +148,14 @@ export async function destionationCalendarById(
* type: integer
* required: true
* description: ID of the destination calendar to edit
* - in: query
* name: apiKey
* required: true
* schema:
* type: string
* description: Your API key
* tags:
* - destination-calendars
* - destination-calendars
* responses:
* 201:
* description: OK, destinationCalendar edited successfuly
@ -150,8 +194,14 @@ export async function destionationCalendarById(
* type: integer
* required: true
* description: ID of the destination calendar to delete
* - in: query
* name: apiKey
* required: true
* schema:
* type: string
* description: Your API key
* tags:
* - destination-calendars
* - destination-calendars
* responses:
* 201:
* description: OK, destinationCalendar removed successfuly

41
pages/api/destination-calendars/index.ts
View File

@ -16,9 +16,16 @@ async function createOrlistAllDestinationCalendars(
* @swagger
* /destination-calendars:
* get:
* parameters:
* - in: query
* name: apiKey
* required: true
* schema:
* type: string
* description: Your API key
* summary: Find all destination calendars
* tags:
* - destination-calendars
* - destination-calendars
* responses:
* 200:
* description: OK
@ -43,9 +50,39 @@ async function createOrlistAllDestinationCalendars(
* @swagger
* /destination-calendars:
* post:
* parameters:
* - in: query
* name: apiKey
* required: true
* schema:
* type: string
* description: Your API key
* summary: Creates a new destination calendar
* requestBody:
* description: Create a new destination calendar for your events
* required: true
* content:
* application/json:
* schema:
* type: object
* required:
* - integration
* - externalId
* properties:
* integration:
* type: string
* description: 'The integration'
* externalId:
* type: string
* description: 'The external ID of the integration'
* eventTypeId:
* type: integer
* description: 'The ID of the eventType it is associated with'
* bookingId:
* type: integer
* description: 'The booking ID it is associated with'
* tags:
* - destination-calendars
* - destination-calendars
* responses:
* 201:
* description: OK, destination calendar created