fix openapi specs

This commit is contained in:
Sergey Krashevich
2023-09-25 07:40:40 +03:00
parent 02bde2c8b7
commit aa5b23fa80
+67 -23
View File
@@ -1,4 +1,4 @@
openapi: 3.0.0 openapi: 3.1.0
info: info:
title: go2rtc title: go2rtc
@@ -111,7 +111,9 @@ paths:
required: false required: false
schema: { type: integer } schema: { type: integer }
example: 100 example: 100
responses: { } responses:
default:
description: Default response
@@ -130,14 +132,18 @@ paths:
requestBody: requestBody:
content: content:
"*/*": { example: "streams:..." } "*/*": { example: "streams:..." }
responses: { } responses:
default:
description: Default response
patch: patch:
summary: Merge changes to main config file summary: Merge changes to main config file
tags: [ Config ] tags: [ Config ]
requestBody: requestBody:
content: content:
"*/*": { example: "streams:..." } "*/*": { example: "streams:..." }
responses: { } responses:
default:
description: Default response
@@ -166,7 +172,9 @@ paths:
required: false required: false
schema: { type: string } schema: { type: string }
example: camera1 example: camera1
responses: { } responses:
default:
description: Default response
patch: patch:
summary: Update stream source summary: Update stream source
tags: [ Streams list ] tags: [ Streams list ]
@@ -183,7 +191,9 @@ paths:
required: true required: true
schema: { type: string } schema: { type: string }
example: camera1 example: camera1
responses: { } responses:
default:
description: Default response
delete: delete:
summary: Delete stream summary: Delete stream
tags: [ Streams list ] tags: [ Streams list ]
@@ -194,7 +204,9 @@ paths:
required: true required: true
schema: { type: string } schema: { type: string }
example: camera1 example: camera1
responses: { } responses:
default:
description: Default response
post: post:
summary: Send stream from source to destination summary: Send stream from source to destination
description: "[Stream to camera](https://github.com/AlexxIT/go2rtc#stream-to-camera)" description: "[Stream to camera](https://github.com/AlexxIT/go2rtc#stream-to-camera)"
@@ -212,7 +224,9 @@ paths:
required: true required: true
schema: { type: string } schema: { type: string }
example: camera1 example: camera1
responses: { } responses:
default:
description: Default response
@@ -347,7 +361,9 @@ paths:
tags: [ Produce stream ] tags: [ Produce stream ]
parameters: parameters:
- $ref: "#/components/parameters/stream_dst_path" - $ref: "#/components/parameters/stream_dst_path"
responses: { } responses:
default:
description: Default response
/api/stream.flv?dst={dst}: /api/stream.flv?dst={dst}:
post: post:
summary: Post stream in FLV format summary: Post stream in FLV format
@@ -355,7 +371,9 @@ paths:
tags: [ Produce stream ] tags: [ Produce stream ]
parameters: parameters:
- $ref: "#/components/parameters/stream_dst_path" - $ref: "#/components/parameters/stream_dst_path"
responses: { } responses:
default:
description: Default response
/api/stream.ts?dst={dst}: /api/stream.ts?dst={dst}:
post: post:
summary: Post stream in MPEG-TS format summary: Post stream in MPEG-TS format
@@ -363,7 +381,9 @@ paths:
tags: [ Produce stream ] tags: [ Produce stream ]
parameters: parameters:
- $ref: "#/components/parameters/stream_dst_path" - $ref: "#/components/parameters/stream_dst_path"
responses: { } responses:
default:
description: Default response
/api/stream.mjpeg?dst={dst}: /api/stream.mjpeg?dst={dst}:
post: post:
summary: Post stream in MJPEG format summary: Post stream in MJPEG format
@@ -371,7 +391,9 @@ paths:
tags: [ Produce stream ] tags: [ Produce stream ]
parameters: parameters:
- $ref: "#/components/parameters/stream_dst_path" - $ref: "#/components/parameters/stream_dst_path"
responses: { } responses:
default:
description: Default response
@@ -380,49 +402,65 @@ paths:
summary: DVRIP cameras discovery summary: DVRIP cameras discovery
description: "[Source: DVRIP](https://github.com/AlexxIT/go2rtc#source-dvrip)" description: "[Source: DVRIP](https://github.com/AlexxIT/go2rtc#source-dvrip)"
tags: [ Discovery ] tags: [ Discovery ]
responses: { } responses:
default:
description: Default response
/api/ffmpeg/devices: /api/ffmpeg/devices:
get: get:
summary: FFmpeg USB devices discovery summary: FFmpeg USB devices discovery
description: "[Source: FFmpeg Device](https://github.com/AlexxIT/go2rtc#source-ffmpeg-device)" description: "[Source: FFmpeg Device](https://github.com/AlexxIT/go2rtc#source-ffmpeg-device)"
tags: [ Discovery ] tags: [ Discovery ]
responses: { } responses:
default:
description: Default response
/api/ffmpeg/hardware: /api/ffmpeg/hardware:
get: get:
summary: FFmpeg hardware transcoding discovery summary: FFmpeg hardware transcoding discovery
description: "[Hardware acceleration](https://github.com/AlexxIT/go2rtc/wiki/Hardware-acceleration)" description: "[Hardware acceleration](https://github.com/AlexxIT/go2rtc/wiki/Hardware-acceleration)"
tags: [ Discovery ] tags: [ Discovery ]
responses: { } responses:
default:
description: Default response
/api/hass: /api/hass:
get: get:
summary: Home Assistant cameras discovery summary: Home Assistant cameras discovery
description: "[Source: Hass](https://github.com/AlexxIT/go2rtc#source-hass)" description: "[Source: Hass](https://github.com/AlexxIT/go2rtc#source-hass)"
tags: [ Discovery ] tags: [ Discovery ]
responses: { } responses:
default:
description: Default response
/api/homekit: /api/homekit:
get: get:
summary: HomeKit cameras discovery summary: HomeKit cameras discovery
description: "[Source: HomeKit](https://github.com/AlexxIT/go2rtc#source-homekit)" description: "[Source: HomeKit](https://github.com/AlexxIT/go2rtc#source-homekit)"
tags: [ Discovery ] tags: [ Discovery ]
responses: { } responses:
default:
description: Default response
/api/nest: /api/nest:
get: get:
summary: Nest cameras discovery summary: Nest cameras discovery
tags: [ Discovery ] tags: [ Discovery ]
responses: { } responses:
default:
description: Default response
/api/onvif: /api/onvif:
get: get:
summary: ONVIF cameras discovery summary: ONVIF cameras discovery
description: "[Source: ONVIF](https://github.com/AlexxIT/go2rtc#source-onvif)" description: "[Source: ONVIF](https://github.com/AlexxIT/go2rtc#source-onvif)"
tags: [ Discovery ] tags: [ Discovery ]
responses: { } responses:
default:
description: Default response
/api/roborock: /api/roborock:
get: get:
summary: Roborock vacuums discovery summary: Roborock vacuums discovery
description: "[Source: Roborock](https://github.com/AlexxIT/go2rtc#source-roborock)" description: "[Source: Roborock](https://github.com/AlexxIT/go2rtc#source-roborock)"
tags: [ Discovery ] tags: [ Discovery ]
responses: { } responses:
default:
description: Default response
@@ -431,7 +469,9 @@ paths:
summary: ONVIF server implementation summary: ONVIF server implementation
description: Simple realisation of the ONVIF protocol. Accepts any suburl requests description: Simple realisation of the ONVIF protocol. Accepts any suburl requests
tags: [ ONVIF ] tags: [ ONVIF ]
responses: { } responses:
default:
description: Default response
@@ -440,7 +480,9 @@ paths:
summary: RTSPtoWebRTC server implementation summary: RTSPtoWebRTC server implementation
description: Simple API for support [RTSPtoWebRTC](https://www.home-assistant.io/integrations/rtsp_to_webrtc/) integration description: Simple API for support [RTSPtoWebRTC](https://www.home-assistant.io/integrations/rtsp_to_webrtc/) integration
tags: [ RTSPtoWebRTC ] tags: [ RTSPtoWebRTC ]
responses: { } responses:
default:
description: Default response
@@ -465,7 +507,9 @@ paths:
tags: [ WebTorrent ] tags: [ WebTorrent ]
parameters: parameters:
- $ref: "#/components/parameters/stream_src_path" - $ref: "#/components/parameters/stream_src_path"
responses: { } responses:
default:
description: Default response
/api/webtorrent: /api/webtorrent:
get: get: