commonscomputer/cal.diy
4
0
Fork 0
Code Issues Pull Requests Actions 1.9k Packages Projects Releases Wiki Activity

chore: clean up api v2 docs (#20668)

Browse Source 
* chore: Clean up API v2 docs

* Regenerated the doc files

* Added an 'a' to match other titles
This commit is contained in:
Keith Williams
2025-04-14 05:37:07 -03:00
committed by GitHub
parent 40a2ec8ab3
commit ad4aeee45b
4 changed files with 594 additions and 581 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/api/v2/src/ee/bookings/2024-08-13/controllers/bookings.controller.ts
+10 -9
View File
@@ -256,7 +256,8 @@ export class BookingsController_2024_08_13 {
@UseGuards(ApiAuthGuard, BookingUidGuard)
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@ApiOperation({
summary: "Mark a booking absence - provided authorization header refers to owner of the booking.",
summary: "Mark a booking absence",
description: "The provided authorization header refers to the owner of the booking.",
})
async markNoShow(
@Param("bookingUid") bookingUid: string,
@@ -277,8 +278,8 @@ export class BookingsController_2024_08_13 {
@UseGuards(ApiAuthGuard, BookingUidGuard)
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@ApiOperation({
summary:
"Automatically reassign booking to a new host automatically - provided authorization header refers to person who reassigned the booking.",
summary: "Reassign a booking to auto-selected host",
description: "The provided authorization header refers to the owner of the booking.",
})
async reassignBooking(
@Param("bookingUid") bookingUid: string,
@@ -298,8 +299,8 @@ export class BookingsController_2024_08_13 {
@UseGuards(ApiAuthGuard, BookingUidGuard)
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@ApiOperation({
summary:
"Reassign a booking to a specific user specified by the :userId - provided authorization header refers to person who reassigned the booking.",
summary: "Reassign a booking to a specific host",
description: "The provided authorization header refers to the owner of the booking.",
})
async reassignBookingToUser(
@Param("bookingUid") bookingUid: string,
@@ -326,8 +327,8 @@ export class BookingsController_2024_08_13 {
@UseGuards(ApiAuthGuard, BookingUidGuard)
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@ApiOperation({
summary:
"Confirm booking that requires a confirmation - provided authorization header refers to owner of the booking.",
summary: "Confirm a booking",
description: "The provided authorization header refers to the owner of the booking.",
})
async confirmBooking(
@Param("bookingUid") bookingUid: string,
@@ -347,8 +348,8 @@ export class BookingsController_2024_08_13 {
@UseGuards(ApiAuthGuard, BookingUidGuard)
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@ApiOperation({
summary:
"Decline booking that requires a confirmation - provided authorization header refers to owner of the booking.",
summary: "Decline a booking",
description: "The provided authorization header refers to the owner of the booking.",
})
async declineBooking(
@Param("bookingUid") bookingUid: string,
apps/api/v2/src/modules/organizations/conferencing/organizations-conferencing.controller.ts
+1 -1
View File
@@ -56,7 +56,7 @@ export type OAuthCallbackState = {
path: "/v2/organizations/:orgId",
version: API_VERSIONS_VALUES,
})
@DocsTags("Organizations/Teams Conferencing")
@DocsTags("Orgs / Teams / Conferencing")
export class OrganizationsConferencingController {
constructor(
private readonly conferencingService: ConferencingService,
apps/api/v2/swagger/documentation.json
+307 -301
View File
@@ -2410,7 +2410,8 @@
"name": "teamIds",
"required": false,
"in": "query",
"description": "Filter by teamIds",
"description": "Filter by teamIds. Team ids must be separated by a comma.",
"example": "?teamIds=100,200",
"schema": {
"type": "array",
"items": {
@@ -3342,6 +3343,301 @@
]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/connect": {
"post": {
"operationId": "OrganizationsConferencingController_connectTeamApp",
"summary": "Connect your conferencing application to a team",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "orgId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": [
"google-meet"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": [
"Orgs / Teams / Conferencing"
]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/oauth/auth-url": {
"get": {
"operationId": "OrganizationsConferencingController_getTeamOAuthUrl",
"summary": "Get OAuth conferencing app's auth url for a team",
"parameters": [
{
"name": "Authorization",
"required": true,
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "orgId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": [
"zoom",
"msteams"
],
"type": "string"
}
},
{
"name": "returnTo",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onErrorReturnTo",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetConferencingAppsOauthUrlResponseDto"
}
}
}
}
},
"tags": [
"Orgs / Teams / Conferencing"
]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing": {
"get": {
"operationId": "OrganizationsConferencingController_listTeamConferencingApps",
"summary": "List team conferencing applications",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConferencingAppsOutputResponseDto"
}
}
}
}
},
"tags": [
"Orgs / Teams / Conferencing"
]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/default": {
"post": {
"operationId": "OrganizationsConferencingController_setTeamDefaultApp",
"summary": "Set team default conferencing application",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": [
"google-meet",
"zoom",
"msteams",
"daily-video"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetDefaultConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": [
"Orgs / Teams / Conferencing"
]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/default": {
"get": {
"operationId": "OrganizationsConferencingController_getTeamDefaultApp",
"summary": "Get team default conferencing application",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": [
"google-meet",
"zoom",
"msteams",
"daily-video"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDefaultConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": [
"Orgs / Teams / Conferencing"
]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/disconnect": {
"delete": {
"operationId": "OrganizationsConferencingController_disconnectTeamApp",
"summary": "Disconnect team conferencing application",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": [
"google-meet",
"zoom",
"msteams"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisconnectConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": [
"Orgs / Teams / Conferencing"
]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/event-types": {
"post": {
"operationId": "OrganizationsEventTypesController_createTeamEventType",
@@ -6739,7 +7035,8 @@
"/v2/bookings/{bookingUid}/mark-absent": {
"post": {
"operationId": "BookingsController_2024_08_13_markNoShow",
"summary": "Mark a booking absence - provided authorization header refers to owner of the booking.",
"summary": "Mark a booking absence",
"description": "The provided authorization header refers to the owner of the booking.",
"parameters": [
{
"name": "cal-api-version",
@@ -6799,7 +7096,8 @@
"/v2/bookings/{bookingUid}/reassign": {
"post": {
"operationId": "BookingsController_2024_08_13_reassignBooking",
"summary": "Automatically reassign booking to a new host automatically - provided authorization header refers to person who reassigned the booking.",
"summary": "Reassign booking to auto-selected host",
"description": "The provided authorization header refers to the owner of the booking.",
"parameters": [
{
"name": "cal-api-version",
@@ -6849,7 +7147,8 @@
"/v2/bookings/{bookingUid}/reassign/{userId}": {
"post": {
"operationId": "BookingsController_2024_08_13_reassignBookingToUser",
"summary": "Reassign a booking to a specific user specified by the :userId - provided authorization header refers to person who reassigned the booking.",
"summary": "Reassign a booking to a specific host",
"description": "The provided authorization header refers to the owner of the booking.",
"parameters": [
{
"name": "cal-api-version",
@@ -6917,7 +7216,8 @@
"/v2/bookings/{bookingUid}/confirm": {
"post": {
"operationId": "BookingsController_2024_08_13_confirmBooking",
"summary": "Confirm booking that requires a confirmation - provided authorization header refers to owner of the booking.",
"summary": "Confirm a booking",
"description": "The provided authorization header refers to the owner of the booking.",
"parameters": [
{
"name": "cal-api-version",
@@ -6967,7 +7267,8 @@
"/v2/bookings/{bookingUid}/decline": {
"post": {
"operationId": "BookingsController_2024_08_13_declineBooking",
"summary": "Decline booking that requires a confirmation - provided authorization header refers to owner of the booking.",
"summary": "Decline a booking",
"description": "The provided authorization header refers to the owner of the booking.",
"parameters": [
{
"name": "cal-api-version",
@@ -8652,301 +8953,6 @@
]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/connect": {
"post": {
"operationId": "OrganizationsConferencingController_connectTeamApp",
"summary": "Connect your conferencing application to a team",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "orgId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": [
"google-meet"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": [
"Organizations/Teams Conferencing"
]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/oauth/auth-url": {
"get": {
"operationId": "OrganizationsConferencingController_getTeamOAuthUrl",
"summary": "Get OAuth conferencing app's auth url for a team",
"parameters": [
{
"name": "Authorization",
"required": true,
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "orgId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": [
"zoom",
"msteams"
],
"type": "string"
}
},
{
"name": "returnTo",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onErrorReturnTo",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetConferencingAppsOauthUrlResponseDto"
}
}
}
}
},
"tags": [
"Organizations/Teams Conferencing"
]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing": {
"get": {
"operationId": "OrganizationsConferencingController_listTeamConferencingApps",
"summary": "List team conferencing applications",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConferencingAppsOutputResponseDto"
}
}
}
}
},
"tags": [
"Organizations/Teams Conferencing"
]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/default": {
"post": {
"operationId": "OrganizationsConferencingController_setTeamDefaultApp",
"summary": "Set team default conferencing application",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": [
"google-meet",
"zoom",
"msteams",
"daily-video"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetDefaultConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": [
"Organizations/Teams Conferencing"
]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/default": {
"get": {
"operationId": "OrganizationsConferencingController_getTeamDefaultApp",
"summary": "Get team default conferencing application",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": [
"google-meet",
"zoom",
"msteams",
"daily-video"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDefaultConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": [
"Organizations/Teams Conferencing"
]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/disconnect": {
"delete": {
"operationId": "OrganizationsConferencingController_disconnectTeamApp",
"summary": "Disconnect team conferencing application",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": [
"google-meet",
"zoom",
"msteams"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisconnectConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": [
"Organizations/Teams Conferencing"
]
}
},
"/v2/schedules": {
"post": {
"operationId": "SchedulesController_2024_06_11_createSchedule",
docs/api-reference/v2/openapi.json
+276 -270
View File
@@ -2310,7 +2310,8 @@
"name": "teamIds",
"required": false,
"in": "query",
"description": "Filter by teamIds",
"description": "Filter by teamIds. Team ids must be separated by a comma.",
"example": "?teamIds=100,200",
"schema": {
"type": "array",
"items": {
@@ -3199,6 +3200,270 @@
"tags": ["Orgs / Teams / Bookings"]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/connect": {
"post": {
"operationId": "OrganizationsConferencingController_connectTeamApp",
"summary": "Connect your conferencing application to a team",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "orgId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": ["google-meet"],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": ["Orgs / Teams / Conferencing"]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/oauth/auth-url": {
"get": {
"operationId": "OrganizationsConferencingController_getTeamOAuthUrl",
"summary": "Get OAuth conferencing app's auth url for a team",
"parameters": [
{
"name": "Authorization",
"required": true,
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "orgId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": ["zoom", "msteams"],
"type": "string"
}
},
{
"name": "returnTo",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onErrorReturnTo",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetConferencingAppsOauthUrlResponseDto"
}
}
}
}
},
"tags": ["Orgs / Teams / Conferencing"]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing": {
"get": {
"operationId": "OrganizationsConferencingController_listTeamConferencingApps",
"summary": "List team conferencing applications",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConferencingAppsOutputResponseDto"
}
}
}
}
},
"tags": ["Orgs / Teams / Conferencing"]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/default": {
"post": {
"operationId": "OrganizationsConferencingController_setTeamDefaultApp",
"summary": "Set team default conferencing application",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": ["google-meet", "zoom", "msteams", "daily-video"],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetDefaultConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": ["Orgs / Teams / Conferencing"]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/default": {
"get": {
"operationId": "OrganizationsConferencingController_getTeamDefaultApp",
"summary": "Get team default conferencing application",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": ["google-meet", "zoom", "msteams", "daily-video"],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDefaultConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": ["Orgs / Teams / Conferencing"]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/disconnect": {
"delete": {
"operationId": "OrganizationsConferencingController_disconnectTeamApp",
"summary": "Disconnect team conferencing application",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": ["google-meet", "zoom", "msteams"],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisconnectConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": ["Orgs / Teams / Conferencing"]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/event-types": {
"post": {
"operationId": "OrganizationsEventTypesController_createTeamEventType",
@@ -6452,7 +6717,8 @@
"/v2/bookings/{bookingUid}/mark-absent": {
"post": {
"operationId": "BookingsController_2024_08_13_markNoShow",
"summary": "Mark a booking absence - provided authorization header refers to owner of the booking.",
"summary": "Mark a booking absence",
"description": "The provided authorization header refers to the owner of the booking.",
"parameters": [
{
"name": "cal-api-version",
@@ -6510,7 +6776,8 @@
"/v2/bookings/{bookingUid}/reassign": {
"post": {
"operationId": "BookingsController_2024_08_13_reassignBooking",
"summary": "Automatically reassign booking to a new host automatically - provided authorization header refers to person who reassigned the booking.",
"summary": "Reassign booking to auto-selected host",
"description": "The provided authorization header refers to the owner of the booking.",
"parameters": [
{
"name": "cal-api-version",
@@ -6558,7 +6825,8 @@
"/v2/bookings/{bookingUid}/reassign/{userId}": {
"post": {
"operationId": "BookingsController_2024_08_13_reassignBookingToUser",
"summary": "Reassign a booking to a specific user specified by the :userId - provided authorization header refers to person who reassigned the booking.",
"summary": "Reassign a booking to a specific host",
"description": "The provided authorization header refers to the owner of the booking.",
"parameters": [
{
"name": "cal-api-version",
@@ -6624,7 +6892,8 @@
"/v2/bookings/{bookingUid}/confirm": {
"post": {
"operationId": "BookingsController_2024_08_13_confirmBooking",
"summary": "Confirm booking that requires a confirmation - provided authorization header refers to owner of the booking.",
"summary": "Confirm a booking",
"description": "The provided authorization header refers to the owner of the booking.",
"parameters": [
{
"name": "cal-api-version",
@@ -6672,7 +6941,8 @@
"/v2/bookings/{bookingUid}/decline": {
"post": {
"operationId": "BookingsController_2024_08_13_declineBooking",
"summary": "Decline booking that requires a confirmation - provided authorization header refers to owner of the booking.",
"summary": "Decline a booking",
"description": "The provided authorization header refers to the owner of the booking.",
"parameters": [
{
"name": "cal-api-version",
@@ -8250,270 +8520,6 @@
"tags": ["OAuth Clients"]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/connect": {
"post": {
"operationId": "OrganizationsConferencingController_connectTeamApp",
"summary": "Connect your conferencing application to a team",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "orgId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": ["google-meet"],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": ["Organizations/Teams Conferencing"]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/oauth/auth-url": {
"get": {
"operationId": "OrganizationsConferencingController_getTeamOAuthUrl",
"summary": "Get OAuth conferencing app's auth url for a team",
"parameters": [
{
"name": "Authorization",
"required": true,
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "orgId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": ["zoom", "msteams"],
"type": "string"
}
},
{
"name": "returnTo",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onErrorReturnTo",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetConferencingAppsOauthUrlResponseDto"
}
}
}
}
},
"tags": ["Organizations/Teams Conferencing"]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing": {
"get": {
"operationId": "OrganizationsConferencingController_listTeamConferencingApps",
"summary": "List team conferencing applications",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConferencingAppsOutputResponseDto"
}
}
}
}
},
"tags": ["Organizations/Teams Conferencing"]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/default": {
"post": {
"operationId": "OrganizationsConferencingController_setTeamDefaultApp",
"summary": "Set team default conferencing application",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": ["google-meet", "zoom", "msteams", "daily-video"],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetDefaultConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": ["Organizations/Teams Conferencing"]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/default": {
"get": {
"operationId": "OrganizationsConferencingController_getTeamDefaultApp",
"summary": "Get team default conferencing application",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": ["google-meet", "zoom", "msteams", "daily-video"],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDefaultConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": ["Organizations/Teams Conferencing"]
}
},
"/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/disconnect": {
"delete": {
"operationId": "OrganizationsConferencingController_disconnectTeamApp",
"summary": "Disconnect team conferencing application",
"parameters": [
{
"name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
},
{
"name": "app",
"required": true,
"in": "path",
"description": "Conferencing application type",
"schema": {
"enum": ["google-meet", "zoom", "msteams"],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisconnectConferencingAppOutputResponseDto"
}
}
}
}
},
"tags": ["Organizations/Teams Conferencing"]
}
},
"/v2/schedules": {
"post": {
"operationId": "SchedulesController_2024_06_11_createSchedule",