neoris/openvidu
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

backend: Upgrade OpenAPI version to 3.1.0 and enhance API documentation for clarity and consistency

Browse Source
This commit is contained in:
Carlos Santos 2025-04-02 16:07:29 +02:00
parent 1a4ecf873d
commit dbf0743850
2 changed files with 29 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
backend/openapi/openvidu-meet-api.yaml
View File

@ -1,19 +1,23 @@
openapi: 3.0.1 openapi: 3.1.0
info: info:
version: v1
title: OpenVidu Meet REST API title: OpenVidu Meet REST API
description: > description: >
The OpenVidu Meet REST API allows seamless integration of OpenVidu Meet rooms into your application. The OpenVidu Meet REST API provides a comprehensive set of endpoints for integrating real-time video
This REST API provides endpoints to manage rooms and recordings in OpenVidu Meet. conferencing capabilities into your applications.
termsOfService: https://openvidu.io/conditions/terms-of-service/
contact: contact:
name: OpenVidu name: OpenVidu
email: commercial@openvidu.io email: commercial@openvidu.io
url: https://openvidu.io/support/ url: https://openvidu.io/support/
license:
name: Apache License 2.0
identifier: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: v1
termsOfService: https://openvidu.io/conditions/terms-of-service/
servers: servers:
- url: http://localhost:6080/meet/api/v1 - url: /meet/api/v1
description: Development server description: OpenVidu Meet API
tags: tags:
- name: OpenVidu Meet - Room - name: OpenVidu Meet - Room
@ -151,7 +155,7 @@ paths:
rooms: rooms:
type: array type: array
items: items:
$ref: '#/components/schemas/MeetRoom' $ref: '#/components/schemas/MeetRoom'
pagination: pagination:
type: object type: object
properties: properties:
@ -1114,9 +1118,8 @@ components:
example: 100 example: 100
description: The error code of the recording. description: The error code of the recording.
error: error:
type: string type: [string, 'null']
description: The error message of the recording. description: The error message of the recording.
nullable: true
details: details:
type: string type: string
example: 'Stopped using API' example: 'Stopped using API'
@ -1134,3 +1137,6 @@ components:
type: string type: string
message: message:
type: string type: string
code:
type: integer
description: HTTP status code associated with the error

23
backend/openapi/openvidu-meet-internal-api.yaml
View File

@ -1,19 +1,23 @@
openapi: 3.0.1 openapi: 3.1.0
info: info:
version: v1 title: OpenVidu Meet REST API
title: OpenVidu Meet Internal REST API
description: > description: >
The OpenVidu Meet Internal REST API allows seamless integration of OpenVidu Meet rooms into your application. The OpenVidu Meet REST API provides a comprehensive set of endpoints for integrating real-time video
This REST API provides endpoints to manage rooms and recordings in OpenVidu Meet. conferencing capabilities into your applications.
termsOfService: https://openvidu.io/conditions/terms-of-service/
contact: contact:
name: OpenVidu name: OpenVidu
email: commercial@openvidu.io email: commercial@openvidu.io
url: https://openvidu.io/support/ url: https://openvidu.io/support/
license:
name: Apache License 2.0
identifier: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: v1
termsOfService: https://openvidu.io/conditions/terms-of-service/
servers: servers:
- url: http://localhost:6080/meet/internal-api/v1 - url: /meet/internal-api/v1
description: Development server description: OpenVidu Meet Internal API
tags: tags:
- name: Internal API - Authentication - name: Internal API - Authentication
description: Authentication operations description: Authentication operations
@ -712,9 +716,8 @@ components:
example: 100 example: 100
description: The error code of the recording. description: The error code of the recording.
error: error:
type: string type: [string, 'null']
description: The error message of the recording. description: The error message of the recording.
nullable: true
details: details:
type: string type: string
example: 'Stopped using API' example: 'Stopped using API'