0

Update api spec

This commit is contained in:
Gabe Kangas 2021-07-19 22:53:02 -07:00
parent af0c6c0cb3
commit b59d348adc

View File

@ -2,7 +2,7 @@ openapi: 3.0.1
info: info:
title: Owncast title: Owncast
description: Owncast is a self-hosted live video and web chat server for use with existing popular broadcasting software. The following APIs represent the state in the development branch. description: Owncast is a self-hosted live video and web chat server for use with existing popular broadcasting software. The following APIs represent the state in the development branch.
version: '0.0.8-develop' version: '0.0.8'
contact: contact:
name: Gabe Kangas name: Gabe Kangas
email: gabek@real-ity.com email: gabek@real-ity.com
@ -47,7 +47,6 @@ components:
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36
(KHTML, like Gecko) Chrome/84.0.4147.89 Safari/537.36 (KHTML, like Gecko) Chrome/84.0.4147.89 Safari/537.36
ipAddress: "::1" ipAddress: "::1"
username: null
clientID: 2ba20dd34f911c198df3218ddc64c740 clientID: 2ba20dd34f911c198df3218ddc64c740
geo: geo:
countryCode: US countryCode: US
@ -67,9 +66,6 @@ components:
ipAddress: ipAddress:
description: The public IP address of this client description: The public IP address of this client
type: string type: string
username:
description: The username for this client in chat if available
type: string
clientID: clientID:
description: The value used to identify this client description: The value used to identify this client
type: string type: string
@ -485,9 +481,8 @@ paths:
items: items:
type: object type: object
properties: properties:
author: user:
type: string $ref: "#/components/schemas/User"
description: Username of the chat message poster.
body: body:
type: string type: string
description: Escaped HTML of the chat message content. description: Escaped HTML of the chat message content.
@ -772,9 +767,8 @@ paths:
items: items:
type: object type: object
properties: properties:
author: user:
type: string $ref: "#/components/schemas/User"
description: Username of the chat message poster.
body: body:
type: string type: string
description: Escaped HTML of the chat message content. description: Escaped HTML of the chat message content.
@ -1633,9 +1627,8 @@ paths:
items: items:
type: object type: object
properties: properties:
author: user:
type: string $ref: "#/components/schemas/User"
description: Username of the chat message poster.
body: body:
type: string type: string
description: Escaped HTML of the chat message content. description: Escaped HTML of the chat message content.