From 2f03a077f3493d0635463b4b73371faa19218908 Mon Sep 17 00:00:00 2001 From: Evgeniy Kosov Date: Thu, 27 Oct 2022 00:22:13 +0200 Subject: [PATCH] Add missing federation action images to webv2 (#2266) * Add missing federation action images to webv2 * Commit updated API documentation Co-authored-by: Owncast --- docs/api/index.html | 2 +- web/public/img/follow.svg | 1 + web/public/img/like.svg | 1 + web/public/img/repost.svg | 1 + 4 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 web/public/img/follow.svg create mode 100644 web/public/img/like.svg create mode 100644 web/public/img/repost.svg diff --git a/docs/api/index.html b/docs/api/index.html index 76004f76a..edf965626 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -2397,7 +2397,7 @@ data-styled.g138[id="sc-iIgjPs"]{content:"jIUTls,"}/*!sc*/

Current Status

This endpoint is used to discover when a server is broadcasting, the number of active viewers as well as other useful information for updating the user interface.

Responses

Response samples

Content type
application/json
{
  • "lastConnectTime": "2020-10-03T21:36:22-05:00",
  • "lastDisconnectTime": null,
  • "online": true,
  • "overallMaxViewerCount": 420,
  • "sessionMaxViewerCount": 12,
  • "viewerCount": 7
}

Yellow Pages Information

Information to be used in the Yellow Pages service, a global directory of Owncast servers.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "logo": "string",
  • "nsfw": true,
  • "tags": [
    ],
  • "online": true,
  • "viewerCount": 0,
  • "overallMaxViewerCount": 0,
  • "sessionMaxViewerCount": 0,
  • "lastConnectTime": "2019-08-24T14:15:22Z"
}

Get the public followers of this instance

Responses

Response samples

Content type
application/json
[]

Return the information needed to redirect a user to a fediverse server to perform a remote follow action.

Request Body schema: application/json
account
string

The fediverse username@server.tld account that wants to perform the remote follow action.

+

Response samples

Content type
application/json
[]

Return the information needed to redirect a user to a fediverse server to perform a remote follow action.

Request Body schema: application/json
account
string

The fediverse username@server.tld account that wants to perform the remote follow action.

Responses

Request samples

Content type
application/json
{
  • "account": "johnsmith@fediverse.biz"
}

Response samples