vynte-infra/calendar
2
0
Fork 0
Code Issues Pull Requests Actions 1.2k Packages Projects Releases Wiki Activity

chore: Removed development only docs tags (#17028)

Browse Source
This commit is contained in:
Keith Williams
2024-10-09 11:58:58 -03:00
committed by GitHub
parent 03d0b98155
commit 8d61b452b1
4 changed files with 104 additions and 436 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-reference/v2/openapi.json
+101 -213
View File
@@ -3826,25 +3826,6 @@
"tags": ["Event Types / Webhooks"]
}
},
"/health": {
"get": {
"operationId": "AppController_getHealth",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
},
"tags": ["Health - development only"]
}
},
"/v2/me": {
"get": {
"operationId": "MeController_getMe",
@@ -4027,192 +4008,6 @@
"tags": ["OAuth", "Managed users"]
}
},
"/v2/oauth-clients": {
"post": {
"operationId": "OAuthClientsController_createOAuthClient",
"summary": "",
"description": "⚠️ First, this endpoint requires `Cookie: next-auth.session-token=eyJhbGciOiJ` header. Log into Cal web app using owner of organization that was created after visiting `/settings/organizations/new`, refresh swagger docs, and the cookie will be added to requests automatically to pass the NextAuthGuard.\nSecond, make sure that the logged in user has organizationId set to pass the OrganizationRolesGuard guard.",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOAuthClientInput"
}
}
}
},
"responses": {
"201": {
"description": "Create an OAuth client",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOAuthClientResponseDto"
}
}
}
}
},
"tags": ["OAuth - development only"]
},
"get": {
"operationId": "OAuthClientsController_getOAuthClients",
"summary": "",
"description": "⚠️ First, this endpoint requires `Cookie: next-auth.session-token=eyJhbGciOiJ` header. Log into Cal web app using owner of organization that was created after visiting `/settings/organizations/new`, refresh swagger docs, and the cookie will be added to requests automatically to pass the NextAuthGuard.\nSecond, make sure that the logged in user has organizationId set to pass the OrganizationRolesGuard guard.",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetOAuthClientsResponseDto"
}
}
}
}
},
"tags": ["OAuth - development only"]
}
},
"/v2/oauth-clients/{clientId}": {
"get": {
"operationId": "OAuthClientsController_getOAuthClientById",
"summary": "",
"description": "⚠️ First, this endpoint requires `Cookie: next-auth.session-token=eyJhbGciOiJ` header. Log into Cal web app using owner of organization that was created after visiting `/settings/organizations/new`, refresh swagger docs, and the cookie will be added to requests automatically to pass the NextAuthGuard.\nSecond, make sure that the logged in user has organizationId set to pass the OrganizationRolesGuard guard.",
"parameters": [
{
"name": "clientId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetOAuthClientResponseDto"
}
}
}
}
},
"tags": ["OAuth - development only"]
},
"patch": {
"operationId": "OAuthClientsController_updateOAuthClient",
"summary": "",
"description": "⚠️ First, this endpoint requires `Cookie: next-auth.session-token=eyJhbGciOiJ` header. Log into Cal web app using owner of organization that was created after visiting `/settings/organizations/new`, refresh swagger docs, and the cookie will be added to requests automatically to pass the NextAuthGuard.\nSecond, make sure that the logged in user has organizationId set to pass the OrganizationRolesGuard guard.",
"parameters": [
{
"name": "clientId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateOAuthClientInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetOAuthClientResponseDto"
}
}
}
}
},
"tags": ["OAuth - development only"]
},
"delete": {
"operationId": "OAuthClientsController_deleteOAuthClient",
"summary": "",
"description": "⚠️ First, this endpoint requires `Cookie: next-auth.session-token=eyJhbGciOiJ` header. Log into Cal web app using owner of organization that was created after visiting `/settings/organizations/new`, refresh swagger docs, and the cookie will be added to requests automatically to pass the NextAuthGuard.\nSecond, make sure that the logged in user has organizationId set to pass the OrganizationRolesGuard guard.",
"parameters": [
{
"name": "clientId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetOAuthClientResponseDto"
}
}
}
}
},
"tags": ["OAuth - development only"]
}
},
"/v2/oauth-clients/{clientId}/managed-users": {
"get": {
"operationId": "OAuthClientsController_getOAuthClientManagedUsersById",
"summary": "",
"description": "⚠️ First, this endpoint requires `Cookie: next-auth.session-token=eyJhbGciOiJ` header. Log into Cal web app using owner of organization that was created after visiting `/settings/organizations/new`, refresh swagger docs, and the cookie will be added to requests automatically to pass the NextAuthGuard.\nSecond, make sure that the logged in user has organizationId set to pass the OrganizationRolesGuard guard.",
"parameters": [
{
"name": "clientId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "The number of items to return",
"example": 10,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetManagedUsersOutput"
}
}
}
}
},
"tags": ["OAuth - development only"]
}
},
"/v2/schedules": {
"post": {
"operationId": "SchedulesController_2024_06_11_createSchedule",
@@ -7912,6 +7707,9 @@
},
"bookingLimits": {
"type": "string"
},
"includeManagedEventsInLimits": {
"type": "boolean"
}
}
},
@@ -10961,12 +10759,18 @@
},
"meetingUrl": {
"type": "string",
"description": "Meeting URL just for this booking. Displayed in email and calendar event. If not provided then cal video link will be generated.",
"description": "Deprecated - use 'location' instead. Meeting URL just for this booking. Displayed in email and calendar event. If not provided then cal video link will be generated.",
"example": "https://example.com/meeting",
"deprecated": true
},
"location": {
"type": "string",
"description": "Location for this booking. Displayed in email and calendar event.",
"example": "https://example.com/meeting"
},
"bookingFieldsResponses": {
"type": "object",
"description": "Booking field responses.",
"description": "Booking field responses consisting of an object with booking field slug as keys and user response as values.",
"example": {
"customField": "customValue"
}
@@ -11005,12 +10809,18 @@
},
"meetingUrl": {
"type": "string",
"description": "Meeting URL just for this booking. Displayed in email and calendar event. If not provided then cal video link will be generated.",
"description": "Deprecated - use 'location' instead. Meeting URL just for this booking. Displayed in email and calendar event. If not provided then cal video link will be generated.",
"example": "https://example.com/meeting",
"deprecated": true
},
"location": {
"type": "string",
"description": "Location for this booking. Displayed in email and calendar event.",
"example": "https://example.com/meeting"
},
"bookingFieldsResponses": {
"type": "object",
"description": "Booking field responses.",
"description": "Booking field responses consisting of an object with booking field slug as keys and user response as values.",
"example": {
"customField": "customValue"
}
@@ -11052,9 +10862,9 @@
"type": "string"
}
},
"meetingUrl": {
"location": {
"type": "string",
"description": "Meeting URL just for this booking. Displayed in email and calendar event. If not provided then cal video link will be generated.",
"description": "Location for this booking. Displayed in email and calendar event.",
"example": "https://example.com/meeting"
},
"bookingFieldsResponses": {
@@ -11067,6 +10877,20 @@
},
"required": ["start", "eventTypeId", "attendee"]
},
"EventType": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"slug": {
"type": "string",
"example": "some-event"
}
},
"required": ["id", "slug"]
},
"BookingOutput_2024_08_13": {
"type": "object",
"properties": {
@@ -11078,6 +10902,14 @@
"type": "string",
"example": "booking_uid_123"
},
"title": {
"type": "string",
"example": "Consultation"
},
"description": {
"type": "string",
"example": "Learn how to integrate scheduling into marketplace."
},
"hosts": {
"type": "array",
"items": {
@@ -11115,7 +10947,12 @@
},
"eventTypeId": {
"type": "number",
"example": 45
"example": 50,
"deprecated": true,
"description": "Deprecated - rely on 'eventType' object containing the id instead."
},
"eventType": {
"$ref": "#/components/schemas/EventType"
},
"attendees": {
"type": "array",
@@ -11131,23 +10968,39 @@
}
},
"meetingUrl": {
"type": "string",
"description": "Deprecated - rely on 'location' field instead.",
"example": "https://example.com/recurring-meeting",
"deprecated": true
},
"location": {
"type": "string",
"example": "https://example.com/meeting"
},
"absentHost": {
"type": "boolean",
"example": true
},
"bookingFieldsResponses": {
"type": "object",
"description": "Booking field responses consisting of an object with booking field slug as keys and user response as values.",
"example": {
"customField": "customValue"
}
}
},
"required": [
"id",
"uid",
"title",
"description",
"hosts",
"status",
"start",
"end",
"duration",
"eventTypeId",
"eventType",
"attendees",
"absentHost"
]
@@ -11163,6 +11016,14 @@
"type": "string",
"example": "recurring_uid_123"
},
"title": {
"type": "string",
"example": "Recurring meeting"
},
"description": {
"type": "string",
"example": "Learn how to integrate scheduling into marketplace."
},
"hosts": {
"type": "array",
"items": {
@@ -11200,7 +11061,12 @@
},
"eventTypeId": {
"type": "number",
"example": 50
"example": 50,
"deprecated": true,
"description": "Deprecated - rely on 'eventType' object containing the id instead."
},
"eventType": {
"$ref": "#/components/schemas/EventType"
},
"recurringBookingUid": {
"type": "string",
@@ -11220,23 +11086,39 @@
}
},
"meetingUrl": {
"type": "string",
"description": "Deprecated - rely on 'location' field instead.",
"example": "https://example.com/recurring-meeting",
"deprecated": true
},
"location": {
"type": "string",
"example": "https://example.com/recurring-meeting"
},
"absentHost": {
"type": "boolean",
"example": false
},
"bookingFieldsResponses": {
"type": "object",
"description": "Booking field responses consisting of an object with booking field slug as keys and user response as values.",
"example": {
"customField": "customValue"
}
}
},
"required": [
"id",
"uid",
"title",
"description",
"hosts",
"status",
"start",
"end",
"duration",
"eventTypeId",
"eventType",
"recurringBookingUid",
"attendees",
"absentHost"
@@ -11291,6 +11173,9 @@
}
],
"description": "Booking data, which can be either a BookingOutput object, a RecurringBookingOutput object, or an array of RecurringBookingOutput objects"
},
"error": {
"type": "object"
}
},
"required": ["status", "data"]
@@ -11316,6 +11201,9 @@
]
},
"description": "Array of booking data, which can contain either BookingOutput objects or RecurringBookingOutput objects"
},
"error": {
"type": "object"
}
},
"required": ["status", "data"]