mirrors/owncast
1
0
Fork 0
mirror of https://github.com/owncast/owncast.git synced 2024-11-22 04:40:37 +03:00
Code Issues Projects Releases Packages Wiki Activity

Update API documentation for new admin endpoint

Browse source
This commit is contained in:
Gabe Kangas 2020-11-05 18:40:19 -08:00
parent 856961ad2d
commit 7fece6ff28
1 changed files with 28 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
openapi.yaml
View file

@ -419,24 +419,20 @@ paths:
- name: parrot
emoji: /img/emoji/parrot.gif
/api/admin/broadcaster:
/api/admin/status:
get:
summary: "Broadcaster Details"
summary: "Server status and broadcaster"
tags: ["Admin"]
security:
- AdminBasicAuth: []
responses:
'200':
description: Connected Broadcaster Details
description: Server status and broadcaster details
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
broadcaster:
type: object
properties:
@ -464,12 +460,28 @@ paths:
type: string
encoder:
type: string
online:
type: boolean
description: Is a stream currently active
viewerCount:
type: integer
description: The current number of viewers
sessionPeakViewerCount:
type: integer
description: The peak number of viewers this streaming session
overallPeakViewerCount:
type: integer
description: The all-time peak number of viewers
versionNumber:
type: string
description: The current version of the owncast software
disableUpgradeChecks:
type: boolean
description: Turn off checking for owncast releases
examples:
connected:
summary: "Broadcaster Connected"
value:
success: true
message: ""
broadcaster:
remoteAddr: 172.217.164.110
time: "2020-10-06T23:20:44.588649-07:00"
@ -482,11 +494,13 @@ paths:
audioBitrate: 256
audioCodec: "aac"
encoder: "obs-output module (libobs version 25.0.8)"
not-connected:
summary: "Broadcaster Not Connected"
value:
success: false
message: "no broadcaster connected"
online: true
viewerCount: 3
overallPeakViewerCount: 4
sessionPeakViewerCount: 4
versionNumber: "0.0.3"
disableUpgradeChecks: false
/api/admin/disconnect:
post: