Update API documentation for new admin endpoint

This commit is contained in:
Gabe Kangas 2020-11-05 18:40:19 -08:00
parent 856961ad2d
commit 7fece6ff28

View file

@ -419,24 +419,20 @@ paths:
- name: parrot - name: parrot
emoji: /img/emoji/parrot.gif emoji: /img/emoji/parrot.gif
/api/admin/broadcaster: /api/admin/status:
get: get:
summary: "Broadcaster Details" summary: "Server status and broadcaster"
tags: ["Admin"] tags: ["Admin"]
security: security:
- AdminBasicAuth: [] - AdminBasicAuth: []
responses: responses:
'200': '200':
description: Connected Broadcaster Details description: Server status and broadcaster details
content: content:
application/json: application/json:
schema: schema:
type: object type: object
properties: properties:
success:
type: boolean
message:
type: string
broadcaster: broadcaster:
type: object type: object
properties: properties:
@ -464,12 +460,28 @@ paths:
type: string type: string
encoder: encoder:
type: string 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: examples:
connected: connected:
summary: "Broadcaster Connected" summary: "Broadcaster Connected"
value: value:
success: true
message: ""
broadcaster: broadcaster:
remoteAddr: 172.217.164.110 remoteAddr: 172.217.164.110
time: "2020-10-06T23:20:44.588649-07:00" time: "2020-10-06T23:20:44.588649-07:00"
@ -482,11 +494,13 @@ paths:
audioBitrate: 256 audioBitrate: 256
audioCodec: "aac" audioCodec: "aac"
encoder: "obs-output module (libobs version 25.0.8)" encoder: "obs-output module (libobs version 25.0.8)"
not-connected: online: true
summary: "Broadcaster Not Connected" viewerCount: 3
value: overallPeakViewerCount: 4
success: false sessionPeakViewerCount: 4
message: "no broadcaster connected" versionNumber: "0.0.3"
disableUpgradeChecks: false
/api/admin/disconnect: /api/admin/disconnect:
post: post: