swagger docs update for selected calendars (#246)
Adds swagger doc update for selected calendars API endpointpull/9078/head
parent
ccf93190d7
commit
2da8784865
|
@ -11,6 +11,12 @@ import { selectedCalendarIdSchema } from "~/lib/validations/selected-calendar";
|
||||||
* operationId: removeSelectedCalendarById
|
* operationId: removeSelectedCalendarById
|
||||||
* summary: Remove a selected calendar
|
* summary: Remove a selected calendar
|
||||||
* parameters:
|
* parameters:
|
||||||
|
* - in: query
|
||||||
|
* name: apiKey
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* required: true
|
||||||
|
* description: Your API Key
|
||||||
* - in: path
|
* - in: path
|
||||||
* name: userId
|
* name: userId
|
||||||
* schema:
|
* schema:
|
||||||
|
|
|
@ -11,6 +11,12 @@ import { schemaSelectedCalendarPublic, selectedCalendarIdSchema } from "~/lib/va
|
||||||
* operationId: getSelectedCalendarById
|
* operationId: getSelectedCalendarById
|
||||||
* summary: Find a selected calendar by providing the compoundId(userId_integration_externalId) separated by `_`
|
* summary: Find a selected calendar by providing the compoundId(userId_integration_externalId) separated by `_`
|
||||||
* parameters:
|
* parameters:
|
||||||
|
* - in: query
|
||||||
|
* name: apiKey
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* required: true
|
||||||
|
* description: Your API Key
|
||||||
* - in: path
|
* - in: path
|
||||||
* name: userId
|
* name: userId
|
||||||
* schema:
|
* schema:
|
||||||
|
|
|
@ -17,6 +17,12 @@ import {
|
||||||
* operationId: editSelectedCalendarById
|
* operationId: editSelectedCalendarById
|
||||||
* summary: Edit a selected calendar
|
* summary: Edit a selected calendar
|
||||||
* parameters:
|
* parameters:
|
||||||
|
* - in: query
|
||||||
|
* name: apiKey
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* required: true
|
||||||
|
* description: Your API Key
|
||||||
* - in: path
|
* - in: path
|
||||||
* name: userId
|
* name: userId
|
||||||
* schema:
|
* schema:
|
||||||
|
|
|
@ -13,6 +13,13 @@ import { schemaQuerySingleOrMultipleUserIds } from "~/lib/validations/shared/que
|
||||||
* get:
|
* get:
|
||||||
* operationId: listSelectedCalendars
|
* operationId: listSelectedCalendars
|
||||||
* summary: Find all selected calendars
|
* summary: Find all selected calendars
|
||||||
|
* parameters:
|
||||||
|
* - in: query
|
||||||
|
* name: apiKey
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* required: true
|
||||||
|
* description: Your API Key
|
||||||
* tags:
|
* tags:
|
||||||
* - selected-calendars
|
* - selected-calendars
|
||||||
* responses:
|
* responses:
|
||||||
|
|
|
@ -12,20 +12,32 @@ import {
|
||||||
/**
|
/**
|
||||||
* @swagger
|
* @swagger
|
||||||
* /selected-calendars:
|
* /selected-calendars:
|
||||||
* get:
|
|
||||||
* operationId: addSelectedCalendars
|
|
||||||
* summary: Find all selected calendars
|
|
||||||
* tags:
|
|
||||||
* - selected-calendars
|
|
||||||
* responses:
|
|
||||||
* 200:
|
|
||||||
* description: OK
|
|
||||||
* 401:
|
|
||||||
* description: Authorization information is missing or invalid.
|
|
||||||
* 404:
|
|
||||||
* description: No selected calendars were found
|
|
||||||
* post:
|
* post:
|
||||||
* summary: Creates a new selected calendar
|
* summary: Creates a new selected calendar
|
||||||
|
* parameters:
|
||||||
|
* - in: query
|
||||||
|
* name: apiKey
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* required: true
|
||||||
|
* description: Your API Key
|
||||||
|
* requestBody:
|
||||||
|
* description: Create a new selected calendar
|
||||||
|
* required: true
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* type: object
|
||||||
|
* required:
|
||||||
|
* - integration
|
||||||
|
* - externalId
|
||||||
|
* properties:
|
||||||
|
* integration:
|
||||||
|
* type: string
|
||||||
|
* description: The integration name
|
||||||
|
* externalId:
|
||||||
|
* type: string
|
||||||
|
* description: The external ID of the integration
|
||||||
* tags:
|
* tags:
|
||||||
* - selected-calendars
|
* - selected-calendars
|
||||||
* responses:
|
* responses:
|
||||||
|
|
Loading…
Reference in New Issue