From ac02a5eaf96f51404b478d7802dc4fa1f6c8ccbd Mon Sep 17 00:00:00 2001
From: Dessalines
Date: Sat, 13 Mar 2021 23:01:40 -0500
Subject: [PATCH] Fixing husky
---
.husky/.gitignore | 2 +-
package.json | 1 +
src/assets/scripts/asyncapi.yaml | 2536 +++++++++++++--------------
src/shared/components/contact.tsx | 112 +-
src/shared/components/footer.tsx | 2 +-
src/shared/components/join.tsx | 20 +-
src/shared/components/link-line.tsx | 22 +-
src/shared/components/navbar.tsx | 58 +-
src/shared/components/sponsors.tsx | 204 ++-
9 files changed, 1509 insertions(+), 1448 deletions(-)
diff --git a/.husky/.gitignore b/.husky/.gitignore
index c9cdc63..31354ec 100644
--- a/.husky/.gitignore
+++ b/.husky/.gitignore
@@ -1 +1 @@
-_
\ No newline at end of file
+_
diff --git a/package.json b/package.json
index c50560f..5fc40e2 100644
--- a/package.json
+++ b/package.json
@@ -8,6 +8,7 @@
"build:prod": "webpack --mode=production",
"clean": "yarn run rimraf dist",
"lint": "tsc --noEmit && eslint --report-unused-disable-directives --ext .js,.ts,.tsx src",
+ "postinstall": "husky install",
"prebuild:dev": "yarn clean",
"prebuild:prod": "yarn clean",
"start": "yarn build:dev --watch"
diff --git a/src/assets/scripts/asyncapi.yaml b/src/assets/scripts/asyncapi.yaml
index ceb1667..6a9c340 100644
--- a/src/assets/scripts/asyncapi.yaml
+++ b/src/assets/scripts/asyncapi.yaml
@@ -1,7 +1,7 @@
asyncapi: 2.0.0
info:
title: Lemmy WebSocket API
- version: '2.0'
+ version: "2.0"
contact:
name: Mastodon
url: https://mastodon.social/@LemmyDev
@@ -60,9 +60,9 @@ info:
Lemmy also has an [HTTP API](https://join.lemmy.ml/docs/en/contributing/http_api.html) which is almost identical to the WebSocket API; however, this WebSocket API is the primary source since it also details the specifics of HTTP API calls.
- license:
+ license:
name: AGPL
- url: 'https://www.gnu.org/licenses/agpl-3.0.en.html'
+ url: "https://www.gnu.org/licenses/agpl-3.0.en.html"
servers:
ds9:
url: ds9.lemmy.ml/api/v2/ws
@@ -78,7 +78,7 @@ servers:
description: Voyager test server
externalDocs:
description: Lemmy documentation
- url: 'https://lemmy.ml/docs/index.html'
+ url: "https://lemmy.ml/docs/index.html"
tags:
- name: User, authentication and admin
- name: Site
@@ -99,7 +99,7 @@ channels:
tags:
- name: User, authentication and admin
message:
- $ref: '#/components/messages/loginRequest'
+ $ref: "#/components/messages/loginRequest"
subscribe:
summary: Login (response)
description: Returns an authentication string (`jwt`) for the supplied username or emal
@@ -108,8 +108,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/loginResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/loginResponse"
+ - $ref: "#/components/messages/errorResponse"
GetCaptcha:
publish:
summary: GetCaptcha (request)
@@ -123,7 +123,7 @@ channels:
tags:
- name: User, authentication and admin
message:
- $ref: '#/components/messages/getCaptchaRequest'
+ $ref: "#/components/messages/getCaptchaRequest"
subscribe:
summary: GetCaptcha (response)
description: Captcha details returned from the server
@@ -131,9 +131,9 @@ channels:
tags:
- name: User, authentication and admin
message:
- oneOf:
- - $ref: '#/components/messages/getCaptchaResponse'
- - $ref: '#/components/messages/errorResponse'
+ oneOf:
+ - $ref: "#/components/messages/getCaptchaResponse"
+ - $ref: "#/components/messages/errorResponse"
Register:
publish:
summary: Register (request)
@@ -147,15 +147,15 @@ channels:
tags:
- name: User, authentication and admin
message:
- $ref: '#/components/messages/registerRequest'
+ $ref: "#/components/messages/registerRequest"
subscribe:
summary: Register (response)
- description: 'The response to the registration request will be an authentication string (`jwt`) for that user'
+ description: "The response to the registration request will be an authentication string (`jwt`) for that user"
operationId: registerResponseMessage
tags:
- name: User, authentication and admin
message:
- $ref: '#/components/messages/registerResponse'
+ $ref: "#/components/messages/registerResponse"
GetUserDetails:
publish:
summary: GetUserDetails (request)
@@ -170,7 +170,7 @@ channels:
tags:
- name: User, authentication and admin
message:
- $ref: '#/components/messages/getUserDetailsRequest'
+ $ref: "#/components/messages/getUserDetailsRequest"
subscribe:
summary: GetUserDetails (response)
description: Returns full details about a specified user (including the last post the user wrote)
@@ -179,8 +179,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/getUserDetailsResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/getUserDetailsResponse"
+ - $ref: "#/components/messages/errorResponse"
SaveUserSettings:
publish:
summary: SaveUserSettings (request)
@@ -194,9 +194,9 @@ channels:
`PUT /user/save_user_settings`
operationId: saverUserSettingsRequestMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/saveUserSettingsRequest'
+ $ref: "#/components/messages/saveUserSettingsRequest"
subscribe:
summary: SaveUserSettings (response)
description: Get details about a specified user
@@ -205,8 +205,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/saveUserSettingsResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/saveUserSettingsResponse"
+ - $ref: "#/components/messages/errorResponse"
GetReplies:
publish:
summary: GetReplies (request)
@@ -218,9 +218,9 @@ channels:
`GET /user/replies`
operationId: getUserRepliesRequestMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/getUserRepliesRequest'
+ $ref: "#/components/messages/getUserRepliesRequest"
subscribe:
summary: GetReplies (response)
description: Returns detailed reply data
@@ -229,8 +229,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/repliesResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/repliesResponse"
+ - $ref: "#/components/messages/errorResponse"
GetUserMentions:
publish:
summary: GetUserMentions (request)
@@ -242,9 +242,9 @@ channels:
`GET /user/mention`
operationId: getUserMentionsRequestMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/getUserMentionsRequest'
+ $ref: "#/components/messages/getUserMentionsRequest"
subscribe:
summary: GetUserMentions (response)
description: Returns detailed data about mentions
@@ -253,8 +253,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/mentionsResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/mentionsResponse"
+ - $ref: "#/components/messages/errorResponse"
MarkUserMentionAsRead:
publish:
summary: MarkUserMentionAsRead (request)
@@ -266,9 +266,9 @@ channels:
`POST /user/mention/mark_as_read`
operationId: markMentionsRequestMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/markMentionsRequest'
+ $ref: "#/components/messages/markMentionsRequest"
subscribe:
summary: MarkUserMentionAsRead (response)
description: Returns detailed data about the mention
@@ -277,8 +277,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/markMentionResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/markMentionResponse"
+ - $ref: "#/components/messages/errorResponse"
GetPrivateMessages:
publish:
summary: GetPrivateMessages (request)
@@ -290,9 +290,9 @@ channels:
`GET /private_message/list`
operationId: getPrivateMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/privateMessageRequest'
+ $ref: "#/components/messages/privateMessageRequest"
subscribe:
summary: GetPrivateMessages (response)
description: Returns list of messages
@@ -301,8 +301,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/privateMessagesResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/privateMessagesResponse"
+ - $ref: "#/components/messages/errorResponse"
CreatePrivateMessage:
publish:
summary: CreatePrivateMessage (request)
@@ -314,9 +314,9 @@ channels:
`POST /private_message`
operationId: createPrivateMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/createPrivateMessageRequest'
+ $ref: "#/components/messages/createPrivateMessageRequest"
subscribe:
summary: CreatePrivateMessage (response)
description: Confirm sending of a private message
@@ -325,8 +325,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/createPrivateMessageResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/createPrivateMessageResponse"
+ - $ref: "#/components/messages/errorResponse"
EditPrivateMessage:
publish:
summary: EditPrivateMessage (request)
@@ -338,9 +338,9 @@ channels:
`PUT /private_message`
operationId: editPrivateMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/editPrivateMessageRequest'
+ $ref: "#/components/messages/editPrivateMessageRequest"
subscribe:
summary: EditPrivateMessage (response)
description: Confirm replacement of a private message
@@ -349,8 +349,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/editPrivateMessageResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/editPrivateMessageResponse"
+ - $ref: "#/components/messages/errorResponse"
DeletePrivateMessage:
publish:
summary: DeletePrivateMessage (request)
@@ -362,9 +362,9 @@ channels:
`POST /private_message/delete`
operationId: deletePrivateMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/deletePrivateMessageRequest'
+ $ref: "#/components/messages/deletePrivateMessageRequest"
subscribe:
summary: DeletePrivateMessage (response)
description: Confirm deletion of a private message
@@ -373,8 +373,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/deletePrivateMessageResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/deletePrivateMessageResponse"
+ - $ref: "#/components/messages/errorResponse"
MarkPrivateMessageAsRead:
publish:
summary: MarkPrivateMessageAsRead (request)
@@ -386,19 +386,19 @@ channels:
`POST /private_message/mark_as_read`
operationId: markPrivateMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/markPrivateMessageRequest'
+ $ref: "#/components/messages/markPrivateMessageRequest"
subscribe:
summary: MarkPrivateMessageAsRead (response)
- description: 'Confirm that a private message has been marked as *read*'
+ description: "Confirm that a private message has been marked as *read*"
operationId: markPrivateMessageResponse
tags:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/markPrivateMessageResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/markPrivateMessageResponse"
+ - $ref: "#/components/messages/errorResponse"
MarkAllAsRead:
publish:
summary: MarkAllAsRead (request)
@@ -410,19 +410,19 @@ channels:
`POST /user/mark_all_as_read`
operationId: markAllReadMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/markAllReadRequest'
+ $ref: "#/components/messages/markAllReadRequest"
subscribe:
summary: MarkAllAsRead (response)
- description: 'Confirm that all replies and mentions have been marked as *read*'
+ description: "Confirm that all replies and mentions have been marked as *read*"
operationId: markAllReadResponse
tags:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/markAllReadResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/markAllReadResponse"
+ - $ref: "#/components/messages/errorResponse"
DeleteAccount:
publish:
summary: DeleteAccount (request)
@@ -434,9 +434,9 @@ channels:
`POST /user/delete_account`
operationId: deleteAccountRequestMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/deleteAccountRequest'
+ $ref: "#/components/messages/deleteAccountRequest"
subscribe:
summary: DeleteAccount (response)
description: Confirm that the account has been deleted
@@ -445,8 +445,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/deleteAccountResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/deleteAccountResponse"
+ - $ref: "#/components/messages/errorResponse"
AddAdmin:
publish:
summary: AddAdmin (request)
@@ -460,9 +460,9 @@ channels:
`POST /admin/add`
operationId: addAdminRequestMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/addAdminRequest'
+ $ref: "#/components/messages/addAdminRequest"
subscribe:
summary: AddAdmin (response)
description: Confirm that the user has been given admin privileges
@@ -471,8 +471,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/addAdminResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/addAdminResponse"
+ - $ref: "#/components/messages/errorResponse"
BanUser:
publish:
summary: BanUser (request)
@@ -486,9 +486,9 @@ channels:
`POST /user/ban`
operationId: banUserRequestMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/banUserRequest'
+ $ref: "#/components/messages/banUserRequest"
subscribe:
summary: BanUser (response)
description: Confirm that the user has been banned
@@ -497,8 +497,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/banUserResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/banUserResponse"
+ - $ref: "#/components/messages/errorResponse"
UserJoin:
publish:
summary: UserJoin (request)
@@ -510,9 +510,9 @@ channels:
`POST /user/join`
operationId: userJoinRequestMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/userJoinRequest'
+ $ref: "#/components/messages/userJoinRequest"
subscribe:
summary: UserJoin (response)
description: Verification that you will receive these WebSocket messages
@@ -521,8 +521,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/userJoinResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/userJoinResponse"
+ - $ref: "#/components/messages/errorResponse"
GetReportCount:
publish:
summary: GetReportCount (request)
@@ -537,9 +537,9 @@ channels:
`GET /user/report_count`
operationId: getReportCountRequestMessage
tags:
- - name: User, authentication and admin
+ - name: User, authentication and admin
message:
- $ref: '#/components/messages/getReportCountRequest'
+ $ref: "#/components/messages/getReportCountRequest"
subscribe:
summary: GetReportCount (response)
description: |-
@@ -549,8 +549,8 @@ channels:
- name: User, authentication and admin
message:
oneOf:
- - $ref: '#/components/messages/getReportCountResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/getReportCountResponse"
+ - $ref: "#/components/messages/errorResponse"
Search:
publish:
summary: Search (request)
@@ -562,9 +562,9 @@ channels:
`GET /search`
operationId: searchMessage
tags:
- - name: Site
+ - name: Site
message:
- $ref: '#/components/messages/searchRequest'
+ $ref: "#/components/messages/searchRequest"
subscribe:
summary: Search (response)
description: Search results
@@ -573,8 +573,8 @@ channels:
- name: Site
message:
oneOf:
- - $ref: '#/components/messages/searchResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/searchResponse"
+ - $ref: "#/components/messages/errorResponse"
GetModLog:
publish:
summary: GetModLog (request)
@@ -586,9 +586,9 @@ channels:
`GET /modlog`
operationId: getmodLogRequestMessage
tags:
- - name: Site
+ - name: Site
message:
- $ref: '#/components/messages/getModLogRequest'
+ $ref: "#/components/messages/getModLogRequest"
subscribe:
summary: GetModLog (response)
description: Modlog request results
@@ -597,8 +597,8 @@ channels:
- name: Site
message:
oneOf:
- - $ref: '#/components/messages/getModLogResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/getModLogResponse"
+ - $ref: "#/components/messages/errorResponse"
CreateSite:
publish:
summary: CreateSite (request)
@@ -610,9 +610,9 @@ channels:
`POST /site`
operationId: createSiteRequestMessage
tags:
- - name: Site
+ - name: Site
message:
- $ref: '#/components/messages/createSiteRequest'
+ $ref: "#/components/messages/createSiteRequest"
subscribe:
summary: CreateSite (response)
description: Returns site details
@@ -621,8 +621,8 @@ channels:
- name: Site
message:
oneOf:
- - $ref: '#/components/messages/createSiteResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/createSiteResponse"
+ - $ref: "#/components/messages/errorResponse"
EditSite:
publish:
summary: EditSite (Request)
@@ -636,9 +636,9 @@ channels:
`PUT /site`
operationId: editSiteRequestMessage
tags:
- - name: Site
+ - name: Site
message:
- $ref: '#/components/messages/editSiteRequest'
+ $ref: "#/components/messages/editSiteRequest"
subscribe:
summary: EditSite (response)
description: Returns confirmation of site edit
@@ -647,8 +647,8 @@ channels:
- name: Site
message:
oneOf:
- - $ref: '#/components/messages/editSiteResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/editSiteResponse"
+ - $ref: "#/components/messages/errorResponse"
GetSite:
publish:
summary: GetSite (request)
@@ -660,9 +660,9 @@ channels:
`GET /site`
operationId: getSiteRequestMessage
tags:
- - name: Site
+ - name: Site
message:
- $ref: '#/components/messages/getSiteRequest'
+ $ref: "#/components/messages/getSiteRequest"
subscribe:
summary: GetSite (response)
description: Return full details about the site
@@ -671,8 +671,8 @@ channels:
- name: Site
message:
oneOf:
- - $ref: '#/components/messages/getSiteResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/getSiteResponse"
+ - $ref: "#/components/messages/errorResponse"
TransferSite:
publish:
summary: TransferSite (request)
@@ -684,9 +684,9 @@ channels:
`POST /site/transfer`
operationId: transferSiteRequestMessage
tags:
- - name: Site
+ - name: Site
message:
- $ref: '#/components/messages/transferSiteRequest'
+ $ref: "#/components/messages/transferSiteRequest"
subscribe:
summary: TransferSite (response)
description: Return full details about the site
@@ -695,8 +695,8 @@ channels:
- name: Site
message:
oneOf:
- - $ref: '#/components/messages/transferSiteResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/transferSiteResponse"
+ - $ref: "#/components/messages/errorResponse"
GetSiteConfig:
publish:
summary: GetSiteConfig (request)
@@ -708,9 +708,9 @@ channels:
`GET /site/config`
operationId: getSiteConfigRequestMessage
tags:
- - name: Site
+ - name: Site
message:
- $ref: '#/components/messages/getSiteConfigRequest'
+ $ref: "#/components/messages/getSiteConfigRequest"
subscribe:
summary: GetSiteConfig (response)
description: Return the configuration data for a Lemmy server
@@ -719,8 +719,8 @@ channels:
- name: Site
message:
oneOf:
- - $ref: '#/components/messages/getSiteConfigResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/getSiteConfigResponse"
+ - $ref: "#/components/messages/errorResponse"
SaveSiteConfig:
publish:
summary: SaveSiteConfig (request)
@@ -732,9 +732,9 @@ channels:
`PUT /site/config`
operationId: saveSiteConfigRequestMessage
tags:
- - name: Site
+ - name: Site
message:
- $ref: '#/components/messages/saveSiteConfigRequest'
+ $ref: "#/components/messages/saveSiteConfigRequest"
subscribe:
summary: SaveSiteConfig (response)
description: Return the configuration data file for a Lemmy server
@@ -743,8 +743,8 @@ channels:
- name: Site
message:
oneOf:
- - $ref: '#/components/messages/saveSiteConfigResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/saveSiteConfigResponse"
+ - $ref: "#/components/messages/errorResponse"
GetCommunity:
publish:
summary: GetCommunity (request)
@@ -756,9 +756,9 @@ channels:
`GET /community`
operationId: getCommunityRequestMessage
tags:
- - name: Community
+ - name: Community
message:
- $ref: '#/components/messages/getCommunityRequest'
+ $ref: "#/components/messages/getCommunityRequest"
subscribe:
summary: GetCommunity (response)
description: Return the details for a community
@@ -767,8 +767,8 @@ channels:
- name: Community
message:
oneOf:
- - $ref: '#/components/messages/getCommunityResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/getCommunityResponse"
+ - $ref: "#/components/messages/errorResponse"
CreateCommunity:
publish:
summary: CreateCommunity (request)
@@ -780,9 +780,9 @@ channels:
`POST /community`
operationId: createCommunityRequestMessage
tags:
- - name: Community
+ - name: Community
message:
- $ref: '#/components/messages/createCommunityRequest'
+ $ref: "#/components/messages/createCommunityRequest"
subscribe:
summary: CreateCommunity (response)
description: Return the details for a community
@@ -791,8 +791,8 @@ channels:
- name: Community
message:
oneOf:
- - $ref: '#/components/messages/createCommunityResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/createCommunityResponse"
+ - $ref: "#/components/messages/errorResponse"
ListCommunities:
publish:
summary: ListCommunities (request)
@@ -804,9 +804,9 @@ channels:
`GET /community/list`
operationId: listCommunityRequestMessage
tags:
- - name: Community
+ - name: Community
message:
- $ref: '#/components/messages/listCommunityRequest'
+ $ref: "#/components/messages/listCommunityRequest"
subscribe:
summary: ListCommunities (response)
description: Return the details for all communities
@@ -815,8 +815,8 @@ channels:
- name: Community
message:
oneOf:
- - $ref: '#/components/messages/listCommunityResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/listCommunityResponse"
+ - $ref: "#/components/messages/errorResponse"
BanFromCommunity:
publish:
summary: BanFromCommunity (request)
@@ -828,9 +828,9 @@ channels:
`POST /community/ban_user`
operationId: banFromCommunityRequestMessage
tags:
- - name: Community
+ - name: Community
message:
- $ref: '#/components/messages/banFromCommunityRequest'
+ $ref: "#/components/messages/banFromCommunityRequest"
subscribe:
summary: BanFromCommunity (response)
description: Confirmation after a ban request
@@ -839,8 +839,8 @@ channels:
- name: Community
message:
oneOf:
- - $ref: '#/components/messages/banFromCommunityResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/banFromCommunityResponse"
+ - $ref: "#/components/messages/errorResponse"
AddModToCommunity:
publish:
summary: AddModToCommunity (request)
@@ -854,9 +854,9 @@ channels:
`POST /community/mod`
operationId: addModToCommunityRequestMessage
tags:
- - name: Community
+ - name: Community
message:
- $ref: '#/components/messages/addModToCommunityRequest'
+ $ref: "#/components/messages/addModToCommunityRequest"
subscribe:
summary: AddModToCommunity (response)
description: Confirmation that the new moderator has been added
@@ -865,8 +865,8 @@ channels:
- name: Community
message:
oneOf:
- - $ref: '#/components/messages/addModToCommunityResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/addModToCommunityResponse"
+ - $ref: "#/components/messages/errorResponse"
EditCommunity:
publish:
description: |-
@@ -879,9 +879,9 @@ channels:
`PUT /community`
operationId: editCommunityRequestMessage
tags:
- - name: Community
+ - name: Community
message:
- $ref: '#/components/messages/editCommunityRequest'
+ $ref: "#/components/messages/editCommunityRequest"
subscribe:
summary: EditCommunity (response)
description: Return the details for the requested community
@@ -890,8 +890,8 @@ channels:
- name: Community
message:
oneOf:
- - $ref: '#/components/messages/editCommunityResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/editCommunityResponse"
+ - $ref: "#/components/messages/errorResponse"
DeleteCommunity:
publish:
summary: DeleteCommunity (request)
@@ -905,9 +905,9 @@ channels:
`POST /community/delete`
operationId: deleteCommunityRequestMessage
tags:
- - name: Community
+ - name: Community
message:
- $ref: '#/components/messages/deleteCommunityRequest'
+ $ref: "#/components/messages/deleteCommunityRequest"
subscribe:
summary: DeleteCommunity (response)
description: Return the details for the deleted community
@@ -916,8 +916,8 @@ channels:
- name: Community
message:
oneOf:
- - $ref: '#/components/messages/deleteCommunityResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/deleteCommunityResponse"
+ - $ref: "#/components/messages/errorResponse"
RemoveCommunity:
publish:
summary: RemoveCommunity (request)
@@ -931,9 +931,9 @@ channels:
`POST /community/remove`
operationId: removeCommunityRequestMessage
tags:
- - name: Community
+ - name: Community
message:
- $ref: '#/components/messages/removeCommunityRequest'
+ $ref: "#/components/messages/removeCommunityRequest"
subscribe:
summary: RemoveCommunity (response)
description: Return the details for the deleted community
@@ -942,8 +942,8 @@ channels:
- name: Community
message:
oneOf:
- - $ref: '#/components/messages/removeCommunityResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/removeCommunityResponse"
+ - $ref: "#/components/messages/errorResponse"
FollowCommunity:
publish:
summary: FollowCommunity (request)
@@ -955,9 +955,9 @@ channels:
`POST /community/follow`
operationId: followCommunityRequestMessage
tags:
- - name: Community
+ - name: Community
message:
- $ref: '#/components/messages/followCommunityRequest'
+ $ref: "#/components/messages/followCommunityRequest"
subscribe:
summary: FollowCommunity (response)
description: Return the details for the followed community
@@ -966,8 +966,8 @@ channels:
- name: Community
message:
oneOf:
- - $ref: '#/components/messages/followCommunityResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/followCommunityResponse"
+ - $ref: "#/components/messages/errorResponse"
GetFollowedCommunities:
publish:
summary: GetFollowedCommunities (request)
@@ -979,9 +979,9 @@ channels:
`GET /user/followed_communities`
operationId: getFollowedCommunitiesRequestMessage
tags:
- - name: Community
+ - name: Community
message:
- $ref: '#/components/messages/getFollowedCommunitiesRequest'
+ $ref: "#/components/messages/getFollowedCommunitiesRequest"
subscribe:
summary: GetFollowedCommunities (response)
description: Return the details for the followed communities
@@ -990,8 +990,8 @@ channels:
- name: Community
message:
oneOf:
- - $ref: '#/components/messages/getFollowedCommunitiesResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/getFollowedCommunitiesResponse"
+ - $ref: "#/components/messages/errorResponse"
TransferCommunity:
publish:
summary: TransferCommunity (Request)
@@ -1005,9 +1005,9 @@ channels:
`POST /community/transfer`
operationId: transferCommunityRequestMessage
tags:
- - name: Community
+ - name: Community
message:
- $ref: '#/components/messages/transferCommunityRequest'
+ $ref: "#/components/messages/transferCommunityRequest"
subscribe:
summary: TransferCommunity (response)
description: Response to a request to transfer community ownership
@@ -1016,8 +1016,8 @@ channels:
- name: Community
message:
oneOf:
- - $ref: '#/components/messages/transferCommunityResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/transferCommunityResponse"
+ - $ref: "#/components/messages/errorResponse"
CommunityJoin:
publish:
summary: CommunityJoin (request)
@@ -1029,9 +1029,9 @@ channels:
`POST /community/join`
operationId: communityJoinRequestMessage
tags:
- - name: Community
+ - name: Community
message:
- $ref: '#/components/messages/communityJoinRequest'
+ $ref: "#/components/messages/communityJoinRequest"
subscribe:
summary: CommunityJoin (response)
description: Verification that you will receive these WebSocket messages
@@ -1040,8 +1040,8 @@ channels:
- name: Community
message:
oneOf:
- - $ref: '#/components/messages/communityJoinResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/communityJoinResponse"
+ - $ref: "#/components/messages/errorResponse"
ModJoin:
publish:
summary: ModJoin (request)
@@ -1053,9 +1053,9 @@ channels:
`POST /community/mod/join`
operationId: modJoinRequestMessage
tags:
- - name: Community
+ - name: Community
message:
- $ref: '#/components/messages/modJoinRequest'
+ $ref: "#/components/messages/modJoinRequest"
subscribe:
summary: ModJoin (response)
description: Verification that you will receive these WebSocket messages
@@ -1064,8 +1064,8 @@ channels:
- name: Community
message:
oneOf:
- - $ref: '#/components/messages/modJoinResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/modJoinResponse"
+ - $ref: "#/components/messages/errorResponse"
CreatePost:
publish:
summary: CreatePost (request)
@@ -1077,9 +1077,9 @@ channels:
`POST /post`
operationId: createPostRequestMessage
tags:
- - name: Post
+ - name: Post
message:
- $ref: '#/components/messages/createPostRequest'
+ $ref: "#/components/messages/createPostRequest"
subscribe:
summary: CreatePost (response)
description: Forthcoming...
@@ -1088,8 +1088,8 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/createPostResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/createPostResponse"
+ - $ref: "#/components/messages/errorResponse"
GetPost:
publish:
summary: GetPost (request)
@@ -1101,9 +1101,9 @@ channels:
`GET /post`
operationId: getPostRequestMessage
tags:
- - name: Post
+ - name: Post
message:
- $ref: '#/components/messages/getPostRequest'
+ $ref: "#/components/messages/getPostRequest"
subscribe:
summary: GetPost (response)
description: Details of a post
@@ -1112,8 +1112,8 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/getPostResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/getPostResponse"
+ - $ref: "#/components/messages/errorResponse"
GetPosts:
publish:
summary: GetPosts (request)
@@ -1130,9 +1130,9 @@ channels:
`GET /post/list`
operationId: getPostListRequestMessage
tags:
- - name: Post
+ - name: Post
message:
- $ref: '#/components/messages/getPostListRequest'
+ $ref: "#/components/messages/getPostListRequest"
subscribe:
summary: GetPost (response)
description: Details of a post
@@ -1141,8 +1141,8 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/getPostListResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/getPostListResponse"
+ - $ref: "#/components/messages/errorResponse"
CreatePostLike:
publish:
summary: CreatePostLike (request)
@@ -1154,9 +1154,9 @@ channels:
`POST /post/like`
operationId: createPostLikeRequestMessage
tags:
- - name: Post
+ - name: Post
message:
- $ref: '#/components/messages/createPostLikeRequest'
+ $ref: "#/components/messages/createPostLikeRequest"
subscribe:
summary: CreatePostLike (response)
description: Forthcoming...
@@ -1165,8 +1165,8 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/createPostLikeResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/createPostLikeResponse"
+ - $ref: "#/components/messages/errorResponse"
EditPost:
publish:
summary: EditPost (request)
@@ -1178,9 +1178,9 @@ channels:
`PUT /post`
operationId: editPostRequestMessage
tags:
- - name: Post
+ - name: Post
message:
- $ref: '#/components/messages/editPostRequest'
+ $ref: "#/components/messages/editPostRequest"
subscribe:
summary: EditPost (response)
description: Response to request to edit a post
@@ -1189,8 +1189,8 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/editPostResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/editPostResponse"
+ - $ref: "#/components/messages/errorResponse"
DeletePost:
publish:
summary: DeletePost (request)
@@ -1202,9 +1202,9 @@ channels:
`POST /post/delete`
operationId: deletePostRequestMessage
tags:
- - name: Post
+ - name: Post
message:
- $ref: '#/components/messages/deletePostRequest'
+ $ref: "#/components/messages/deletePostRequest"
subscribe:
summary: DeletePost (response)
description: Response to a post deletion request
@@ -1213,8 +1213,8 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/deletePostResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/deletePostResponse"
+ - $ref: "#/components/messages/errorResponse"
RemovePost:
publish:
summary: RemovePost (request)
@@ -1228,9 +1228,9 @@ channels:
`POST /post/remove`
operationId: removePostRequestMessage
tags:
- - name: Post
+ - name: Post
message:
- $ref: '#/components/messages/removePostRequest'
+ $ref: "#/components/messages/removePostRequest"
subscribe:
summary: RemovePost (response)
description: Response to a post removal request
@@ -1239,8 +1239,8 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/removePostResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/removePostResponse"
+ - $ref: "#/components/messages/errorResponse"
LockPost:
publish:
summary: LockPost (request)
@@ -1254,9 +1254,9 @@ channels:
`POST /post/lock`
operationId: postLockRequestMessage
tags:
- - name: Post
+ - name: Post
message:
- $ref: '#/components/messages/postLockRequest'
+ $ref: "#/components/messages/postLockRequest"
subscribe:
summary: LockPost (response)
description: Response to a post lock request
@@ -1265,8 +1265,8 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/postLockResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/postLockResponse"
+ - $ref: "#/components/messages/errorResponse"
StickyPost:
publish:
summary: StickyPost (request)
@@ -1280,9 +1280,9 @@ channels:
`POST /post/sticky`
operationId: stickyPostRequestMessage
tags:
- - name: Post
+ - name: Post
message:
- $ref: '#/components/messages/stickyPostRequest'
+ $ref: "#/components/messages/stickyPostRequest"
subscribe:
summary: StickyPost (response)
description: |-
@@ -1292,22 +1292,22 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/stickyPostResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/stickyPostResponse"
+ - $ref: "#/components/messages/errorResponse"
SavePost:
publish:
summary: SavePost (request)
description: |-
Add a post to the user's list of saved posts.
-
+
#### HTTP API - operation and endpoint.
-
+
`POST /post/save`
operationId: savePostRequestMessage
tags:
- name: Post
message:
- $ref: '#/components/messages/savePostRequest'
+ $ref: "#/components/messages/savePostRequest"
subscribe:
summary: SavePost (response)
description: Response to a request to add a post to the list of saved posts
@@ -1316,22 +1316,22 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/savePostResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/savePostResponse"
+ - $ref: "#/components/messages/errorResponse"
PostJoin:
publish:
summary: PostJoin (request)
description: |-
Join to receive WebSocket messages for this post's comments.
-
+
#### HTTP API - operation and endpoint.
-
+
`POST /post/join`
operationId: postJoinRequestMessage
tags:
- name: Post
message:
- $ref: '#/components/messages/postJoinRequest'
+ $ref: "#/components/messages/postJoinRequest"
subscribe:
summary: PostJoin (response)
description: Verification that you will receive these WebSocket messages
@@ -1340,22 +1340,22 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/postJoinResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/postJoinResponse"
+ - $ref: "#/components/messages/errorResponse"
CreatePostReport:
publish:
summary: CreatePostReport (request)
description: |-
Raise a report (query) against a post.
-
+
#### HTTP API - operation and endpoint.
-
+
`POST /post/report`
operationId: createPostReportRequestMessage
tags:
- name: Post
message:
- $ref: '#/components/messages/createPostReportRequest'
+ $ref: "#/components/messages/createPostReportRequest"
subscribe:
summary: CreatePostReport (response)
description: Forthcoming...
@@ -1364,8 +1364,8 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/createPostReportResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/createPostReportResponse"
+ - $ref: "#/components/messages/errorResponse"
ResolvePostReport:
publish:
summary: ResolvePostReport (request)
@@ -1373,15 +1373,15 @@ channels:
Resolve (clear) a report against a post.
See `ListPostReports` for a list of all reported posts.
-
+
#### HTTP API - operation and endpoint.
-
+
`PUT /post/report/resolve`
operationId: resolvePostReportRequestMessage
tags:
- name: Post
message:
- $ref: '#/components/messages/resolvePostReportRequest'
+ $ref: "#/components/messages/resolvePostReportRequest"
subscribe:
summary: ResolvePostReport (response)
description: Response to request to resolve a report against a post
@@ -1390,23 +1390,23 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/resolvePostReportResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/resolvePostReportResponse"
+ - $ref: "#/components/messages/errorResponse"
ListPostReports:
publish:
summary: ListPostReports (request)
description: |-
- If `community` is supplied, returns reports for only that community
- Otherwise returns reports for all communities the user (`auth`) moderates.
-
+
#### HTTP API - operation and endpoint.
-
+
`GET /post/report/list`
operationId: listPostReportsRequestMessage
tags:
- name: Post
message:
- $ref: '#/components/messages/listPostReportsRequest'
+ $ref: "#/components/messages/listPostReportsRequest"
subscribe:
summary: ListPostReports (response)
description: Response to request to list all reports against posts
@@ -1415,22 +1415,22 @@ channels:
- name: Post
message:
oneOf:
- - $ref: '#/components/messages/listPostReportsResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/listPostReportsResponse"
+ - $ref: "#/components/messages/errorResponse"
CreateComment:
publish:
summary: CreateComment (request)
description: |-
Add a comment to a post.
-
+
#### HTTP API - operation and endpoint.
-
+
`POST /comment`
operationId: createCommentRequestMessage
tags:
- name: Comment
message:
- $ref: '#/components/messages/createCommentRequest'
+ $ref: "#/components/messages/createCommentRequest"
subscribe:
summary: CreateComment (response)
description: Response to request to create a comment
@@ -1439,22 +1439,22 @@ channels:
- name: Comment
message:
oneOf:
- - $ref: '#/components/messages/createCommentResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/createCommentResponse"
+ - $ref: "#/components/messages/errorResponse"
EditComment:
publish:
summary: EditComment (request)
description: |-
Edit a comment (only the comment's creator can do this).
-
+
#### HTTP API - operation and endpoint.
-
+
`PUT /comment`
operationId: editCommentRequestMessage
tags:
- name: Comment
message:
- $ref: '#/components/messages/createCommentRequest'
+ $ref: "#/components/messages/createCommentRequest"
subscribe:
summary: EditComment (response)
description: Response to request to edit a comment
@@ -1463,22 +1463,22 @@ channels:
- name: Comment
message:
oneOf:
- - $ref: '#/components/messages/editCommentResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/editCommentResponse"
+ - $ref: "#/components/messages/errorResponse"
DeleteComment:
publish:
summary: DeleteComment (request)
description: |-
Delete a comment (only the comment's creator can do this).
-
+
#### HTTP API - operation and endpoint.
-
+
`POST /comment/delete`
operationId: deleteCommentRequestMessage
tags:
- name: Comment
message:
- $ref: '#/components/messages/deleteCommentRequest'
+ $ref: "#/components/messages/deleteCommentRequest"
subscribe:
summary: DeleteComment (response)
description: Response to request to delete a comment
@@ -1487,8 +1487,8 @@ channels:
- name: Comment
message:
oneOf:
- - $ref: '#/components/messages/deleteCommentResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/deleteCommentResponse"
+ - $ref: "#/components/messages/errorResponse"
RemoveComment:
publish:
summary: RemoveComment (request)
@@ -1496,15 +1496,15 @@ channels:
Request that a comment is *permanently* deleted.
Only admin and moderator roles can do this.
-
+
#### HTTP API - operation and endpoint.
-
+
`POST /comment/remove`
operationId: removeCommentRequestMessage
tags:
- name: Comment
message:
- $ref: '#/components/messages/removeCommentRequest'
+ $ref: "#/components/messages/removeCommentRequest"
subscribe:
summary: RemoveComment (response)
description: Response to request to permanently delete a comment
@@ -1513,8 +1513,8 @@ channels:
- name: Comment
message:
oneOf:
- - $ref: '#/components/messages/removeCommentResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/removeCommentResponse"
+ - $ref: "#/components/messages/errorResponse"
GetComments:
publish:
summary: GetComments (request)
@@ -1525,15 +1525,15 @@ channels:
If specifying a community, use:
- `community_name` for a local community
- `community_id` for a federated community.
-
+
#### HTTP API - operation and endpoint.
-
+
`GET /comment/list`
operationId: getCommentsRequestMessage
tags:
- name: Comment
message:
- $ref: '#/components/messages/getCommentsRequest'
+ $ref: "#/components/messages/getCommentsRequest"
subscribe:
summary: GetComments (response)
description: Response to request to list all comments
@@ -1542,8 +1542,8 @@ channels:
- name: Comment
message:
oneOf:
- - $ref: '#/components/messages/getCommentsResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/getCommentsResponse"
+ - $ref: "#/components/messages/errorResponse"
MarkCommentAsRead:
publish:
summary: MarkCommentAsRead (request)
@@ -1555,9 +1555,9 @@ channels:
`POST /comment/mark_as_read`
operationId: markCommentRequestMessage
tags:
- - name: Comment
+ - name: Comment
message:
- $ref: '#/components/messages/markCommentRequest'
+ $ref: "#/components/messages/markCommentRequest"
subscribe:
summary: MarkCommentAsRead (response)
description: Response to request mark a comment as read
@@ -1566,8 +1566,8 @@ channels:
- name: Comment
message:
oneOf:
- - $ref: '#/components/messages/markCommentResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/markCommentResponse"
+ - $ref: "#/components/messages/errorResponse"
SaveComment:
publish:
summary: SaveComment (request)
@@ -1579,9 +1579,9 @@ channels:
`PUT /comment/save`
operationId: saveCommentRequestMessage
tags:
- - name: Comment
+ - name: Comment
message:
- $ref: '#/components/messages/saveCommentRequest'
+ $ref: "#/components/messages/saveCommentRequest"
subscribe:
summary: SaveComment (response)
description: Response to request to save a comment
@@ -1590,8 +1590,8 @@ channels:
- name: Comment
message:
oneOf:
- - $ref: '#/components/messages/saveCommentResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/saveCommentResponse"
+ - $ref: "#/components/messages/errorResponse"
CreateCommentLike:
publish:
summary: CreateCommentLike (request)
@@ -1603,9 +1603,9 @@ channels:
`POST /comment/like`
operationId: createCommentLikeRequestMessage
tags:
- - name: Comment
+ - name: Comment
message:
- $ref: '#/components/messages/createCommentLikeRequest'
+ $ref: "#/components/messages/createCommentLikeRequest"
subscribe:
summary: CreateCommentLike (response)
description: Forthcoming...
@@ -1614,22 +1614,22 @@ channels:
- name: Comment
message:
oneOf:
- - $ref: '#/components/messages/createCommentLikeResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/createCommentLikeResponse"
+ - $ref: "#/components/messages/errorResponse"
CreateCommentReport:
publish:
summary: CreateCommentReport (request)
description: |-
Raise a report (query) against a comment.
-
+
#### HTTP API - operation and endpoint.
-
+
`POST /comment/report`
operationId: createCommentReportRequestMessage
tags:
- name: Comment
message:
- $ref: '#/components/messages/createCommentReportRequest'
+ $ref: "#/components/messages/createCommentReportRequest"
subscribe:
summary: CreateCommentReport(response)
description: Response to raising a report against a comment
@@ -1638,8 +1638,8 @@ channels:
- name: Comment
message:
oneOf:
- - $ref: '#/components/messages/createCommentReportResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/createCommentReportResponse"
+ - $ref: "#/components/messages/errorResponse"
ResolveCommentReport:
publish:
summary: ResolveCommentReport (request)
@@ -1647,15 +1647,15 @@ channels:
Resolve (clear) a report against a comment.
See `ListCommentReports` for a list of all reported comments.
-
+
#### HTTP API - operation and endpoint.
-
+
`PUT /comment/report/resolve`
operationId: resolveCommentReportRequestMessage
tags:
- name: Comment
message:
- $ref: '#/components/messages/resolveCommentReportRequest'
+ $ref: "#/components/messages/resolveCommentReportRequest"
subscribe:
summary: ResolveCommentReport (response)
description: Response to a request to clear a report against a comment
@@ -1664,23 +1664,23 @@ channels:
- name: Comment
message:
oneOf:
- - $ref: '#/components/messages/resolveCommentReportResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/resolveCommentReportResponse"
+ - $ref: "#/components/messages/errorResponse"
ListCommentReports:
publish:
summary: ListCommentReports (request)
description: |-
- If `community` is supplied, returns reports for only that community
- Otherwise returns reports for all communities the user (`auth`) moderates.
-
+
#### HTTP API - operation and endpoint.
-
+
`GET /comment/report/list`
operationId: listCommentReportsRequestMessage
tags:
- name: Comment
message:
- $ref: '#/components/messages/listCommentReportsRequest'
+ $ref: "#/components/messages/listCommentReportsRequest"
subscribe:
summary: ListCommentReports (response)
description: Response to a request to list all comment reports
@@ -1689,8 +1689,8 @@ channels:
- name: Comment
message:
oneOf:
- - $ref: '#/components/messages/listCommentReportsResponse'
- - $ref: '#/components/messages/errorResponse'
+ - $ref: "#/components/messages/listCommentReportsResponse"
+ - $ref: "#/components/messages/errorResponse"
components:
messages:
errorResponse:
@@ -1699,9 +1699,9 @@ components:
type: object
properties:
error:
- description: 'The error message'
+ description: "The error message"
type: string
- example: 'passwords_dont_match'
+ example: "passwords_dont_match"
loginRequest:
name: Login request
payload:
@@ -1712,8 +1712,8 @@ components:
properties:
op:
type: string
- pattern: '^Login$'
- default: 'Login'
+ pattern: "^Login$"
+ default: "Login"
data:
type: object
required:
@@ -1721,9 +1721,9 @@ components:
- password
properties:
username_or_email:
- $ref: '#/components/schemas/username_or_email'
+ $ref: "#/components/schemas/username_or_email"
password:
- $ref: '#/components/schemas/password'
+ $ref: "#/components/schemas/password"
loginResponse:
name: Login response
payload:
@@ -1731,10 +1731,10 @@ components:
properties:
op:
type: string
- pattern: '^Login$'
- default: 'Login'
+ pattern: "^Login$"
+ default: "Login"
data:
- $ref: '#/components/schemas/authSchema'
+ $ref: "#/components/schemas/authSchema"
getUserRepliesRequest:
name: User replies request
payload:
@@ -1745,10 +1745,10 @@ components:
properties:
op:
type: string
- pattern: '^GetReplies$'
- default: 'GetReplies'
+ pattern: "^GetReplies$"
+ default: "GetReplies"
data:
- $ref: '#/components/schemas/repliesMentionsRequest'
+ $ref: "#/components/schemas/repliesMentionsRequest"
getUserMentionsRequest:
name: User mentions request
payload:
@@ -1759,10 +1759,10 @@ components:
properties:
op:
type: string
- pattern: '^GetUserMentions$'
- default: 'GetUserMentions'
+ pattern: "^GetUserMentions$"
+ default: "GetUserMentions"
data:
- $ref: '#/components/schemas/repliesMentionsRequest'
+ $ref: "#/components/schemas/repliesMentionsRequest"
getCaptchaRequest:
name: Captcha request
payload:
@@ -1773,8 +1773,8 @@ components:
properties:
op:
type: string
- pattern: '^GetCaptcha$'
- default: 'GetCaptcha'
+ pattern: "^GetCaptcha$"
+ default: "GetCaptcha"
data:
type: object
getCaptchaResponse:
@@ -1784,25 +1784,25 @@ components:
properties:
op:
type: string
- pattern: '^GetCaptcha$'
- default: 'GetCaptcha'
+ pattern: "^GetCaptcha$"
+ default: "GetCaptcha"
data:
type: object
properties:
ok:
type: object
- description: 'Will be *undefined* if Captcha is disabled on the Lemmy server'
+ description: "Will be *undefined* if Captcha is disabled on the Lemmy server"
properties:
png:
type: string
- description: 'A [Base64 encoded](https://www.base64encode.org/) representation of the Captcha image (in .PNG format)'
+ description: "A [Base64 encoded](https://www.base64encode.org/) representation of the Captcha image (in .PNG format)"
wav:
type: string
- description: 'A [Base64 encoded](https://www.base64encode.org/) representation of the Captcha audio (in .WAV format)'
+ description: "A [Base64 encoded](https://www.base64encode.org/) representation of the Captcha audio (in .WAV format)"
uuid:
type: string
description: The unique id of the Catpcha request
- example: '77cfa414-999e-4445-9940-cebe86139d14'
+ example: "77cfa414-999e-4445-9940-cebe86139d14"
registerRequest:
name: Register a user on the Lemmy server
payload:
@@ -1813,8 +1813,8 @@ components:
properties:
op:
type: string
- pattern: '^Register$'
- default: 'Register'
+ pattern: "^Register$"
+ default: "Register"
data:
type: object
required:
@@ -1826,32 +1826,32 @@ components:
properties:
username:
type: string
- description: 'The name for the new user'
- example: 'testuser'
+ description: "The name for the new user"
+ example: "testuser"
email:
description: |-
The user's email address
type: string
format: email
password:
- $ref: '#/components/schemas/password'
+ $ref: "#/components/schemas/password"
password_verify:
- $ref: '#/components/schemas/password'
+ $ref: "#/components/schemas/password"
admin:
type: boolean
- description: 'Set to *true* if this is to be the admin user. Only the user who was *first* registered on the Lemmy server is allowed to be admin.'
+ description: "Set to *true* if this is to be the admin user. Only the user who was *first* registered on the Lemmy server is allowed to be admin."
example: false
default: false
show_nsfw:
- $ref: '#/components/schemas/show_nsfw'
+ $ref: "#/components/schemas/show_nsfw"
captcha_uuid:
type: string
- description: 'The unique id of the Catpcha request (as reported by **GetCaptcha**)'
- example: '77cfa414-999e-4445-9940-cebe86139d14'
+ description: "The unique id of the Catpcha request (as reported by **GetCaptcha**)"
+ example: "77cfa414-999e-4445-9940-cebe86139d14"
captcha_answer:
type: string
- description: 'The *answer* to the Captcha test'
- example: 'EjhBi7'
+ description: "The *answer* to the Captcha test"
+ example: "EjhBi7"
registerResponse:
name: Registration request response
payload:
@@ -1859,10 +1859,10 @@ components:
properties:
op:
type: string
- pattern: '^Register$'
- default: 'Register'
+ pattern: "^Register$"
+ default: "Register"
data:
- $ref: '#/components/schemas/authSchema'
+ $ref: "#/components/schemas/authSchema"
saveUserSettingsRequest:
name: Save user settings - response
payload:
@@ -1873,47 +1873,47 @@ components:
properties:
op:
type: string
- pattern: '^SaveUserSettings$'
- default: 'SaveUserSettings'
+ pattern: "^SaveUserSettings$"
+ default: "SaveUserSettings"
data:
type: object
required:
- show_nsfw
properties:
show_nsfw:
- $ref: '#/components/schemas/show_nsfw'
+ $ref: "#/components/schemas/show_nsfw"
theme:
- $ref: '#/components/schemas/theme'
+ $ref: "#/components/schemas/theme"
default_sort_type:
- $ref: '#/components/schemas/default_sort_type'
+ $ref: "#/components/schemas/default_sort_type"
default_listing_type:
- $ref: '#/components/schemas/default_listing_type'
+ $ref: "#/components/schemas/default_listing_type"
lang:
- $ref: '#/components/schemas/lang'
+ $ref: "#/components/schemas/lang"
avatar:
- $ref: '#/components/schemas/avatar'
+ $ref: "#/components/schemas/avatar"
banner:
- $ref: '#/components/schemas/banner'
+ $ref: "#/components/schemas/banner"
preferred_username:
- $ref: '#/components/schemas/preferred_username'
+ $ref: "#/components/schemas/preferred_username"
email:
- $ref: '#/components/schemas/email'
+ $ref: "#/components/schemas/email"
bio:
- $ref: '#/components/schemas/bio'
+ $ref: "#/components/schemas/bio"
matrix_user_id:
- $ref: '#/components/schemas/matrix_user_id'
+ $ref: "#/components/schemas/matrix_user_id"
new_password:
- $ref: '#/components/schemas/password'
+ $ref: "#/components/schemas/password"
new_password_verify:
- $ref: '#/components/schemas/password'
+ $ref: "#/components/schemas/password"
old_password:
- $ref: '#/components/schemas/password'
+ $ref: "#/components/schemas/password"
show_avatars:
- $ref: '#/components/schemas/show_avatars'
+ $ref: "#/components/schemas/show_avatars"
send_notifications_to_email:
- $ref: '#/components/schemas/send_notifications_to_email'
+ $ref: "#/components/schemas/send_notifications_to_email"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
getUserDetailsRequest:
name: Return requested user details
payload:
@@ -1924,8 +1924,8 @@ components:
properties:
op:
type: string
- pattern: '^GetUserDetails$'
- default: 'GetUserDetails'
+ pattern: "^GetUserDetails$"
+ default: "GetUserDetails"
data:
type: object
required:
@@ -1933,24 +1933,24 @@ components:
- saved_only
properties:
user_id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
username:
- $ref: '#/components/schemas/user_name'
+ $ref: "#/components/schemas/user_name"
sort:
- $ref: '#/components/schemas/sort'
+ $ref: "#/components/schemas/sort"
page:
- $ref: '#/components/schemas/page'
+ $ref: "#/components/schemas/page"
limit:
- $ref: '#/components/schemas/limit'
+ $ref: "#/components/schemas/limit"
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
saved_only:
type: boolean
description: Forthcoming...
default: false
example: false
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
saveUserSettingsResponse:
name: Response to saving user settings (profile)
payload:
@@ -1958,13 +1958,13 @@ components:
properties:
op:
type: string
- pattern: '^SaveUserSettings$'
- default: 'SaveUserSettings'
+ pattern: "^SaveUserSettings$"
+ default: "SaveUserSettings"
data:
type: object
properties:
jwt:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
getUserDetailsResponse:
name: User details request response
payload:
@@ -1972,27 +1972,27 @@ components:
properties:
op:
type: string
- pattern: '^GetUserDetails$'
- default: 'GetUserDetails'
+ pattern: "^GetUserDetails$"
+ default: "GetUserDetails"
data:
type: object
user:
- $ref: '#/components/schemas/user_view'
+ $ref: "#/components/schemas/user_view"
posts:
- $ref: '#/components/schemas/replies'
+ $ref: "#/components/schemas/replies"
comments:
- $ref: '#/components/schemas/comments'
+ $ref: "#/components/schemas/comments"
moderates:
- $ref: '#/components/schemas/moderators'
+ $ref: "#/components/schemas/moderators"
follows:
description: The list of followers (members) for each community
type: array
items:
properties:
follower:
- $ref: '#/components/schemas/user'
+ $ref: "#/components/schemas/user"
community:
- $ref: '#/components/schemas/community'
+ $ref: "#/components/schemas/community"
repliesResponse:
name: Returning user replies response
payload:
@@ -2002,11 +2002,11 @@ components:
type: object
properties:
replies:
- $ref: '#/components/schemas/replies'
+ $ref: "#/components/schemas/replies"
op:
type: string
- pattern: '^GetReplies$'
- default: 'GetReplies'
+ pattern: "^GetReplies$"
+ default: "GetReplies"
mentionsResponse:
name: Returning user mentions response
payload:
@@ -2021,11 +2021,11 @@ components:
items:
properties:
UserMentionView:
- $ref: '#/components/schemas/mentions'
+ $ref: "#/components/schemas/mentions"
op:
type: string
- pattern: '^GetUserMentions$'
- default: 'GetUserMentions'
+ pattern: "^GetUserMentions$"
+ default: "GetUserMentions"
markMentionsRequest:
name: Request to make a user mention as read
payload:
@@ -2036,21 +2036,21 @@ components:
properties:
op:
type: string
- pattern: '^MarkUserMentionAsRead$'
- default: 'MarkUserMentionAsRead'
+ pattern: "^MarkUserMentionAsRead$"
+ default: "MarkUserMentionAsRead"
data:
type: object
properties:
user_mention_id:
- description: 'The id of the recipient'
+ description: "The id of the recipient"
type: integer
format: int32
read:
- description: 'Forthcoming...'
+ description: "Forthcoming..."
type: boolean
example: false
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
markMentionResponse:
name: Returning response for marked mention
payload:
@@ -2058,13 +2058,13 @@ components:
properties:
op:
type: string
- pattern: '^MarkUserMentionAsRead$'
- default: 'MarkUserMentionAsRead'
+ pattern: "^MarkUserMentionAsRead$"
+ default: "MarkUserMentionAsRead"
data:
type: object
properties:
mention:
- $ref: '#/components/schemas/mentions'
+ $ref: "#/components/schemas/mentions"
privateMessageRequest:
name: Request to list all a user's private messages
payload:
@@ -2075,8 +2075,8 @@ components:
properties:
op:
type: string
- pattern: '^GetPrivateMessages$'
- default: 'GetPrivateMessages'
+ pattern: "^GetPrivateMessages$"
+ default: "GetPrivateMessages"
data:
type: object
required:
@@ -2084,13 +2084,13 @@ components:
- auth
properties:
unread_only:
- $ref: '#/components/schemas/unread_only'
+ $ref: "#/components/schemas/unread_only"
page:
- $ref: '#/components/schemas/page'
+ $ref: "#/components/schemas/page"
limit:
- $ref: '#/components/schemas/limit'
+ $ref: "#/components/schemas/limit"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
privateMessagesResponse:
name: List of all a user's private messages
payload:
@@ -2102,11 +2102,11 @@ components:
private_messages:
type: array
items:
- $ref: '#/components/schemas/private_message_view'
+ $ref: "#/components/schemas/private_message_view"
op:
type: string
- pattern: '^GetPrivateMessages$'
- default: 'GetPrivateMessages'
+ pattern: "^GetPrivateMessages$"
+ default: "GetPrivateMessages"
createPrivateMessageRequest:
name: |-
Request to create a private message
@@ -2118,8 +2118,8 @@ components:
properties:
op:
type: string
- pattern: '^CreatePrivateMessage$'
- default: 'CreatePrivateMessage'
+ pattern: "^CreatePrivateMessage$"
+ default: "CreatePrivateMessage"
data:
type: object
required:
@@ -2128,11 +2128,11 @@ components:
- auth
properties:
content:
- $ref: '#/components/schemas/content'
+ $ref: "#/components/schemas/content"
recipient_id:
- $ref: '#/components/schemas/recipient'
+ $ref: "#/components/schemas/recipient"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
createPrivateMessageResponse:
name: |-
Confirmation of the sent private message
@@ -2141,13 +2141,13 @@ components:
properties:
op:
type: string
- pattern: '^CreatePrivateMessage$'
- default: 'CreatePrivateMessage'
+ pattern: "^CreatePrivateMessage$"
+ default: "CreatePrivateMessage"
data:
type: object
properties:
private_message_view:
- $ref: '#/components/schemas/private_message_view'
+ $ref: "#/components/schemas/private_message_view"
editPrivateMessageRequest:
name: Request to edit a private message
payload:
@@ -2158,8 +2158,8 @@ components:
properties:
op:
type: string
- pattern: '^EditPrivateMessage$'
- default: 'EditPrivateMessage'
+ pattern: "^EditPrivateMessage$"
+ default: "EditPrivateMessage"
data:
type: object
required:
@@ -2168,11 +2168,11 @@ components:
- auth
properties:
private_message_id:
- $ref: '#/components/schemas/private_message_id'
+ $ref: "#/components/schemas/private_message_id"
content:
- $ref: '#/components/schemas/content'
+ $ref: "#/components/schemas/content"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
editPrivateMessageResponse:
name: Confirmation of the edited private message
payload:
@@ -2182,11 +2182,11 @@ components:
type: object
properties:
private_message_view:
- $ref: '#/components/schemas/private_message_view'
+ $ref: "#/components/schemas/private_message_view"
op:
type: string
- pattern: '^EditPrivateMessage$'
- default: 'EditPrivateMessage'
+ pattern: "^EditPrivateMessage$"
+ default: "EditPrivateMessage"
deletePrivateMessageRequest:
name: Request to delete a private message
payload:
@@ -2197,8 +2197,8 @@ components:
properties:
op:
type: string
- pattern: '^DeletePrivateMessage$'
- default: 'DeletePrivateMessage'
+ pattern: "^DeletePrivateMessage$"
+ default: "DeletePrivateMessage"
data:
type: object
required:
@@ -2207,11 +2207,11 @@ components:
- auth
properties:
private_message_id:
- $ref: '#/components/schemas/private_message_id'
+ $ref: "#/components/schemas/private_message_id"
deleted:
- $ref: '#/components/schemas/deleted'
+ $ref: "#/components/schemas/deleted"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
deletePrivateMessageResponse:
name: Confirmation of the deleted private message
payload:
@@ -2221,11 +2221,11 @@ components:
type: object
properties:
private_message_view:
- $ref: '#/components/schemas/private_message_view'
+ $ref: "#/components/schemas/private_message_view"
op:
type: string
- pattern: '^DeletePrivateMessage$'
- default: 'DeletePrivateMessage'
+ pattern: "^DeletePrivateMessage$"
+ default: "DeletePrivateMessage"
markPrivateMessageRequest:
name: Request to mark a private message as read
payload:
@@ -2236,8 +2236,8 @@ components:
properties:
op:
type: string
- pattern: '^MarkPrivateMessageAsRead$'
- default: 'MarkPrivateMessageAsRead'
+ pattern: "^MarkPrivateMessageAsRead$"
+ default: "MarkPrivateMessageAsRead"
data:
type: object
required:
@@ -2246,13 +2246,13 @@ components:
- auth
properties:
private_message_id:
- $ref: '#/components/schemas/private_message_id'
+ $ref: "#/components/schemas/private_message_id"
read:
- $ref: '#/components/schemas/read'
+ $ref: "#/components/schemas/read"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
markPrivateMessageResponse:
- name: 'Confirmation that the private message has been marked as *read*'
+ name: "Confirmation that the private message has been marked as *read*"
payload:
type: object
properties:
@@ -2260,11 +2260,11 @@ components:
type: object
properties:
private_message_view:
- $ref: '#/components/schemas/private_message_view'
+ $ref: "#/components/schemas/private_message_view"
op:
type: string
- pattern: '^MarkPrivateMessageAsRead$'
- default: 'MarkPrivateMessageAsRead'
+ pattern: "^MarkPrivateMessageAsRead$"
+ default: "MarkPrivateMessageAsRead"
markAllReadRequest:
name: Request to mark all user replies and mentions as read
payload:
@@ -2275,17 +2275,17 @@ components:
properties:
op:
type: string
- pattern: '^MarkAllAsRead$'
- default: 'MarkAllAsRead'
+ pattern: "^MarkAllAsRead$"
+ default: "MarkAllAsRead"
data:
type: object
required:
- auth
properties:
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
markAllReadResponse:
- name: 'Confirmation that all replies and mentions have been marked as *read*'
+ name: "Confirmation that all replies and mentions have been marked as *read*"
payload:
type: object
properties:
@@ -2293,11 +2293,11 @@ components:
type: object
properties:
replies:
- $ref: '#/components/schemas/replies'
+ $ref: "#/components/schemas/replies"
op:
type: string
- pattern: '^MarkAllAsRead$'
- default: 'MarkAllAsRead'
+ pattern: "^MarkAllAsRead$"
+ default: "MarkAllAsRead"
deleteAccountRequest:
name: Request to delete a user account
payload:
@@ -2308,8 +2308,8 @@ components:
properties:
op:
type: string
- pattern: '^DeleteAccount$'
- default: 'DeleteAccount'
+ pattern: "^DeleteAccount$"
+ default: "DeleteAccount"
data:
type: object
required:
@@ -2317,9 +2317,9 @@ components:
- auth
properties:
password:
- $ref: '#/components/schemas/password'
+ $ref: "#/components/schemas/password"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
deleteAccountResponse:
name: Confirmation that the account has been deleted
payload:
@@ -2329,11 +2329,11 @@ components:
type: object
properties:
jwt:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
op:
type: string
- pattern: '^DeleteAccount$'
- default: 'DeleteAccount'
+ pattern: "^DeleteAccount$"
+ default: "DeleteAccount"
addAdminRequest:
name: Request to grant admin privileges to a user
payload:
@@ -2344,8 +2344,8 @@ components:
properties:
op:
type: string
- pattern: '^AddAdmin$'
- default: 'AddAdmin'
+ pattern: "^AddAdmin$"
+ default: "AddAdmin"
data:
type: object
required:
@@ -2354,11 +2354,11 @@ components:
- auth
properties:
user_id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
added:
- $ref: '#/components/schemas/added'
+ $ref: "#/components/schemas/added"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
addAdminResponse:
name: Confirmation that the user has been given admin privileges
payload:
@@ -2366,13 +2366,13 @@ components:
properties:
op:
type: string
- pattern: '^AddAdmin$'
- default: 'AddAdmin'
+ pattern: "^AddAdmin$"
+ default: "AddAdmin"
data:
type: object
properties:
admins:
- $ref: '#/components/schemas/user_view'
+ $ref: "#/components/schemas/user_view"
banUserRequest:
name: Request to ban a user
payload:
@@ -2383,8 +2383,8 @@ components:
properties:
op:
type: string
- pattern: '^BanUser$'
- default: 'BanUser'
+ pattern: "^BanUser$"
+ default: "BanUser"
data:
type: object
required:
@@ -2393,17 +2393,17 @@ components:
- auth
properties:
user_id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
ban:
- $ref: '#/components/schemas/ban'
+ $ref: "#/components/schemas/ban"
remove_data:
- $ref: '#/components/schemas/remove_data'
+ $ref: "#/components/schemas/remove_data"
reason:
- $ref: '#/components/schemas/reason'
+ $ref: "#/components/schemas/reason"
expires:
- $ref: '#/components/schemas/expires'
+ $ref: "#/components/schemas/expires"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
banUserResponse:
name: Confirmation that the user has been banned
payload:
@@ -2411,10 +2411,10 @@ components:
properties:
op:
type: string
- pattern: '^BanUser$'
- default: 'BanUser'
+ pattern: "^BanUser$"
+ default: "BanUser"
data:
- $ref: '#/components/schemas/ban_view'
+ $ref: "#/components/schemas/ban_view"
userJoinRequest:
name: Request to receive WebSocket messages for this user.
payload:
@@ -2425,15 +2425,15 @@ components:
properties:
op:
type: string
- pattern: '^UserJoin$'
- default: 'UserJoin'
+ pattern: "^UserJoin$"
+ default: "UserJoin"
data:
type: object
required:
- auth
properties:
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
userJoinResponse:
name: Verification that you will receive these WebSocket messages
payload:
@@ -2441,13 +2441,13 @@ components:
properties:
op:
type: string
- pattern: '^UserJoin$'
- default: 'UserJoin'
+ pattern: "^UserJoin$"
+ default: "UserJoin"
data:
type: object
properties:
joined:
- $ref: '#/components/schemas/joined'
+ $ref: "#/components/schemas/joined"
getReportCountRequest:
name: Request to return report count numbers
payload:
@@ -2458,17 +2458,17 @@ components:
properties:
op:
type: string
- pattern: '^GetReportCount$'
- default: 'GetReportCount'
+ pattern: "^GetReportCount$"
+ default: "GetReportCount"
data:
type: object
required:
- auth
properties:
community:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
getReportCountResponse:
name: Report on the number of posts and comments
payload:
@@ -2476,8 +2476,8 @@ components:
properties:
op:
type: string
- pattern: '^GetReportCount$'
- default: 'GetReportCount'
+ pattern: "^GetReportCount$"
+ default: "GetReportCount"
data:
type: object
properties:
@@ -2487,7 +2487,7 @@ components:
format: int64
example: 123
community:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
post_reports:
description: The number of posts in the community/communities
type: integer
@@ -2503,8 +2503,8 @@ components:
properties:
op:
type: string
- pattern: '^Search$'
- default: 'Search'
+ pattern: "^Search$"
+ default: "Search"
data:
type: object
required:
@@ -2515,21 +2515,21 @@ components:
q:
description: The text to search for on the Lemmy server
type: string
- example: 'lemmy'
+ example: "lemmy"
type_:
- $ref: '#/components/schemas/type_'
+ $ref: "#/components/schemas/type_"
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
community_name:
- $ref: '#/components/schemas/community_name'
+ $ref: "#/components/schemas/community_name"
sort:
- $ref: '#/components/schemas/sort'
+ $ref: "#/components/schemas/sort"
page:
- $ref: '#/components/schemas/page'
+ $ref: "#/components/schemas/page"
limit:
- $ref: '#/components/schemas/limit'
+ $ref: "#/components/schemas/limit"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
searchResponse:
name: The search results
payload:
@@ -2537,8 +2537,8 @@ components:
properties:
op:
type: string
- pattern: '^Search$'
- default: 'Search'
+ pattern: "^Search$"
+ default: "Search"
data:
type: object
properties:
@@ -2547,19 +2547,19 @@ components:
items:
properties:
community:
- $ref: '#/components/schemas/community'
+ $ref: "#/components/schemas/community"
posts:
- $ref: '#/components/schemas/replies'
+ $ref: "#/components/schemas/replies"
type_:
- $ref: '#/components/schemas/type_'
+ $ref: "#/components/schemas/type_"
users:
type: array
items:
properties:
user:
- $ref: '#/components/schemas/user_view'
+ $ref: "#/components/schemas/user_view"
comments:
- $ref: '#/components/schemas/comments'
+ $ref: "#/components/schemas/comments"
getModLogRequest:
name: Request the site's Modlog
payload:
@@ -2570,19 +2570,19 @@ components:
properties:
op:
type: string
- pattern: '^GetModLog$'
- default: 'GetModLog'
+ pattern: "^GetModLog$"
+ default: "GetModLog"
data:
type: object
properties:
mod_user_id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
page:
- $ref: '#/components/schemas/page'
+ $ref: "#/components/schemas/page"
limit:
- $ref: '#/components/schemas/limit'
+ $ref: "#/components/schemas/limit"
getModLogResponse:
name: Modlog request results
payload:
@@ -2593,8 +2593,8 @@ components:
properties:
op:
type: string
- pattern: '^GetModLog$'
- default: 'GetModLog'
+ pattern: "^GetModLog$"
+ default: "GetModLog"
data:
type: object
properties:
@@ -2612,21 +2612,21 @@ components:
type: number
example: 1
mod_user_id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
locked:
- $ref: '#/components/schemas/locked'
+ $ref: "#/components/schemas/locked"
when_:
- description: 'The date this post was locked (in [ISO8601 format](https://www.w3.org/TR/NOTE-datetime))'
+ description: "The date this post was locked (in [ISO8601 format](https://www.w3.org/TR/NOTE-datetime))"
type: string
- example: '2021-01-26T14:15:21.922339'
+ example: "2021-01-26T14:15:21.922339"
moderator:
- $ref: '#/components/schemas/creator'
+ $ref: "#/components/schemas/creator"
post:
- $ref: '#/components/schemas/post'
+ $ref: "#/components/schemas/post"
community:
- $ref: '#/components/schemas/community'
+ $ref: "#/components/schemas/community"
stickied_posts:
type: array
items:
@@ -2639,21 +2639,21 @@ components:
type: number
example: 1
mod_user_id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
stickied:
- $ref: '#/components/schemas/stickied'
+ $ref: "#/components/schemas/stickied"
when_:
- description: 'The date this post was made sticky (in [ISO8601 format](https://www.w3.org/TR/NOTE-datetime))'
+ description: "The date this post was made sticky (in [ISO8601 format](https://www.w3.org/TR/NOTE-datetime))"
type: string
- example: '2021-01-26T14:16:03.899093'
+ example: "2021-01-26T14:16:03.899093"
moderator:
- $ref: '#/components/schemas/creator'
+ $ref: "#/components/schemas/creator"
post:
- $ref: '#/components/schemas/post'
+ $ref: "#/components/schemas/post"
community:
- $ref: '#/components/schemas/community'
+ $ref: "#/components/schemas/community"
removed_comments:
description: Forthcoming...
type: array
@@ -2682,10 +2682,10 @@ components:
properties:
op:
type: string
- pattern: '^CreateSite$'
- default: 'CreateSite'
+ pattern: "^CreateSite$"
+ default: "CreateSite"
data:
- $ref: '#/components/schemas/site_properties'
+ $ref: "#/components/schemas/site_properties"
createSiteResponse:
name: Returns Lemmy site details
payload:
@@ -2693,13 +2693,13 @@ components:
properties:
op:
type: string
- pattern: '^CreateSite$'
- default: 'CreateSite'
+ pattern: "^CreateSite$"
+ default: "CreateSite"
data:
type: object
properties:
site_view:
- $ref: '#/components/schemas/site_view'
+ $ref: "#/components/schemas/site_view"
editSiteRequest:
name: Request to edit Lemmy site details
payload:
@@ -2710,10 +2710,10 @@ components:
properties:
op:
type: string
- pattern: '^EditSite$'
- default: 'EditSite'
+ pattern: "^EditSite$"
+ default: "EditSite"
data:
- $ref: '#/components/schemas/site_properties'
+ $ref: "#/components/schemas/site_properties"
editSiteResponse:
name: The response after a site edit
payload:
@@ -2721,13 +2721,13 @@ components:
properties:
op:
type: string
- pattern: '^EditSite$'
- default: 'EditSite'
+ pattern: "^EditSite$"
+ default: "EditSite"
data:
type: object
properties:
site_view:
- $ref: '#/components/schemas/site_view'
+ $ref: "#/components/schemas/site_view"
getSiteRequest:
name: Request to return Lemmy site details
payload:
@@ -2738,15 +2738,15 @@ components:
properties:
op:
type: string
- pattern: '^GetSite$'
- default: 'GetSite'
+ pattern: "^GetSite$"
+ default: "GetSite"
data:
type: object
required:
- auth
properties:
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
getSiteResponse:
name: Returns Lemmy site details
payload:
@@ -2754,23 +2754,23 @@ components:
properties:
op:
type: string
- pattern: '^GetSite$'
- default: 'GetSite'
+ pattern: "^GetSite$"
+ default: "GetSite"
data:
type: object
properties:
site_view:
- $ref: '#/components/schemas/site_view'
+ $ref: "#/components/schemas/site_view"
federated_instances:
- $ref: '#/components/schemas/federated_instances'
+ $ref: "#/components/schemas/federated_instances"
my_user:
- $ref: '#/components/schemas/my_user'
+ $ref: "#/components/schemas/my_user"
version:
- $ref: '#/components/schemas/version'
+ $ref: "#/components/schemas/version"
banned:
- $ref: '#/components/schemas/banned_list'
+ $ref: "#/components/schemas/banned_list"
online:
- $ref: '#/components/schemas/online'
+ $ref: "#/components/schemas/online"
admins:
type: array
items:
@@ -2783,7 +2783,7 @@ components:
type: number
example: 8
user_id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
post_score:
description: Forthcoming...
type: number
@@ -2801,7 +2801,7 @@ components:
type: number
example: 9
user:
- $ref: '#/components/schemas/creator'
+ $ref: "#/components/schemas/creator"
transferSiteRequest:
name: Request to transfer ownership of the site
payload:
@@ -2812,8 +2812,8 @@ components:
properties:
op:
type: string
- pattern: '^TransferSite$'
- default: 'TransferSite'
+ pattern: "^TransferSite$"
+ default: "TransferSite"
data:
type: object
required:
@@ -2821,9 +2821,9 @@ components:
- auth
properties:
user_id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
transferSiteResponse:
name: Request to transfer ownership of the site
payload:
@@ -2834,32 +2834,32 @@ components:
properties:
op:
type: string
- pattern: '^TransferSite$'
- default: 'TransferSite'
+ pattern: "^TransferSite$"
+ default: "TransferSite"
data:
type: object
properties:
site_view:
- $ref: '#/components/schemas/site_view'
+ $ref: "#/components/schemas/site_view"
admins:
description: The list of administrators for this site
type: array
items:
properties:
user:
- $ref: '#/components/schemas/user'
+ $ref: "#/components/schemas/user"
counts:
- $ref: '#/components/schemas/counts'
+ $ref: "#/components/schemas/counts"
banned:
- $ref: '#/components/schemas/banned_list'
+ $ref: "#/components/schemas/banned_list"
online:
- $ref: '#/components/schemas/online'
+ $ref: "#/components/schemas/online"
version:
- $ref: '#/components/schemas/version'
+ $ref: "#/components/schemas/version"
my_user:
- $ref: '#/components/schemas/my_user'
+ $ref: "#/components/schemas/my_user"
federated_instances:
- $ref: '#/components/schemas/federated_instances'
+ $ref: "#/components/schemas/federated_instances"
getSiteConfigRequest:
name: Request the configuration data for a Lemmy server
payload:
@@ -2870,15 +2870,15 @@ components:
properties:
op:
type: string
- pattern: '^GetSiteConfig$'
- default: 'GetSiteConfig'
+ pattern: "^GetSiteConfig$"
+ default: "GetSiteConfig"
data:
type: object
required:
- auth
properties:
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
getSiteConfigResponse:
name: Returns the configuration data for a Lemmy server
payload:
@@ -2886,13 +2886,13 @@ components:
properties:
op:
type: string
- pattern: '^GetSiteConfig$'
- default: 'GetSiteConfig'
+ pattern: "^GetSiteConfig$"
+ default: "GetSiteConfig"
data:
type: object
properties:
config_hjson:
- $ref: '#/components/schemas/config_hjson'
+ $ref: "#/components/schemas/config_hjson"
saveSiteConfigRequest:
name: Request to send a configuration data file for a Lemmy server
payload:
@@ -2903,8 +2903,8 @@ components:
properties:
op:
type: string
- pattern: '^SaveSiteConfig$'
- default: 'SaveSiteConfig'
+ pattern: "^SaveSiteConfig$"
+ default: "SaveSiteConfig"
data:
type: object
required:
@@ -2912,9 +2912,9 @@ components:
- auth
properties:
config_hjson:
- $ref: '#/components/schemas/config_hjson'
+ $ref: "#/components/schemas/config_hjson"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
saveSiteConfigResponse:
name: Returns the configuration data for a Lemmy server
payload:
@@ -2922,13 +2922,13 @@ components:
properties:
op:
type: string
- pattern: '^SaveSiteConfig$'
- default: '^SaveSiteConfig$'
+ pattern: "^SaveSiteConfig$"
+ default: "^SaveSiteConfig$"
data:
type: object
properties:
config_hjson:
- $ref: '#/components/schemas/config_hjson'
+ $ref: "#/components/schemas/config_hjson"
getCommunityRequest:
name: Request to get details of a commmunity
payload:
@@ -2939,17 +2939,17 @@ components:
properties:
op:
type: string
- pattern: '^GetCommunity$'
- default: 'GetCommunity'
+ pattern: "^GetCommunity$"
+ default: "GetCommunity"
data:
type: object
properties:
id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
name:
- $ref: '#/components/schemas/community_name'
+ $ref: "#/components/schemas/community_name"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
getCommunityResponse:
name: Returns the details for a community
payload:
@@ -2957,17 +2957,17 @@ components:
properties:
op:
type: string
- pattern: '^GetCommunity$'
- default: 'GetCommunity'
+ pattern: "^GetCommunity$"
+ default: "GetCommunity"
data:
type: object
properties:
community_view:
- $ref: '#/components/schemas/community_view'
+ $ref: "#/components/schemas/community_view"
online:
type: number
moderators:
- $ref: '#/components/schemas/moderators'
+ $ref: "#/components/schemas/moderators"
createCommunityRequest:
name: Request to get details of a commmunity
payload:
@@ -2978,8 +2978,8 @@ components:
properties:
op:
type: string
- pattern: '^CreateCommunity$'
- default: 'CreateCommunity'
+ pattern: "^CreateCommunity$"
+ default: "CreateCommunity"
data:
type: object
required:
@@ -2989,19 +2989,19 @@ components:
- auth
properties:
name:
- $ref: '#/components/schemas/community_name'
+ $ref: "#/components/schemas/community_name"
title:
- $ref: '#/components/schemas/title'
+ $ref: "#/components/schemas/title"
description:
- $ref: '#/components/schemas/description'
+ $ref: "#/components/schemas/description"
icon:
- $ref: '#/components/schemas/icon'
+ $ref: "#/components/schemas/icon"
banner:
- $ref: '#/components/schemas/banner'
+ $ref: "#/components/schemas/banner"
nsfw:
- $ref: '#/components/schemas/nsfw'
+ $ref: "#/components/schemas/nsfw"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
createCommunityResponse:
name: Response to the request to create a community
payload:
@@ -3012,13 +3012,13 @@ components:
properties:
op:
type: string
- pattern: '^CreateCommunity$'
- default: 'CreateCommunity'
+ pattern: "^CreateCommunity$"
+ default: "CreateCommunity"
data:
type: object
properties:
community_view:
- $ref: '#/components/schemas/community_view'
+ $ref: "#/components/schemas/community_view"
listCommunityRequest:
name: Request list of communities on the Lemmy server
payload:
@@ -3029,8 +3029,8 @@ components:
properties:
op:
type: string
- pattern: '^ListCommunities$'
- default: 'ListCommunities'
+ pattern: "^ListCommunities$"
+ default: "ListCommunities"
data:
type: object
required:
@@ -3038,15 +3038,15 @@ components:
- sort
properties:
type_:
- $ref: '#/components/schemas/type_'
+ $ref: "#/components/schemas/type_"
sort:
- $ref: '#/components/schemas/sort'
+ $ref: "#/components/schemas/sort"
page:
- $ref: '#/components/schemas/page'
+ $ref: "#/components/schemas/page"
limit:
- $ref: '#/components/schemas/limit'
+ $ref: "#/components/schemas/limit"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
listCommunityResponse:
name: Response to the request to list all communities
payload:
@@ -3054,14 +3054,14 @@ components:
properties:
op:
type: string
- pattern: '^ListCommunities$'
- default: 'ListCommunities'
+ pattern: "^ListCommunities$"
+ default: "ListCommunities"
data:
type: object
properties:
communities:
type: array
- $ref: '#/components/schemas/community_view'
+ $ref: "#/components/schemas/community_view"
banFromCommunityRequest:
name: Request to ban a user from a specified community.
payload:
@@ -3072,8 +3072,8 @@ components:
properties:
op:
type: string
- pattern: '^BanFromCommunity$'
- default: 'BanFromCommunity'
+ pattern: "^BanFromCommunity$"
+ default: "BanFromCommunity"
data:
type: object
required:
@@ -3083,19 +3083,19 @@ components:
- auth
properties:
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
user_id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
ban:
- $ref: '#/components/schemas/ban'
+ $ref: "#/components/schemas/ban"
remove_data:
- $ref: '#/components/schemas/remove_data'
+ $ref: "#/components/schemas/remove_data"
reason:
- $ref: '#/components/schemas/reason'
+ $ref: "#/components/schemas/reason"
expires:
- $ref: '#/components/schemas/expires'
+ $ref: "#/components/schemas/expires"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
banFromCommunityResponse:
name: Response to the request to ban a user from a community
payload:
@@ -3103,10 +3103,10 @@ components:
properties:
op:
type: string
- pattern: '^BanFromCommunity$'
- default: 'BanFromCommunity'
+ pattern: "^BanFromCommunity$"
+ default: "BanFromCommunity"
data:
- $ref: '#/components/schemas/ban_view'
+ $ref: "#/components/schemas/ban_view"
addModToCommunityRequest:
name: Request to add a moderator to a community
payload:
@@ -3117,8 +3117,8 @@ components:
properties:
op:
type: string
- pattern: '^AddModToCommunity$'
- default: 'AddModToCommunity'
+ pattern: "^AddModToCommunity$"
+ default: "AddModToCommunity"
data:
type: object
required:
@@ -3128,13 +3128,13 @@ components:
- auth
properties:
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
user_id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
added:
- $ref: '#/components/schemas/added'
+ $ref: "#/components/schemas/added"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
addModToCommunityResponse:
name: Confirmation that a moderator has been added to the community
payload:
@@ -3142,13 +3142,13 @@ components:
properties:
op:
type: string
- pattern: '^AddModToCommunity$'
- default: 'AddModToCommunity'
+ pattern: "^AddModToCommunity$"
+ default: "AddModToCommunity"
data:
type: object
properties:
moderators:
- $ref: '#/components/schemas/moderators'
+ $ref: "#/components/schemas/moderators"
editCommunityRequest:
name: Request to edit a community
payload:
@@ -3159,8 +3159,8 @@ components:
properties:
op:
type: string
- pattern: '^EditCommunity$'
- default: 'EditCommunity'
+ pattern: "^EditCommunity$"
+ default: "EditCommunity"
data:
type: object
required:
@@ -3170,19 +3170,19 @@ components:
- auth
properties:
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
title:
- $ref: '#/components/schemas/title'
+ $ref: "#/components/schemas/title"
description:
- $ref: '#/components/schemas/description'
+ $ref: "#/components/schemas/description"
icon:
- $ref: '#/components/schemas/icon'
+ $ref: "#/components/schemas/icon"
banner:
- $ref: '#/components/schemas/banner'
+ $ref: "#/components/schemas/banner"
nsfw:
- $ref: '#/components/schemas/nsfw'
+ $ref: "#/components/schemas/nsfw"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
editCommunityResponse:
name: Response to the request to edit a community
payload:
@@ -3190,13 +3190,13 @@ components:
properties:
op:
type: string
- pattern: '^EditCommunity$'
- default: 'EditCommunity'
+ pattern: "^EditCommunity$"
+ default: "EditCommunity"
data:
type: object
properties:
community_view:
- $ref: '#/components/schemas/community_view'
+ $ref: "#/components/schemas/community_view"
deleteCommunityRequest:
name: Request to delete a community
payload:
@@ -3207,8 +3207,8 @@ components:
properties:
op:
type: string
- pattern: '^DeleteCommunity$'
- default: 'DeleteCommunity'
+ pattern: "^DeleteCommunity$"
+ default: "DeleteCommunity"
data:
type: object
required:
@@ -3217,11 +3217,11 @@ components:
- auth
properties:
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
deleted:
- $ref: '#/components/schemas/deleted'
+ $ref: "#/components/schemas/deleted"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
deleteCommunityResponse:
name: Response to the request to delete a community
payload:
@@ -3229,13 +3229,13 @@ components:
properties:
op:
type: string
- pattern: '^DeleteCommunity$'
- default: 'DeleteCommunity'
+ pattern: "^DeleteCommunity$"
+ default: "DeleteCommunity"
data:
type: object
properties:
community_view:
- $ref: '#/components/schemas/community_view'
+ $ref: "#/components/schemas/community_view"
removeCommunityRequest:
name: Request to permanently delete a community
payload:
@@ -3246,8 +3246,8 @@ components:
properties:
op:
type: string
- pattern: '^RemoveCommunity$'
- default: 'RemoveCommunity'
+ pattern: "^RemoveCommunity$"
+ default: "RemoveCommunity"
data:
type: object
required:
@@ -3256,15 +3256,15 @@ components:
- auth
properties:
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
removed:
- $ref: '#/components/schemas/removed'
+ $ref: "#/components/schemas/removed"
reason:
- $ref: '#/components/schemas/reason'
+ $ref: "#/components/schemas/reason"
expires:
- $ref: '#/components/schemas/expires'
+ $ref: "#/components/schemas/expires"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
removeCommunityResponse:
name: Response to the request to permanently delete a community
payload:
@@ -3272,13 +3272,13 @@ components:
properties:
op:
type: string
- pattern: '^RemoveCommunity$'
- default: 'RemoveCommunity'
+ pattern: "^RemoveCommunity$"
+ default: "RemoveCommunity"
data:
type: object
properties:
community_view:
- $ref: '#/components/schemas/community_view'
+ $ref: "#/components/schemas/community_view"
followCommunityRequest:
name: Request to follow a community
payload:
@@ -3289,8 +3289,8 @@ components:
properties:
op:
type: string
- pattern: '^FollowCommunity$'
- default: 'FollowCommunity'
+ pattern: "^FollowCommunity$"
+ default: "FollowCommunity"
data:
type: object
required:
@@ -3299,13 +3299,13 @@ components:
- auth
properties:
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
follow:
description: Forthcoming...
type: boolean
example: true
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
followCommunityResponse:
name: Response to the request to follow a community
payload:
@@ -3313,13 +3313,13 @@ components:
properties:
op:
type: string
- pattern: '^FollowCommunity$'
- default: 'FollowCommunity'
+ pattern: "^FollowCommunity$"
+ default: "FollowCommunity"
data:
type: object
properties:
community_view:
- $ref: '#/components/schemas/community_view'
+ $ref: "#/components/schemas/community_view"
getFollowedCommunitiesRequest:
name: Request to list all followed communities
payload:
@@ -3330,15 +3330,15 @@ components:
properties:
op:
type: string
- pattern: '^GetFollowedCommunities$'
- default: 'GetFollowedCommunities'
+ pattern: "^GetFollowedCommunities$"
+ default: "GetFollowedCommunities"
data:
type: object
required:
- auth
properties:
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
getFollowedCommunitiesResponse:
name: List of followed communities
payload:
@@ -3346,8 +3346,8 @@ components:
properties:
op:
type: string
- pattern: '^GetFollowedCommunities$'
- default: 'GetFollowedCommunities'
+ pattern: "^GetFollowedCommunities$"
+ default: "GetFollowedCommunities"
data:
type: object
properties:
@@ -3356,9 +3356,9 @@ components:
items:
properties:
community:
- $ref: '#/components/schemas/community'
+ $ref: "#/components/schemas/community"
follower:
- $ref: '#/components/schemas/user'
+ $ref: "#/components/schemas/user"
transferCommunityRequest:
name: Request to transfer ownership of a community from one person to another
payload:
@@ -3369,8 +3369,8 @@ components:
properties:
op:
type: string
- pattern: '^TransferCommunity$'
- default: 'TransferCommunity'
+ pattern: "^TransferCommunity$"
+ default: "TransferCommunity"
data:
type: object
required:
@@ -3379,11 +3379,11 @@ components:
- auth
properties:
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
user_id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
transferCommunityResponse:
name: Response to a request to transfer community ownership
payload:
@@ -3391,17 +3391,17 @@ components:
properties:
op:
type: string
- pattern: '^TransferCommunity$'
- default: 'TransferCommunity'
+ pattern: "^TransferCommunity$"
+ default: "TransferCommunity"
data:
type: object
properties:
moderators:
- $ref: '#/components/schemas/moderators'
+ $ref: "#/components/schemas/moderators"
online:
- $ref: '#/components/schemas/online'
+ $ref: "#/components/schemas/online"
community_view:
- $ref: '#/components/schemas/community_view'
+ $ref: "#/components/schemas/community_view"
communityJoinRequest:
name: Request to receive WebSocket messages for this community's posts
payload:
@@ -3412,15 +3412,15 @@ components:
properties:
op:
type: string
- pattern: '^CommunityJoin$'
- default: 'CommunityJoin'
+ pattern: "^CommunityJoin$"
+ default: "CommunityJoin"
data:
type: object
required:
- community_id
properties:
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
communityJoinResponse:
name: Verification that you will receive these WebSocket messages
payload:
@@ -3428,12 +3428,12 @@ components:
properties:
op:
type: string
- pattern: '^CommunityJoin$'
- default: 'CommunityJoin'
+ pattern: "^CommunityJoin$"
+ default: "CommunityJoin"
data:
properties:
joined:
- $ref: '#/components/schemas/joined'
+ $ref: "#/components/schemas/joined"
modJoinRequest:
name: Request to receive WebSocket messages for community moderator updates such as reports.
payload:
@@ -3444,15 +3444,15 @@ components:
properties:
op:
type: string
- pattern: '^ModJoin$'
- default: 'ModJoin'
+ pattern: "^ModJoin$"
+ default: "ModJoin"
data:
type: object
required:
- community_id
properties:
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
modJoinResponse:
name: Verification that you will receive these WebSocket messages
payload:
@@ -3460,12 +3460,12 @@ components:
properties:
op:
type: string
- pattern: '^ModJoin$'
- default: 'ModJoin'
+ pattern: "^ModJoin$"
+ default: "ModJoin"
data:
properties:
joined:
- $ref: '#/components/schemas/joined'
+ $ref: "#/components/schemas/joined"
createPostRequest:
name: Request to create a new post
payload:
@@ -3476,8 +3476,8 @@ components:
properties:
op:
type: string
- pattern: '^CreatePost$'
- default: 'CreatePost'
+ pattern: "^CreatePost$"
+ default: "CreatePost"
data:
type: object
required:
@@ -3487,17 +3487,17 @@ components:
- auth
properties:
name:
- $ref: '#/components/schemas/post_name'
+ $ref: "#/components/schemas/post_name"
url:
- $ref: '#/components/schemas/url'
+ $ref: "#/components/schemas/url"
body:
- $ref: '#/components/schemas/body'
+ $ref: "#/components/schemas/body"
nsfw:
- $ref: '#/components/schemas/nsfw'
+ $ref: "#/components/schemas/nsfw"
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
createPostResponse:
name: Response to request to create a new post
payload:
@@ -3505,13 +3505,13 @@ components:
properties:
op:
type: string
- pattern: '^CreatePost$'
- default: 'CreatePost'
+ pattern: "^CreatePost$"
+ default: "CreatePost"
data:
type: object
properties:
post_view:
- $ref: '#/components/schemas/post_view'
+ $ref: "#/components/schemas/post_view"
getPostRequest:
name: Request details of a post
payload:
@@ -3522,8 +3522,8 @@ components:
properties:
op:
type: string
- pattern: '^GetPost$'
- default: 'GetPost'
+ pattern: "^GetPost$"
+ default: "GetPost"
data:
type: object
required:
@@ -3531,9 +3531,9 @@ components:
- auth
properties:
id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
getPostResponse:
name: Details of a post
payload:
@@ -3541,19 +3541,19 @@ components:
properties:
op:
type: string
- pattern: '^GetPost$'
- default: 'GetPost'
+ pattern: "^GetPost$"
+ default: "GetPost"
data:
type: object
properties:
post_view:
- $ref: '#/components/schemas/post_view'
+ $ref: "#/components/schemas/post_view"
comments:
- $ref: '#/components/schemas/comments'
+ $ref: "#/components/schemas/comments"
community_view:
- $ref: '#/components/schemas/community_view'
+ $ref: "#/components/schemas/community_view"
moderators:
- $ref: '#/components/schemas/moderators'
+ $ref: "#/components/schemas/moderators"
getPostListRequest:
name: Request details of all posts
payload:
@@ -3564,10 +3564,10 @@ components:
properties:
op:
type: string
- pattern: '^GetPosts$'
- default: 'GetPosts'
+ pattern: "^GetPosts$"
+ default: "GetPosts"
data:
- $ref: '#/components/schemas/list_request'
+ $ref: "#/components/schemas/list_request"
getPostListResponse:
name: Details of all posts
payload:
@@ -3575,8 +3575,8 @@ components:
properties:
op:
type: string
- pattern: '^GetPosts$'
- default: 'GetPosts'
+ pattern: "^GetPosts$"
+ default: "GetPosts"
data:
type: object
properties:
@@ -3585,7 +3585,7 @@ components:
items:
properties:
post_view:
- $ref: '#/components/schemas/post_view'
+ $ref: "#/components/schemas/post_view"
createPostLikeRequest:
name: Forthcoming...
payload:
@@ -3596,8 +3596,8 @@ components:
properties:
op:
type: string
- pattern: '^CreatePostLike$'
- default: 'CreatePostLike'
+ pattern: "^CreatePostLike$"
+ default: "CreatePostLike"
data:
type: object
required:
@@ -3606,11 +3606,11 @@ components:
- auth
properties:
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
score:
- $ref: '#/components/schemas/score_plus_minus'
+ $ref: "#/components/schemas/score_plus_minus"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
createPostLikeResponse:
name: Response to request to create a new post
payload:
@@ -3618,13 +3618,13 @@ components:
properties:
op:
type: string
- pattern: '^CreatePostLike$'
- default: 'CreatePostLike'
+ pattern: "^CreatePostLike$"
+ default: "CreatePostLike"
data:
type: object
properties:
post_view:
- $ref: '#/components/schemas/post_view'
+ $ref: "#/components/schemas/post_view"
editPostRequest:
name: Request to edit an existing post
payload:
@@ -3635,8 +3635,8 @@ components:
properties:
op:
type: string
- pattern: '^EditPost$'
- default: 'EditPost'
+ pattern: "^EditPost$"
+ default: "EditPost"
data:
type: object
required:
@@ -3646,15 +3646,15 @@ components:
- auth
properties:
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
name:
- $ref: '#/components/schemas/post_name'
+ $ref: "#/components/schemas/post_name"
url:
- $ref: '#/components/schemas/url'
+ $ref: "#/components/schemas/url"
nsfw:
- $ref: '#/components/schemas/nsfw'
+ $ref: "#/components/schemas/nsfw"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
editPostResponse:
name: Response to request to edit a post
payload:
@@ -3662,13 +3662,13 @@ components:
properties:
op:
type: string
- pattern: '^EditPost$'
- default: 'EditPost'
+ pattern: "^EditPost$"
+ default: "EditPost"
data:
type: object
properties:
post_view:
- $ref: '#/components/schemas/post_view'
+ $ref: "#/components/schemas/post_view"
deletePostRequest:
name: Request that a post be deleted
payload:
@@ -3679,8 +3679,8 @@ components:
properties:
op:
type: string
- pattern: '^DeletePost$'
- default: 'DeletePost'
+ pattern: "^DeletePost$"
+ default: "DeletePost"
data:
type: object
required:
@@ -3689,11 +3689,11 @@ components:
- auth
properties:
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
deleted:
- $ref: '#/components/schemas/deleted'
+ $ref: "#/components/schemas/deleted"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
deletePostResponse:
name: Response to post deletion request
payload:
@@ -3701,13 +3701,13 @@ components:
properties:
op:
type: string
- pattern: '^DeletePost$'
- default: 'DeletePost'
+ pattern: "^DeletePost$"
+ default: "DeletePost"
data:
type: object
properties:
post_view:
- $ref: '#/components/schemas/post_view'
+ $ref: "#/components/schemas/post_view"
removePostRequest:
name: Request that a post be removed
payload:
@@ -3718,8 +3718,8 @@ components:
properties:
op:
type: string
- pattern: '^RemovePost$'
- default: 'RemovePost'
+ pattern: "^RemovePost$"
+ default: "RemovePost"
data:
type: object
required:
@@ -3728,13 +3728,13 @@ components:
- auth
properties:
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
removed:
- $ref: '#/components/schemas/removed'
+ $ref: "#/components/schemas/removed"
reason:
- $ref: '#/components/schemas/reason'
+ $ref: "#/components/schemas/reason"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
removePostResponse:
name: Response to post removal request
payload:
@@ -3742,13 +3742,13 @@ components:
properties:
op:
type: string
- pattern: '^RemovePost$'
- default: 'RemovePost'
+ pattern: "^RemovePost$"
+ default: "RemovePost"
data:
type: object
properties:
post_view:
- $ref: '#/components/schemas/post_view'
+ $ref: "#/components/schemas/post_view"
postLockRequest:
name: Request that a post be locked
payload:
@@ -3759,8 +3759,8 @@ components:
properties:
op:
type: string
- pattern: '^LockPost$'
- default: 'LockPost'
+ pattern: "^LockPost$"
+ default: "LockPost"
data:
type: object
required:
@@ -3769,11 +3769,11 @@ components:
- auth
properties:
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
locked:
- $ref: '#/components/schemas/locked'
+ $ref: "#/components/schemas/locked"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
postLockResponse:
name: Response to a 'post lock' request
payload:
@@ -3781,13 +3781,13 @@ components:
properties:
op:
type: string
- pattern: '^LockPost$'
- default: 'LockPost'
+ pattern: "^LockPost$"
+ default: "LockPost"
data:
type: object
properties:
post_view:
- $ref: '#/components/schemas/post_view'
+ $ref: "#/components/schemas/post_view"
stickyPostRequest:
name: Request that a post be made 'sticky'
payload:
@@ -3798,8 +3798,8 @@ components:
properties:
op:
type: string
- pattern: '^StickyPost$'
- default: 'StickyPost'
+ pattern: "^StickyPost$"
+ default: "StickyPost"
data:
type: object
required:
@@ -3808,11 +3808,11 @@ components:
- auth
properties:
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
stickied:
- $ref: '#/components/schemas/locked'
+ $ref: "#/components/schemas/locked"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
stickyPostResponse:
name: Response to a request to make a post 'sticky'
payload:
@@ -3820,13 +3820,13 @@ components:
properties:
op:
type: string
- pattern: '^StickyPost$'
- default: 'StickyPost'
+ pattern: "^StickyPost$"
+ default: "StickyPost"
data:
type: object
properties:
post_view:
- $ref: '#/components/schemas/post_view'
+ $ref: "#/components/schemas/post_view"
savePostRequest:
name: Request to add a post to the user's list of saved posts
payload:
@@ -3837,8 +3837,8 @@ components:
properties:
op:
type: string
- pattern: '^SavePost$'
- default: 'SavePost'
+ pattern: "^SavePost$"
+ default: "SavePost"
data:
type: object
required:
@@ -3847,11 +3847,11 @@ components:
- auth
properties:
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
save:
- $ref: '#/components/schemas/saved'
+ $ref: "#/components/schemas/saved"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
savePostResponse:
name: Response to a request to add a post to the list of saved posts
payload:
@@ -3859,13 +3859,13 @@ components:
properties:
op:
type: string
- pattern: '^SavePost$'
- default: 'SavePost'
+ pattern: "^SavePost$"
+ default: "SavePost"
data:
type: object
properties:
post_view:
- $ref: '#/components/schemas/post_view'
+ $ref: "#/components/schemas/post_view"
postJoinRequest:
name: Request to receive WebSocket messages for this post's comments
payload:
@@ -3876,15 +3876,15 @@ components:
properties:
op:
type: string
- pattern: '^PostJoin$'
- default: 'PostJoin'
+ pattern: "^PostJoin$"
+ default: "PostJoin"
data:
type: object
required:
- post_id
properties:
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
postJoinResponse:
name: Verification that you will receive these WebSocket messages
payload:
@@ -3892,13 +3892,13 @@ components:
properties:
op:
type: string
- pattern: '^PostJoin$'
- default: 'PostJoin'
+ pattern: "^PostJoin$"
+ default: "PostJoin"
data:
type: object
properties:
joined:
- $ref: '#/components/schemas/joined'
+ $ref: "#/components/schemas/joined"
createPostReportRequest:
name: Request to raise a report against a post
payload:
@@ -3906,8 +3906,8 @@ components:
properties:
op:
type: string
- pattern: '^CreatePostReport$'
- default: 'CreatePostReport'
+ pattern: "^CreatePostReport$"
+ default: "CreatePostReport"
data:
type: object
required:
@@ -3916,11 +3916,11 @@ components:
- auth
properties:
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
reason:
- $ref: '#/components/schemas/reason'
+ $ref: "#/components/schemas/reason"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
createPostReportResponse:
name: Response to raising a report against a post.
payload:
@@ -3928,13 +3928,13 @@ components:
properties:
op:
type: string
- pattern: '^CreatePostReport$'
- default: 'CreatePostReport'
+ pattern: "^CreatePostReport$"
+ default: "CreatePostReport"
data:
type: object
properties:
success:
- $ref: '#/components/schemas/success'
+ $ref: "#/components/schemas/success"
resolvePostReportRequest:
name: Request to resolve a report against a post
payload:
@@ -3945,10 +3945,10 @@ components:
properties:
op:
type: string
- pattern: '^ResolvePostReport$'
- default: 'ResolvePostReport'
+ pattern: "^ResolvePostReport$"
+ default: "ResolvePostReport"
data:
- $ref: '#/components/schemas/resolve_request'
+ $ref: "#/components/schemas/resolve_request"
resolvePostReportResponse:
name: Response to request to resolve a report against a post
payload:
@@ -3956,10 +3956,10 @@ components:
properties:
op:
type: string
- pattern: '^ResolvePostReport$'
- default: 'ResolvePostReport'
+ pattern: "^ResolvePostReport$"
+ default: "ResolvePostReport"
data:
- $ref: '#/components/schemas/resolve_response'
+ $ref: "#/components/schemas/resolve_response"
listPostReportsRequest:
name: Request to list all reports against posts
payload:
@@ -3970,10 +3970,10 @@ components:
properties:
op:
type: string
- pattern: '^ListPostReports$'
- default: 'ListPostReports'
+ pattern: "^ListPostReports$"
+ default: "ListPostReports"
data:
- $ref: '#/components/schemas/report_request'
+ $ref: "#/components/schemas/report_request"
listPostReportsResponse:
name: Response to a request to list all reports against posts
payload:
@@ -3981,8 +3981,8 @@ components:
properties:
op:
type: string
- pattern: '^ListPostReports$'
- default: 'ListPostReports'
+ pattern: "^ListPostReports$"
+ default: "ListPostReports"
data:
type: object
properties:
@@ -3991,36 +3991,36 @@ components:
items:
properties:
resolver:
- $ref: '#/components/schemas/resolver_id'
+ $ref: "#/components/schemas/resolver_id"
community:
- $ref: '#/components/schemas/community'
+ $ref: "#/components/schemas/community"
creator:
- $ref: '#/components/schemas/creator'
+ $ref: "#/components/schemas/creator"
post_creator:
- $ref: '#/components/schemas/creator'
+ $ref: "#/components/schemas/creator"
post:
- $ref: '#/components/schemas/post'
+ $ref: "#/components/schemas/post"
post_report:
type: object
properties:
resolver_id:
- $ref: '#/components/schemas/resolver_id'
+ $ref: "#/components/schemas/resolver_id"
original_post_body:
- $ref: '#/components/schemas/body'
+ $ref: "#/components/schemas/body"
resolved:
- $ref: '#/components/schemas/resolved'
+ $ref: "#/components/schemas/resolved"
published:
- $ref: '#/components/schemas/published'
+ $ref: "#/components/schemas/published"
creator_id:
- $ref: '#/components/schemas/creator_id'
+ $ref: "#/components/schemas/creator_id"
reason:
- $ref: '#/components/schemas/reason'
+ $ref: "#/components/schemas/reason"
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
id:
- $ref: '#/components/schemas/report_id'
+ $ref: "#/components/schemas/report_id"
original_post_name:
- $ref: '#/components/schemas/post_name'
+ $ref: "#/components/schemas/post_name"
updated:
description: Forthcoming...
type: string
@@ -4039,10 +4039,10 @@ components:
properties:
op:
type: string
- pattern: '^CreateComment$'
- default: 'CreateComment'
+ pattern: "^CreateComment$"
+ default: "CreateComment"
data:
- $ref: '#/components/schemas/comment_request'
+ $ref: "#/components/schemas/comment_request"
createCommentResponse:
name: Response to a request to create a comment
payload:
@@ -4050,13 +4050,13 @@ components:
properties:
op:
type: string
- pattern: '^CreateComment$'
- default: 'CreateComment'
+ pattern: "^CreateComment$"
+ default: "CreateComment"
data:
type: object
properties:
comment_view:
- $ref: '#/components/schemas/comment_view'
+ $ref: "#/components/schemas/comment_view"
editCommentRequest:
name: Request to edit a comment
payload:
@@ -4067,10 +4067,10 @@ components:
properties:
op:
type: string
- pattern: '^EditComment$'
- default: 'EditComment'
+ pattern: "^EditComment$"
+ default: "EditComment"
data:
- $ref: '#/components/schemas/comment_request'
+ $ref: "#/components/schemas/comment_request"
editCommentResponse:
name: Response to a request to edit a comment
payload:
@@ -4078,13 +4078,13 @@ components:
properties:
op:
type: string
- pattern: '^EditComment$'
- default: 'EditComment'
+ pattern: "^EditComment$"
+ default: "EditComment"
data:
type: object
properties:
comment_view:
- $ref: '#/components/schemas/comment_view'
+ $ref: "#/components/schemas/comment_view"
deleteCommentRequest:
name: Request to delete a comment
payload:
@@ -4092,8 +4092,8 @@ components:
properties:
op:
type: string
- pattern: '^DeleteComment$'
- default: 'DeleteComment'
+ pattern: "^DeleteComment$"
+ default: "DeleteComment"
data:
type: object
required:
@@ -4102,11 +4102,11 @@ components:
- auth
properties:
comment_id:
- $ref: '#/components/schemas/comment_id'
+ $ref: "#/components/schemas/comment_id"
deleted:
- $ref: '#/components/schemas/deleted'
+ $ref: "#/components/schemas/deleted"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
deleteCommentResponse:
name: Response to a request to delete a comment
payload:
@@ -4114,13 +4114,13 @@ components:
properties:
op:
type: string
- pattern: '^DeleteComment$'
- default: 'DeleteComment'
+ pattern: "^DeleteComment$"
+ default: "DeleteComment"
data:
type: object
properties:
comment_view:
- $ref: '#/components/schemas/comment_view'
+ $ref: "#/components/schemas/comment_view"
removeCommentRequest:
name: Request to permanently delete a comment
payload:
@@ -4131,8 +4131,8 @@ components:
properties:
op:
type: string
- pattern: '^RemoveComment$'
- default: 'RemoveComment'
+ pattern: "^RemoveComment$"
+ default: "RemoveComment"
data:
type: object
required:
@@ -4141,13 +4141,13 @@ components:
- auth
properties:
comment_id:
- $ref: '#/components/schemas/comment_id'
+ $ref: "#/components/schemas/comment_id"
removed:
- $ref: '#/components/schemas/removed'
+ $ref: "#/components/schemas/removed"
reason:
- $ref: '#/components/schemas/reason'
+ $ref: "#/components/schemas/reason"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
removeCommentResponse:
name: Response to a request to permanently delete a comment
payload:
@@ -4155,13 +4155,13 @@ components:
properties:
op:
type: string
- pattern: '^RemoveComment$'
- default: 'RemoveComment'
+ pattern: "^RemoveComment$"
+ default: "RemoveComment"
data:
type: object
properties:
comment_view:
- $ref: '#/components/schemas/comment_view'
+ $ref: "#/components/schemas/comment_view"
getCommentsRequest:
name: Request to retrieve all comments
payload:
@@ -4172,10 +4172,10 @@ components:
properties:
op:
type: string
- pattern: '^GetComments$'
- default: 'GetComments'
+ pattern: "^GetComments$"
+ default: "GetComments"
data:
- $ref: '#/components/schemas/list_request'
+ $ref: "#/components/schemas/list_request"
getCommentsResponse:
name: Response to a request to retrieve all comments
payload:
@@ -4183,18 +4183,18 @@ components:
properties:
op:
type: string
- pattern: '^GetComments$'
- default: 'GetComments'
+ pattern: "^GetComments$"
+ default: "GetComments"
data:
type: object
properties:
comments:
- description: 'The list of comments'
+ description: "The list of comments"
type: array
items:
properties:
comment_view:
- $ref: '#/components/schemas/comment_view'
+ $ref: "#/components/schemas/comment_view"
markCommentRequest:
name: Request to mark a commment as read
payload:
@@ -4205,8 +4205,8 @@ components:
properties:
op:
type: string
- pattern: '^MarkCommentAsRead$'
- default: 'MarkCommentAsRead'
+ pattern: "^MarkCommentAsRead$"
+ default: "MarkCommentAsRead"
data:
type: object
required:
@@ -4215,11 +4215,11 @@ components:
- auth
properties:
comment_id:
- $ref: '#/components/schemas/comment_id'
+ $ref: "#/components/schemas/comment_id"
read:
- $ref: '#/components/schemas/read'
+ $ref: "#/components/schemas/read"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
markCommentResponse:
name: Response to a request to mark a comment as read
payload:
@@ -4227,13 +4227,13 @@ components:
properties:
op:
type: string
- pattern: '^MarkCommentAsRead$'
- default: 'MarkCommentAsRead'
+ pattern: "^MarkCommentAsRead$"
+ default: "MarkCommentAsRead"
data:
type: object
properties:
comment_view:
- $ref: '#/components/schemas/comment_view'
+ $ref: "#/components/schemas/comment_view"
saveCommentRequest:
name: Request to save a commment
payload:
@@ -4244,8 +4244,8 @@ components:
properties:
op:
type: string
- pattern: '^SaveComment$'
- default: 'SaveComment'
+ pattern: "^SaveComment$"
+ default: "SaveComment"
data:
type: object
required:
@@ -4254,11 +4254,11 @@ components:
- auth
properties:
comment_id:
- $ref: '#/components/schemas/comment_id'
+ $ref: "#/components/schemas/comment_id"
save:
- $ref: '#/components/schemas/saved'
+ $ref: "#/components/schemas/saved"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
saveCommentResponse:
name: Response to a request to save a comment
payload:
@@ -4266,13 +4266,13 @@ components:
properties:
op:
type: string
- pattern: '^SaveComment$'
- default: 'SaveComment'
+ pattern: "^SaveComment$"
+ default: "SaveComment"
data:
type: object
properties:
comment_view:
- $ref: '#/components/schemas/comment_view'
+ $ref: "#/components/schemas/comment_view"
createCommentLikeRequest:
name: Forthcoming...
payload:
@@ -4283,8 +4283,8 @@ components:
properties:
op:
type: string
- pattern: '^CreateCommentLike$'
- default: 'CreateCommentLike'
+ pattern: "^CreateCommentLike$"
+ default: "CreateCommentLike"
data:
type: object
required:
@@ -4293,11 +4293,11 @@ components:
- auth
properties:
comment_id:
- $ref: '#/components/schemas/comment_id'
+ $ref: "#/components/schemas/comment_id"
score:
- $ref: '#/components/schemas/score_plus_minus'
+ $ref: "#/components/schemas/score_plus_minus"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
createCommentLikeResponse:
name: Response to a request to save a comment
payload:
@@ -4305,13 +4305,13 @@ components:
properties:
op:
type: string
- pattern: '^CreateCommentLike$'
- default: 'CreateCommentLike'
+ pattern: "^CreateCommentLike$"
+ default: "CreateCommentLike"
data:
type: object
properties:
comment_view:
- $ref: '#/components/schemas/comment_view'
+ $ref: "#/components/schemas/comment_view"
createCommentReportRequest:
name: Request to report a comment
payload:
@@ -4322,8 +4322,8 @@ components:
properties:
op:
type: string
- pattern: '^CreateCommentReport$'
- default: 'CreateCommentReport'
+ pattern: "^CreateCommentReport$"
+ default: "CreateCommentReport"
data:
type: object
required:
@@ -4332,11 +4332,11 @@ components:
- auth
properties:
comment_id:
- $ref: '#/components/schemas/comment_id'
+ $ref: "#/components/schemas/comment_id"
reason:
- $ref: '#/components/schemas/reason'
+ $ref: "#/components/schemas/reason"
auth:
- $ref: '#/components/schemas/authStringSchema'
+ $ref: "#/components/schemas/authStringSchema"
createCommentReportResponse:
name: Response to raising a report against a comment
payload:
@@ -4344,13 +4344,13 @@ components:
properties:
op:
type: string
- pattern: '^CreateCommentReport$'
- default: 'CreateCommentReport'
+ pattern: "^CreateCommentReport$"
+ default: "CreateCommentReport"
data:
type: object
properties:
success:
- $ref: '#/components/schemas/success'
+ $ref: "#/components/schemas/success"
resolveCommentReportRequest:
name: Request to clear a report against a comment
payload:
@@ -4361,10 +4361,10 @@ components:
properties:
op:
type: string
- pattern: '^ResolveCommentReport$'
- default: 'ResolveCommentReport'
+ pattern: "^ResolveCommentReport$"
+ default: "ResolveCommentReport"
data:
- $ref: '#/components/schemas/resolve_request'
+ $ref: "#/components/schemas/resolve_request"
resolveCommentReportResponse:
name: Response to a request to clear a report against a comment
payload:
@@ -4372,10 +4372,10 @@ components:
properties:
op:
type: string
- pattern: '^ResolveCommentReport$'
- default: 'ResolveCommentReport'
+ pattern: "^ResolveCommentReport$"
+ default: "ResolveCommentReport"
data:
- $ref: '#/components/schemas/resolve_response'
+ $ref: "#/components/schemas/resolve_response"
listCommentReportsRequest:
name: Request to list all reports against comments
payload:
@@ -4386,10 +4386,10 @@ components:
properties:
op:
type: string
- pattern: '^ListCommemtReports$'
- default: 'ListCommentReports'
+ pattern: "^ListCommemtReports$"
+ default: "ListCommentReports"
data:
- $ref: '#/components/schemas/report_request'
+ $ref: "#/components/schemas/report_request"
listCommentReportsResponse:
name: Response to a request to list all comment reports
payload:
@@ -4397,8 +4397,8 @@ components:
properties:
op:
type: string
- pattern: '^ListCommemtReports$'
- default: 'ListCommentReports'
+ pattern: "^ListCommemtReports$"
+ default: "ListCommentReports"
data:
type: object
properties:
@@ -4410,115 +4410,115 @@ components:
type: object
properties:
resolver_id:
- $ref: '#/components/schemas/resolver_id'
+ $ref: "#/components/schemas/resolver_id"
published:
- $ref: '#/components/schemas/published'
+ $ref: "#/components/schemas/published"
comment_id:
- $ref: '#/components/schemas/comment_id'
+ $ref: "#/components/schemas/comment_id"
creator_id:
- $ref: '#/components/schemas/creator_id'
+ $ref: "#/components/schemas/creator_id"
reason:
- $ref: '#/components/schemas/reason'
+ $ref: "#/components/schemas/reason"
original_comment_text:
- $ref: '#/components/schemas/body'
+ $ref: "#/components/schemas/body"
id:
description: Forthcoming...
type: number
example: 2
resolved:
- $ref: '#/components/schemas/resolved'
+ $ref: "#/components/schemas/resolved"
updated:
description: Forthcoming...
type: string
nullable: true
resolver:
- $ref: '#/components/schemas/resolver_id'
+ $ref: "#/components/schemas/resolver_id"
community:
- $ref: '#/components/schemas/community'
+ $ref: "#/components/schemas/community"
creator:
- $ref: '#/components/schemas/creator'
+ $ref: "#/components/schemas/creator"
post:
- $ref: '#/components/schemas/post'
+ $ref: "#/components/schemas/post"
comment_creator:
- $ref: '#/components/schemas/creator'
+ $ref: "#/components/schemas/creator"
comment:
- $ref: '#/components/schemas/comment'
+ $ref: "#/components/schemas/comment"
schemas:
- 'actor_id':
+ "actor_id":
type: string
description: |-
URL for the user/community profile/home page, using the format:
- **User profile** - Site URL/u/username
- **Community home page** - Site URL/c/commmunity name
example: 'https:\/\/enterprise.lemmy.ml\/u\/griddle'
- 'added':
+ "added":
description: Forthcoming...
type: boolean
example: true
- 'admin':
+ "admin":
type: boolean
- description: 'Set to *true* if this person is the Lemmy server administrator'
+ description: "Set to *true* if this person is the Lemmy server administrator"
example: false
- 'ap_id':
+ "ap_id":
type: string
description: The URL of this post, comment or message
example: 'https:\/\/enterprise.lemmy.ml\/post\/223'
- 'authSchema':
+ "authSchema":
type: object
- description: 'The authentication string returned by **Login** and **Register**'
+ description: "The authentication string returned by **Login** and **Register**"
properties:
jwt:
- $ref: '#/components/schemas/authStringSchema'
- 'authStringSchema':
+ $ref: "#/components/schemas/authStringSchema"
+ "authStringSchema":
type: string
description: Authentication string for a user
- example: 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6NzcsImlzcyI6ImVudGVycHJpc2UubGVtbXkubWwifQ.8UbfUE1v4mfH88s2diX2h6_5bzLHSa_5wIlpOZmHbMQ'
- 'avatar':
+ example: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6NzcsImlzcyI6ImVudGVycHJpc2UubGVtbXkubWwifQ.8UbfUE1v4mfH88s2diX2h6_5bzLHSa_5wIlpOZmHbMQ"
+ "avatar":
type: string
nullable: true
description: Forthcoming...
- 'ban':
+ "ban":
description: |-
- If set to *true*, ban the user
- If set to *false*, do not ban them (use in combination with `remove_data` to restore comments and posts that were previously removed as part of a banning process)
type: boolean
example: true
- 'ban_view':
+ "ban_view":
type: object
properties:
user:
- $ref: '#/components/schemas/user_view'
+ $ref: "#/components/schemas/user_view"
banned:
- $ref: '#/components/schemas/banned'
- 'banned':
+ $ref: "#/components/schemas/banned"
+ "banned":
type: boolean
- description: 'Set to *true* if this account (username) has been banned from posting on the Lemmy server'
+ description: "Set to *true* if this account (username) has been banned from posting on the Lemmy server"
example: false
- 'banned_list':
+ "banned_list":
description: Forthcoming...
type: array
- 'banner':
+ "banner":
type: string
nullable: true
description: Forthcoming...
- 'bio':
+ "bio":
type: string
nullable: true
- description: 'A self-written description of the user'
- example: 'I am a watercolour artist. I am happy to share the paintings I am working on, give and receive critiques, and post resources such as tutorials.'
- 'body':
- description: 'The body text of the post or comment'
+ description: "A self-written description of the user"
+ example: "I am a watercolour artist. I am happy to share the paintings I am working on, give and receive critiques, and post resources such as tutorials."
+ "body":
+ description: "The body text of the post or comment"
type: string
nullable: true
- 'comment':
+ "comment":
type: object
properties:
creator_id:
- $ref: '#/components/schemas/creator_id'
+ $ref: "#/components/schemas/creator_id"
content:
- $ref: '#/components/schemas/content'
+ $ref: "#/components/schemas/content"
id:
- $ref: '#/components/schemas/comment_id'
+ $ref: "#/components/schemas/comment_id"
read:
description: Is *true* if the author of the original post has read the comment
type: boolean
@@ -4528,30 +4528,30 @@ components:
type: number
nullable: true
removed:
- $ref: '#/components/schemas/removed'
+ $ref: "#/components/schemas/removed"
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
local:
- $ref: '#/components/schemas/local'
+ $ref: "#/components/schemas/local"
updated:
description: Forthcoming...
type: string
nullable: true
ap_id:
- $ref: '#/components/schemas/ap_id'
+ $ref: "#/components/schemas/ap_id"
deleted:
- $ref: '#/components/schemas/deleted'
+ $ref: "#/components/schemas/deleted"
published:
- $ref: '#/components/schemas/published'
- 'comment_count':
+ $ref: "#/components/schemas/published"
+ "comment_count":
description: Total number of comments on the site or community
type: number
example: 231
- 'comment_id':
+ "comment_id":
description: The number (id) of a comment
type: number
example: 374
- 'comment_request':
+ "comment_request":
type: object
required:
- content
@@ -4559,163 +4559,163 @@ components:
- auth
properties:
content:
- $ref: '#/components/schemas/content'
+ $ref: "#/components/schemas/content"
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
form_id:
- $ref: '#/components/schemas/form_id'
+ $ref: "#/components/schemas/form_id"
auth:
- $ref: '#/components/schemas/authStringSchema'
- 'comment_view':
+ $ref: "#/components/schemas/authStringSchema"
+ "comment_view":
type: object
properties:
community:
- $ref: '#/components/schemas/community'
+ $ref: "#/components/schemas/community"
recipient:
- $ref: '#/components/schemas/recipient'
+ $ref: "#/components/schemas/recipient"
counts:
- $ref: '#/components/schemas/counts'
+ $ref: "#/components/schemas/counts"
post:
- ref: '#/components/schemas/post'
+ ref: "#/components/schemas/post"
creator_banned_from_community:
- $ref: '#/components/schemas/creator_banned_from_community'
+ $ref: "#/components/schemas/creator_banned_from_community"
saved:
- $ref: '#/components/schemas/saved'
+ $ref: "#/components/schemas/saved"
subscribed:
- $ref: '#/components/schemas/subscribed'
+ $ref: "#/components/schemas/subscribed"
my_vote:
- $ref: '#/components/schemas/my_vote'
+ $ref: "#/components/schemas/my_vote"
comment:
- $ref: '#/components/schemas/comment'
+ $ref: "#/components/schemas/comment"
creator:
- $ref: '#/components/schemas/creator'
+ $ref: "#/components/schemas/creator"
recipient_ids:
type: array
items:
recipient:
- $ref: '#/components/schemas/recipient'
+ $ref: "#/components/schemas/recipient"
form_id:
- $ref: '#/components/schemas/authStringSchema'
- 'comments':
+ $ref: "#/components/schemas/authStringSchema"
+ "comments":
type: array
items:
properties:
comment:
- $ref: '#/components/schemas/comment'
+ $ref: "#/components/schemas/comment"
recipient:
- $ref: '#/components/schemas/recipient'
+ $ref: "#/components/schemas/recipient"
post:
- $ref: '#/components/schemas/post'
+ $ref: "#/components/schemas/post"
creator:
- $ref: '#/components/schemas/user'
+ $ref: "#/components/schemas/user"
creator_banned_from_community:
- $ref: '#/components/schemas/creator_banned_from_community'
+ $ref: "#/components/schemas/creator_banned_from_community"
subscribed:
- $ref: '#/components/schemas/subscribed'
+ $ref: "#/components/schemas/subscribed"
my_vote:
- $ref: '#/components/schemas/my_vote'
+ $ref: "#/components/schemas/my_vote"
counts:
- $ref: '#/components/schemas/counts'
+ $ref: "#/components/schemas/counts"
saved:
- $ref: '#/components/schemas/saved'
+ $ref: "#/components/schemas/saved"
community:
- $ref: '#/components/schemas/community'
- 'community':
+ $ref: "#/components/schemas/community"
+ "community":
type: object
properties:
updated:
type: string
description: Forthcoming...
- example: '2020-11-14T13:35:10.270578'
+ example: "2020-11-14T13:35:10.270578"
name:
- $ref: '#/components/schemas/community_name'
+ $ref: "#/components/schemas/community_name"
icon:
- $ref: '#/components/schemas/icon'
+ $ref: "#/components/schemas/icon"
nsfw:
- $ref: '#/components/schemas/nsfw'
+ $ref: "#/components/schemas/nsfw"
deleted:
- $ref: '#/components/schemas/deleted'
+ $ref: "#/components/schemas/deleted"
removed:
- $ref: '#/components/schemas/removed'
+ $ref: "#/components/schemas/removed"
published:
- $ref: '#/components/schemas/published'
+ $ref: "#/components/schemas/published"
creator_id:
- $ref: '#/components/schemas/creator_id'
+ $ref: "#/components/schemas/creator_id"
id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
description:
- $ref: '#/components/schemas/description'
+ $ref: "#/components/schemas/description"
actor_id:
- $ref: '#/components/schemas/actor_id'
+ $ref: "#/components/schemas/actor_id"
local:
- $ref: '#/components/schemas/local'
+ $ref: "#/components/schemas/local"
title:
- $ref: '#/components/schemas/title'
+ $ref: "#/components/schemas/title"
banner:
- $ref: '#/components/schemas/banner'
- 'community_id':
+ $ref: "#/components/schemas/banner"
+ "community_id":
type: integer
format: int32 # Or int64? It's stated as both in different parts of the API docs
- description: 'The id number for a community. The main/frontpage `community_id` is 0'
+ description: "The id number for a community. The main/frontpage `community_id` is 0"
example: 2
- 'community_name':
+ "community_name":
description: The name of a community
type: string
- Example: 'main'
- 'community_view':
+ Example: "main"
+ "community_view":
type: object
properties:
subscribed:
- $ref: '#/components/schemas/subscribed'
+ $ref: "#/components/schemas/subscribed"
counts:
type: object
properties:
published:
- $ref: '#/components/schemas/published'
+ $ref: "#/components/schemas/published"
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
users_active_day:
- $ref: '#/components/schemas/users_active_day'
+ $ref: "#/components/schemas/users_active_day"
id:
- description: 'Forthcoming...'
+ description: "Forthcoming..."
type: number
example: 1
users_active_half_year:
- $ref: '#/components/schemas/users_active_half_year'
+ $ref: "#/components/schemas/users_active_half_year"
comments:
- $ref: '#/components/schemas/comment_count'
+ $ref: "#/components/schemas/comment_count"
users_active_month:
- $ref: '#/components/schemas/users_active_month'
+ $ref: "#/components/schemas/users_active_month"
subscribers:
description: The total number of community subscribers (members)
type: number
example: 41
posts:
- $ref: '#/components/schemas/posts'
+ $ref: "#/components/schemas/posts"
users_active_week:
- $ref: '#/components/schemas/users_active_week'
+ $ref: "#/components/schemas/users_active_week"
community:
- $ref: '#/components/schemas/community'
+ $ref: "#/components/schemas/community"
creator:
- $ref: '#/components/schemas/creator'
- 'config_hjson':
+ $ref: "#/components/schemas/creator"
+ "config_hjson":
description: The configuration data for a Lemmy server (in JSON format)
type: string
example: |-
{\n # for more info about the config, check out the documentation\n # https://lemmy.ml/docs/administration_configuration.html\n\n setup: {\n # username for the admin user\n admin_username: \"lemmy\"\n # password for the admin user\n admin_password: \"lemmy\"\n # name of the site (can be changed later)\n site_name: \"lemmy-test\"\n }\n\n # the domain name of your instance (eg \"lemmy.ml\")\n hostname: \"localhost\"\n # address where lemmy should listen for incoming requests\n bind: \"0.0.0.0\"\n # port where lemmy should listen for incoming requests\n port: 8536\n # json web token for authorization between server and client\n jwt_secret: \"changeme\"\n # settings related to the postgresql database\n database: {\n # name of the postgres database for lemmy\n database: \"lemmy\"\n # username to connect to postgres\n user: \"lemmy\"\n # password to connect to postgres\n password: \"password\"\n # host where postgres is running\n host: \"postgres\"\n }\n# # optional: email sending configuration\n# email: {\n# # hostname and port of the smtp server\n# smtp_server: \"aspmx.l.google.com\"\n# # login name for smtp server\n# smtp_login: \"lemmmy@glemmy.com\"\n# # password to login to the smtp server\n# smtp_password: \"lemom\"\n# # address to send emails from, eg \"noreply@your-instance.com\"\n# smtp_from_address: \"noreply@lemmy.com\"\n# # whether or not smtp connections should use tls\n# use_tls: true\n# }\n}\n\n"
- 'content':
+ "content":
description: The text of the comment or message
type: string
example: '> Communities\n\n\n![](https:\/\/enterprise.lemmy.ml\/pictrs\/image\/KZ7NoyJgxx.jpg)'
- 'counts':
+ "counts":
type: object
properties:
downvotes:
- $ref: '#/components/schemas/downvotes'
+ $ref: "#/components/schemas/downvotes"
published:
- $ref: '#/components/schemas/published'
+ $ref: "#/components/schemas/published"
score:
- $ref: '#/components/schemas/score'
+ $ref: "#/components/schemas/score"
comment_id:
type: number
description: Forthcoming...
@@ -4723,20 +4723,20 @@ components:
type: number
description: Forthcoming...
upvotes:
- $ref: '#/components/schemas/upvotes'
- 'creator':
+ $ref: "#/components/schemas/upvotes"
+ "creator":
type: object
properties:
preferred_username:
- $ref: '#/components/schemas/preferred_username'
+ $ref: "#/components/schemas/preferred_username"
banned:
- $ref: '#/components/schemas/banned'
+ $ref: "#/components/schemas/banned"
matrix_user_id:
- $ref: '#/components/schemas/matrix_user_id'
+ $ref: "#/components/schemas/matrix_user_id"
updated:
- $ref: '#/components/schemas/user_updated'
+ $ref: "#/components/schemas/user_updated"
id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
shared_inbox_url:
description: Forthcoming...
type: string
@@ -4744,37 +4744,37 @@ components:
published:
description: Forthcoming...
type: string
- example: '2020-09-14T14:54:53.080949'
+ example: "2020-09-14T14:54:53.080949"
actor_id:
- $ref: '#/components/schemas/actor_id'
+ $ref: "#/components/schemas/actor_id"
deleted:
- $ref: '#/components/schemas/deleted'
+ $ref: "#/components/schemas/deleted"
banner:
- $ref: '#/components/schemas/banner'
+ $ref: "#/components/schemas/banner"
name:
- $ref: '#/components/schemas/user_name'
+ $ref: "#/components/schemas/user_name"
avatar:
- $ref: '#/components/schemas/avatar'
+ $ref: "#/components/schemas/avatar"
inbox_url:
description: |-
The link to the inbox of the site's creator
type: string
example: 'https:\/\/enterprise.lemmy.ml\/u\/nutomic\/inbox'
local:
- $ref: '#/components/schemas/local'
+ $ref: "#/components/schemas/local"
bio:
- $ref: '#/components/schemas/bio'
+ $ref: "#/components/schemas/bio"
admin:
- $ref: '#/components/schemas/admin'
- 'creator_banned_from_community':
+ $ref: "#/components/schemas/admin"
+ "creator_banned_from_community":
type: boolean
description: Forthcoming...
example: false
- 'creator_id':
+ "creator_id":
type: number
description: The id of the person who created this site, community, post, comment or message
example: 20
- 'default_listing_type':
+ "default_listing_type":
type: integer
format: int16
minimum: 0
@@ -4786,7 +4786,7 @@ components:
1. Subscribed
2. Community (Local)
example: 0
- 'default_sort_type':
+ "default_sort_type":
type: integer
format: int16
minimum: 0
@@ -4803,116 +4803,116 @@ components:
6. TopYear
7. TopAll
example: 1
- 'deleted':
+ "deleted":
type: boolean
description: |-
Set to *true* if this community, post, comment, message or user account should be, or has been, deleted. Unlike *removal*, deletion is not permanent. Deleted items *can* be recovered.
You can undo a delete yourself by setting this value to *false*.
example: false
- 'description':
+ "description":
type: string
description: |-
The information in the community's **Sidebar** area
- example: 'All about the Rolex/Björn Borg collaboration'
- 'downvotes':
+ example: "All about the Rolex/Björn Borg collaboration"
+ "downvotes":
type: number
description: Forthcoming...
example: 0
- 'email':
+ "email":
description: |-
The user's email address
type: string
format: email
- example: 'jane.doe@humanity.org'
- 'enable_downvotes':
+ example: "jane.doe@humanity.org"
+ "enable_downvotes":
description: Set to *true* if downvoting is allowed on this site
type: boolean
example: false
- 'expires':
+ "expires":
description: Forthcoming...
type: integer
format: int64
- 'federated_instances':
+ "federated_instances":
type: object
properties:
blocked:
- $ref: '#/components/schemas/instance'
+ $ref: "#/components/schemas/instance"
allowed:
- $ref: '#/components/schemas/instance'
+ $ref: "#/components/schemas/instance"
linked:
- $ref: '#/components/schemas/instance'
- 'form_id':
+ $ref: "#/components/schemas/instance"
+ "form_id":
description: Forthcoming... (so you know which message came back)
type: string
nullable: true
- example: 'IMPORTANT'
- 'icon':
+ example: "IMPORTANT"
+ "icon":
type: string
nullable: true
description: Forthcoming...
- 'instance':
+ "instance":
type: array
items:
properties:
- # COMMENT 'instance' is a guess at the name for this field. Unable to test federation
+ # COMMENT 'instance' is a guess at the name for this field. Unable to test federation
instance:
description: Forthcoming...
type: string
- example: 'ds9.lemmy.ml'
- 'joined':
- description: '*true* if join request was successful'
+ example: "ds9.lemmy.ml"
+ "joined":
+ description: "*true* if join request was successful"
type: boolean
example: true
- 'lang':
+ "lang":
description: |-
The language to display Lemmy's interface in
type: string
- example: 'Browser Default'
- 'local':
+ example: "Browser Default"
+ "local":
type: boolean
description: |-
- *true* if this is a local user
- *false* if this is a federated user
- 'locked':
+ "locked":
description: |-
Set to *true* if the post is already, or should be, locked. A locked post cannot receive comments.
You can undo a lock yourself by setting this value to *false*.
type: boolean
example: true
- 'limit':
+ "limit":
type: integer
format: int64
minimum: 1
description: Forthcoming...
example: 20
- 'list_request':
+ "list_request":
type: object
required:
- type_
- sort
properties:
type_:
- $ref: '#/components/schemas/type_listing'
+ $ref: "#/components/schemas/type_listing"
sort:
- $ref: '#/components/schemas/sort'
+ $ref: "#/components/schemas/sort"
page:
- $ref: '#/components/schemas/page'
+ $ref: "#/components/schemas/page"
limit:
- $ref: '#/components/schemas/limit'
+ $ref: "#/components/schemas/limit"
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
community_name:
- $ref: '#/components/schemas/community_name'
+ $ref: "#/components/schemas/community_name"
auth:
- $ref: '#/components/schemas/authStringSchema'
- 'matrix_user_id':
+ $ref: "#/components/schemas/authStringSchema"
+ "matrix_user_id":
type: string
nullable: true
- description: 'The [Matrix](https://matrix.org/docs/projects/try-matrix-now/) id of the user'
- 'mentions':
- description: 'Forthcoming...'
+ description: "The [Matrix](https://matrix.org/docs/projects/try-matrix-now/) id of the user"
+ "mentions":
+ description: "Forthcoming..."
type: object
required:
- user_mention_id
@@ -4924,98 +4924,98 @@ components:
type: integer
format: int32
read:
- $ref: '#/components/schemas/read'
+ $ref: "#/components/schemas/read"
auth:
- $ref: '#/components/schemas/authStringSchema'
- 'moderators':
+ $ref: "#/components/schemas/authStringSchema"
+ "moderators":
description: The list of moderators for each community
type: array
items:
properties:
moderator:
- $ref: '#/components/schemas/user'
+ $ref: "#/components/schemas/user"
community:
- $ref: '#/components/schemas/community'
- 'my_user':
+ $ref: "#/components/schemas/community"
+ "my_user":
type: object
required:
- show_nsfw
properties:
show_nsfw:
- $ref: '#/components/schemas/show_nsfw'
+ $ref: "#/components/schemas/show_nsfw"
preferred_username:
- $ref: '#/components/schemas/preferred_username'
+ $ref: "#/components/schemas/preferred_username"
default_sort_type:
- $ref: '#/components/schemas/default_sort_type'
+ $ref: "#/components/schemas/default_sort_type"
banned:
- $ref: '#/components/schemas/banned'
+ $ref: "#/components/schemas/banned"
default_listing_type:
- $ref: '#/components/schemas/default_listing_type'
+ $ref: "#/components/schemas/default_listing_type"
updated:
- $ref: '#/components/schemas/user_updated'
+ $ref: "#/components/schemas/user_updated"
matrix_user_id:
- $ref: '#/components/schemas/matrix_user_id'
+ $ref: "#/components/schemas/matrix_user_id"
id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
show_avatars:
- $ref: '#/components/schemas/show_avatars'
+ $ref: "#/components/schemas/show_avatars"
actor_id:
- $ref: '#/components/schemas/actor_id'
+ $ref: "#/components/schemas/actor_id"
deleted:
- $ref: '#/components/schemas/deleted'
+ $ref: "#/components/schemas/deleted"
published:
- $ref: '#/components/schemas/published'
+ $ref: "#/components/schemas/published"
banner:
- $ref: '#/components/schemas/banner'
+ $ref: "#/components/schemas/banner"
name:
- $ref: '#/components/schemas/user_name'
+ $ref: "#/components/schemas/user_name"
avatar:
- $ref: '#/components/schemas/avatar'
+ $ref: "#/components/schemas/avatar"
email:
- $ref: '#/components/schemas/email'
+ $ref: "#/components/schemas/email"
lang:
- $ref: '#/components/schemas/lang'
+ $ref: "#/components/schemas/lang"
local:
- $ref: '#/components/schemas/local'
+ $ref: "#/components/schemas/local"
bio:
- $ref: '#/components/schemas/bio'
+ $ref: "#/components/schemas/bio"
last_refreshed_at:
description: Forthcoming...
type: string
- example: '2021-01-21T16:19:08.725191'
+ example: "2021-01-21T16:19:08.725191"
send_notifications_to_email:
- $ref: '#/components/schemas/send_notifications_to_email'
+ $ref: "#/components/schemas/send_notifications_to_email"
theme:
- $ref: '#/components/schemas/theme'
+ $ref: "#/components/schemas/theme"
admin:
- $ref: '#/components/schemas/admin'
- 'my_vote':
+ $ref: "#/components/schemas/admin"
+ "my_vote":
type: number
description: Forthcoming...
example: 1
- 'nsfw':
+ "nsfw":
type: boolean
- description: 'Set to *true* if this commmunity, post or comment is deemed [NSFW](https://en.wikipedia.org/wiki/Not_safe_for_work) (hence invisble to users who have the NSFW option selected in their profile'
+ description: "Set to *true* if this commmunity, post or comment is deemed [NSFW](https://en.wikipedia.org/wiki/Not_safe_for_work) (hence invisble to users who have the NSFW option selected in their profile"
example: false
- 'online':
+ "online":
description: Number of registered users who are currently on the system
type: number
example: 1
- 'open_registration':
+ "open_registration":
description: Forthcoming...
type: boolean
example: true
- 'page':
+ "page":
type: integer
format: int64
minimum: 1
description: Forthcoming...
example: 1
- 'password':
+ "password":
type: string
- description: '*Exact* password'
- example: 'lemmy'
- 'post':
+ description: "*Exact* password"
+ example: "lemmy"
+ "post":
type: object
properties:
updated:
@@ -5023,101 +5023,101 @@ components:
description: Forthcoming...
nullable: true
community_id:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
embed_title:
type: string
nullable: true
- description: 'If the **url** for an associated post was provided, this will be the ** data from that URL'
- example: 'Covid: Novichok scientist invents vaccine | The Independent'
+ description: "If the **url** for an associated post was provided, this will be the ** data from that URL"
+ example: "Covid: Novichok scientist invents vaccine | The Independent"
nsfw:
- $ref: '#/components/schemas/nsfw'
+ $ref: "#/components/schemas/nsfw"
deleted:
- $ref: '#/components/schemas/deleted'
+ $ref: "#/components/schemas/deleted"
removed:
- $ref: '#/components/schemas/removed'
+ $ref: "#/components/schemas/removed"
locked:
- $ref: '#/components/schemas/locked'
+ $ref: "#/components/schemas/locked"
url:
- $ref: '#/components/schemas/url'
+ $ref: "#/components/schemas/url"
published:
- $ref: '#/components/schemas/published'
+ $ref: "#/components/schemas/published"
stickied:
type: boolean
- description: 'Set to *true* if this post has been made *sticky* (that is, it is presented at the top of a list of posts)'
+ description: "Set to *true* if this post has been made *sticky* (that is, it is presented at the top of a list of posts)"
example: false
body:
- $ref: '#/components/schemas/body'
+ $ref: "#/components/schemas/body"
embed_html:
type: string
nullable: true
description: Forthcoming...
creator_id:
- $ref: '#/components/schemas/creator_id'
+ $ref: "#/components/schemas/creator_id"
thumbnail_url:
type: string
nullable: true
description: Forthcoming...
id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
ap_id:
- $ref: '#/components/schemas/ap_id'
+ $ref: "#/components/schemas/ap_id"
embed_description:
type: string
nullable: true
description: 'If the **url** for an associated post was provided, this will be the *meta name="description"* data from that URL'
- example: 'Scientist Leonid Rink has a murky past and is well-known for selling nerve agents to criminals'
+ example: "Scientist Leonid Rink has a murky past and is well-known for selling nerve agents to criminals"
local:
- $ref: '#/components/schemas/local'
+ $ref: "#/components/schemas/local"
name:
- $ref: '#/components/schemas/post_name'
- 'post_id':
+ $ref: "#/components/schemas/post_name"
+ "post_id":
type: number
description: The post number
example: 223
- 'post_name':
+ "post_name":
type: string
- description: 'The title of the post'
- example: 'Pot. Kettle. Black.'
- 'post_view':
+ description: "The title of the post"
+ example: "Pot. Kettle. Black."
+ "post_view":
type: object
properties:
community:
- $ref: '#/components/schemas/community'
+ $ref: "#/components/schemas/community"
read:
- $ref: '#/components/schemas/read'
+ $ref: "#/components/schemas/read"
counts:
type: object
properties:
score:
- $ref: '#/components/schemas/score'
+ $ref: "#/components/schemas/score"
comments:
description: The number of comments on this post
type: number
example: 0
published:
- $ref: '#/components/schemas/published'
+ $ref: "#/components/schemas/published"
post_id:
- $ref: '#/components/schemas/post_id'
+ $ref: "#/components/schemas/post_id"
upvotes:
- $ref: '#/components/schemas/upvotes'
+ $ref: "#/components/schemas/upvotes"
id:
description: Forthcoming...
type: number
example: 117
newest_comment_time:
- description: 'The date and time of the most recent comment (in [ISO8601 format](https://www.w3.org/TR/NOTE-datetime))'
+ description: "The date and time of the most recent comment (in [ISO8601 format](https://www.w3.org/TR/NOTE-datetime))"
type: string
- example: '2021-02-16T11:22:27.615111'
+ example: "2021-02-16T11:22:27.615111"
newest_comment_time_necro:
description: Forthcoming...
type: string
- example: '2021-02-23T13:26:54.956691'
+ example: "2021-02-23T13:26:54.956691"
stickied:
- $ref: '#/components/schemas/stickied'
+ $ref: "#/components/schemas/stickied"
downvotes:
- $ref: '#/components/schemas/downvotes'
+ $ref: "#/components/schemas/downvotes"
post:
- $ref: '#/components/schemas/post'
+ $ref: "#/components/schemas/post"
creator_banned_from_community:
type: boolean
saved:
@@ -5127,113 +5127,113 @@ components:
my_vote:
type: number
creator:
- $ref: '#/components/schemas/creator'
- 'posts':
+ $ref: "#/components/schemas/creator"
+ "posts":
description: Total number of posts on the site or community
type: number
example: 115
- 'preferred_username':
+ "preferred_username":
type: string
- description: 'If set, this is the name shown instead of, or as well as, *username* in some contexts (also known as **Display name**)'
- example: 'Queen of the Griddle'
- 'private_message':
+ description: "If set, this is the name shown instead of, or as well as, *username* in some contexts (also known as **Display name**)"
+ example: "Queen of the Griddle"
+ "private_message":
type: object
properties:
read:
- $ref: '#/components/schemas/unread_only'
+ $ref: "#/components/schemas/unread_only"
creator_id:
- $ref: '#/components/schemas/creator_id'
+ $ref: "#/components/schemas/creator_id"
id:
description: Forthcoming...
type: number
example: 16
ap_id:
- $ref: '#/components/schemas/ap_id'
+ $ref: "#/components/schemas/ap_id"
published:
- $ref: '#/components/schemas/published'
+ $ref: "#/components/schemas/published"
recipient_id:
- $ref: '#/components/schemas/recipient'
+ $ref: "#/components/schemas/recipient"
local:
- $ref: '#/components/schemas/local'
+ $ref: "#/components/schemas/local"
content:
- $ref: '#/components/schemas/content'
+ $ref: "#/components/schemas/content"
deleted:
- $ref: '#/components/schemas/deleted'
+ $ref: "#/components/schemas/deleted"
updated:
description: Forthcoming...
type: string
nullable: true
- 'private_message_id':
+ "private_message_id":
description: The id of the private message
type: integer
format: int32
example: 17
- 'private_message_view':
+ "private_message_view":
type: object
properties:
private_message:
- $ref: '#/components/schemas/private_message'
+ $ref: "#/components/schemas/private_message"
creator:
- $ref: '#/components/schemas/user'
+ $ref: "#/components/schemas/user"
recipient:
- $ref: '#/components/schemas/user'
- 'published':
+ $ref: "#/components/schemas/user"
+ "published":
type: string
- description: 'The date this site, community, post, comment or message was created (in [ISO8601 format](https://www.w3.org/TR/NOTE-datetime))'
- example: '2021-01-21T16:42:39.897148'
- 'read':
+ description: "The date this site, community, post, comment or message was created (in [ISO8601 format](https://www.w3.org/TR/NOTE-datetime))"
+ example: "2021-01-21T16:42:39.897148"
+ "read":
type: boolean
description: |-
Set to *true* if this post, comment or message has been read (or should be marked as being read).
If you have marked something as being read, you can undo this yourself by setting this value to *false*.
example: false
- 'reason':
+ "reason":
description: Give a reason for the action. Why was this post deleted? Why was this user banned?
type: string
- example: 'Breach of terms and conditions'
- 'recipient':
+ example: "Breach of terms and conditions"
+ "recipient":
description: Forthcoming...
type: number
example: 77
- 'remove_data':
+ "remove_data":
description: |-
- If set to *true*, also delete that user's comments and posts
- If set *false*, *restore* that user's comments and posts
type: boolean
example: false
- 'removed':
+ "removed":
type: boolean
description: |-
Set to *true* if this community, post, comment or message should be or has been *permanently* deleted.
An admin or moderator can undo a removal by setting this value to *false*.
example: false
- 'replies':
+ "replies":
type: array
items:
properties:
my_vote:
- $ref: '#/components/schemas/my_vote'
+ $ref: "#/components/schemas/my_vote"
post:
- $ref: '#/components/schemas/post'
+ $ref: "#/components/schemas/post"
creator:
- $ref: '#/components/schemas/user'
+ $ref: "#/components/schemas/user"
creator_banned_from_community:
- $ref: '#/components/schemas/creator_banned_from_community'
+ $ref: "#/components/schemas/creator_banned_from_community"
community:
- $ref: '#/components/schemas/community'
+ $ref: "#/components/schemas/community"
saved:
- $ref: '#/components/schemas/saved'
+ $ref: "#/components/schemas/saved"
counts:
- $ref: '#/components/schemas/counts'
+ $ref: "#/components/schemas/counts"
recipient:
- $ref: '#/components/schemas/recipient'
+ $ref: "#/components/schemas/recipient"
comment:
- $ref: '#/components/schemas/comment'
+ $ref: "#/components/schemas/comment"
subscribed:
- $ref: '#/components/schemas/subscribed'
- 'repliesMentionsRequest':
+ $ref: "#/components/schemas/subscribed"
+ "repliesMentionsRequest":
type: object
required:
- sort
@@ -5241,32 +5241,32 @@ components:
- auth
properties:
sort:
- $ref: '#/components/schemas/sort'
+ $ref: "#/components/schemas/sort"
page:
- $ref: '#/components/schemas/page'
+ $ref: "#/components/schemas/page"
limit:
- $ref: '#/components/schemas/limit'
+ $ref: "#/components/schemas/limit"
unread_only:
- $ref: '#/components/schemas/unread_only'
+ $ref: "#/components/schemas/unread_only"
auth:
- $ref: '#/components/schemas/authStringSchema'
- 'report_id':
+ $ref: "#/components/schemas/authStringSchema"
+ "report_id":
description: The number (id) of a raised report
type: integer
format: int32
example: 1
- 'report_request':
+ "report_request":
type: object
properties:
page:
- $ref: '#/components/schemas/page'
+ $ref: "#/components/schemas/page"
limit:
- $ref: '#/components/schemas/limit'
+ $ref: "#/components/schemas/limit"
community:
- $ref: '#/components/schemas/community_id'
+ $ref: "#/components/schemas/community_id"
auth:
- $ref: '#/components/schemas/authStringSchema'
- 'resolve_request':
+ $ref: "#/components/schemas/authStringSchema"
+ "resolve_request":
type: object
required:
- report_id
@@ -5274,96 +5274,96 @@ components:
- auth
properties:
report_id:
- $ref: '#/components/schemas/report_id'
+ $ref: "#/components/schemas/report_id"
resolved:
- $ref: '#/components/schemas/resolved'
+ $ref: "#/components/schemas/resolved"
auth:
- $ref: '#/components/schemas/authStringSchema'
- 'resolve_response':
+ $ref: "#/components/schemas/authStringSchema"
+ "resolve_response":
type: object
properties:
report_id:
- $ref: '#/components/schemas/report_id'
+ $ref: "#/components/schemas/report_id"
resolved:
- $ref: '#/components/schemas/resolved'
- 'resolved':
+ $ref: "#/components/schemas/resolved"
+ "resolved":
description: Forthcoming...
type: boolean
example: true
- 'resolver_id':
+ "resolver_id":
description: The user_id of the person who resolved the report
type: number
nullable: true
- 'saved':
+ "saved":
description: |-
*true* if this post or comment has been or should be saved on the user's profile
type: boolean
example: false
- 'score':
+ "score":
type: number
description: Forthcoming...
example: 1
- 'score_plus_minus':
+ "score_plus_minus":
description: Forthcoming...
type: integer
format: int16
example: 1
minimum: -1
maximum: 1
- 'send_notifications_to_email':
- description: 'If set to *true*, the user will receive email notifications for any username mentions, post and comment replies'
+ "send_notifications_to_email":
+ description: "If set to *true*, the user will receive email notifications for any username mentions, post and comment replies"
type: boolean
example: false
- 'show_avatars':
+ "show_avatars":
description: |-
If set to *true*, displays other user's avatar images by their username in listings
type: boolean
example: true
- 'show_nsfw':
+ "show_nsfw":
type: boolean
description: |-
Set to *true* if you wish [NSFW](https://en.wikipedia.org/wiki/Not_safe_for_work) content to be viewable by this person/site
example: false
default: false
- 'site':
+ "site":
type: object
required:
- show_nsfw
properties:
description:
- $ref: '#/components/schemas/site_description'
+ $ref: "#/components/schemas/site_description"
banner:
- $ref: '#/components/schemas/banner'
+ $ref: "#/components/schemas/banner"
enable_downvotes:
- $ref: '#/components/schemas/enable_downvotes'
+ $ref: "#/components/schemas/enable_downvotes"
published:
- $ref: '#/components/schemas/published'
+ $ref: "#/components/schemas/published"
enable_nsfw:
- $ref: '#/components/schemas/show_nsfw'
+ $ref: "#/components/schemas/show_nsfw"
id:
type: number
name:
- $ref: '#/components/schemas/site_name'
+ $ref: "#/components/schemas/site_name"
updated:
description: Forthcoming...
type: string
nullable: true
- example: '2020-09-14T14:58:23.598513'
+ example: "2020-09-14T14:58:23.598513"
icon:
- $ref: '#/components/schemas/icon'
+ $ref: "#/components/schemas/icon"
open_registration:
- $ref: '#/components/schemas/open_registration'
+ $ref: "#/components/schemas/open_registration"
creator_id:
- $ref: '#/components/schemas/creator_id'
- 'site_counts':
+ $ref: "#/components/schemas/creator_id"
+ "site_counts":
type: object
properties:
users_active_week:
- $ref: '#/components/schemas/users_active_week'
+ $ref: "#/components/schemas/users_active_week"
posts:
- $ref: '#/components/schemas/posts'
+ $ref: "#/components/schemas/posts"
comments:
- $ref: '#/components/schemas/comment_count'
+ $ref: "#/components/schemas/comment_count"
communities:
description: Total number of communities on the site
type: number
@@ -5381,21 +5381,21 @@ components:
type: number
example: 1
users_active_day:
- $ref: '#/components/schemas/users_active_day'
+ $ref: "#/components/schemas/users_active_day"
users_active_month:
- $ref: '#/components/schemas/users_active_month'
+ $ref: "#/components/schemas/users_active_month"
users_active_half_year:
- $ref: '#/components/schemas/users_active_half_year'
- 'site_description':
+ $ref: "#/components/schemas/users_active_half_year"
+ "site_description":
description: |-
A brief overview of the site's purpose
type: string
- example: 'Federation test instance'
- 'site_name':
+ example: "Federation test instance"
+ "site_name":
description: The name of this site
type: string
- example: 'Enterprise'
- 'site_properties':
+ example: "Enterprise"
+ "site_properties":
type: object
required:
- name
@@ -5405,31 +5405,31 @@ components:
- enable_nsfw
properties:
name:
- $ref: '#/components/schemas/site_name'
+ $ref: "#/components/schemas/site_name"
enable_downvotes:
- $ref: '#/components/schemas/enable_downvotes'
+ $ref: "#/components/schemas/enable_downvotes"
open_registration:
- $ref: '#/components/schemas/open_registration'
+ $ref: "#/components/schemas/open_registration"
enable_nsfw:
- $ref: '#/components/schemas/show_nsfw'
+ $ref: "#/components/schemas/show_nsfw"
description:
- $ref: '#/components/schemas/site_description'
+ $ref: "#/components/schemas/site_description"
icon:
- $ref: '#/components/schemas/icon'
+ $ref: "#/components/schemas/icon"
banner:
- $ref: '#/components/schemas/banner'
+ $ref: "#/components/schemas/banner"
auth:
- $ref: '#/components/schemas/authStringSchema'
- 'site_view':
+ $ref: "#/components/schemas/authStringSchema"
+ "site_view":
type: object
properties:
counts:
- $ref: '#/components/schemas/counts'
+ $ref: "#/components/schemas/counts"
site:
- $ref: '#/components/schemas/site'
+ $ref: "#/components/schemas/site"
creator:
- $ref: '#/components/schemas/creator'
- 'sort':
+ $ref: "#/components/schemas/creator"
+ "sort":
type: string
description: |-
Sort the response from the server according to one of the following criteria:
@@ -5450,23 +5450,23 @@ components:
- TopMonth
- TopYear
- TopAll
- 'stickied':
+ "stickied":
description: |-
Set to *true* if the post is 'sticky'
type: boolean
example: true
- 'subscribed':
+ "subscribed":
type: boolean
description: Forthcoming...
example: true
- 'success':
- description: '*true* if report request was successful'
+ "success":
+ description: "*true* if report request was successful"
type: boolean
example: true
- 'theme':
- description: 'The theme style to use'
+ "theme":
+ description: "The theme style to use"
type: string
- example: 'darkly'
+ example: "darkly"
enum:
- Browser Default
- cyborg
@@ -5482,17 +5482,17 @@ components:
- united
- vaporwave
- vaporwave-dark
- 'title':
+ "title":
type: string
description: |-
The title (**Display name**) of this community.
If set, this is the name shown instead of, or as well as, *name* in some contexts
- example: 'BorgWatch'
- 'type_':
+ example: "BorgWatch"
+ "type_":
description: What is the scope of the search?
type: string
- example: 'All'
+ example: "All"
enum:
- All
- Comments
@@ -5500,103 +5500,103 @@ components:
- Communities
- Users
- Url
- 'type_listing':
+ "type_listing":
description: Choose from one of three types of listing
type: string
- example: 'All'
+ example: "All"
enum:
- All
- Subscribed
- Community
- 'unread_only':
+ "unread_only":
description: If *true*, only fetch unread comments or messages
type: boolean
example: false
- 'upvotes':
+ "upvotes":
type: number
description: Forthcoming...
example: 1
- 'url':
+ "url":
type: string
description: The link to the URL associated with the post
nullable: true
example: 'https:\/\/www.independent.co.uk\/news\/world\/europe\/covid-vaccine-novichok-russia-navalny-b1792778.html'
- 'user':
+ "user":
type: object
properties:
user:
type: object
properties:
updated:
- $ref: '#/components/schemas/user_updated'
+ $ref: "#/components/schemas/user_updated"
bio:
- $ref: '#/components/schemas/bio'
+ $ref: "#/components/schemas/bio"
admin:
- $ref: '#/components/schemas/admin'
+ $ref: "#/components/schemas/admin"
preferred_username:
- $ref: '#/components/schemas/preferred_username'
+ $ref: "#/components/schemas/preferred_username"
deleted:
- $ref: '#/components/schemas/deleted'
+ $ref: "#/components/schemas/deleted"
banned:
- $ref: '#/components/schemas/banned'
+ $ref: "#/components/schemas/banned"
published:
- $ref: '#/components/schemas/published'
+ $ref: "#/components/schemas/published"
matrix_user_id:
- $ref: '#/components/schemas/matrix_user_id'
+ $ref: "#/components/schemas/matrix_user_id"
avatar:
- $ref: '#/components/schemas/avatar'
+ $ref: "#/components/schemas/avatar"
id:
- $ref: '#/components/schemas/user_id'
+ $ref: "#/components/schemas/user_id"
actor_id:
- $ref: '#/components/schemas/actor_id'
+ $ref: "#/components/schemas/actor_id"
local:
- $ref: '#/components/schemas/local'
+ $ref: "#/components/schemas/local"
banner:
- $ref: '#/components/schemas/banner'
+ $ref: "#/components/schemas/banner"
name:
- $ref: '#/components/schemas/user_name'
- 'user_id':
+ $ref: "#/components/schemas/user_name"
+ "user_id":
description: |-
That user's id number
type: integer
format: int32
example: 77
- 'user_name':
+ "user_name":
type: string
description: The user's username
- example: 'griddle'
- 'user_updated':
+ example: "griddle"
+ "user_updated":
type: string
- description: 'The last time this user profile was updated (in [ISO8601 format](https://www.w3.org/TR/NOTE-datetime))'
- example: '2021-01-21T16:26:16.285610'
- 'user_view':
+ description: "The last time this user profile was updated (in [ISO8601 format](https://www.w3.org/TR/NOTE-datetime))"
+ example: "2021-01-21T16:26:16.285610"
+ "user_view":
type: object
properties:
counts:
- $ref: '#/components/schemas/counts'
+ $ref: "#/components/schemas/counts"
user:
- $ref: '#/components/schemas/user'
- 'username_or_email':
+ $ref: "#/components/schemas/user"
+ "username_or_email":
type: string
- description: 'Username or registered email'
- example: 'lemmy'
- 'users_active_day':
+ description: "Username or registered email"
+ example: "lemmy"
+ "users_active_day":
desciption: Number of 'active' users in the previous 24 hours
type: number
example: 2
- 'users_active_half_year':
+ "users_active_half_year":
desciption: Number of 'active' users in the previous six months
type: number
example: 10
- 'users_active_month':
+ "users_active_month":
desciption: Number of 'active' users in the previous 28 days
type: number
example: 10
- 'users_active_week':
+ "users_active_week":
description: Number of 'active' users in the previous seven days
type: number
example: 5
- 'version':
+ "version":
description: The version of the software running the Lemmy server
type: string
- example: '0.9.6'
+ example: "0.9.6"
diff --git a/src/shared/components/contact.tsx b/src/shared/components/contact.tsx
index 16d036a..e16d78a 100644
--- a/src/shared/components/contact.tsx
+++ b/src/shared/components/contact.tsx
@@ -14,59 +14,67 @@ export class Contact extends Component {
-
Contact
+
Contact
-
-
------BEGIN PGP PUBLIC KEY BLOCK-----
-
-mQGNBF+Fv+QBDACZO6MZiGq60I0UxsSyl3XCyYa2RD2gGJy4rjYe7m/cYvOBrjbb
-0mPgBqGl6NexB/zWE94hD7hyQ92ueTShgS+QiWEuWPIql16flnrEOynbZM7VcTWi
-F5vjH+MFHsyK7tw6nKoTQQPTu9ts0ifolzUfPgBWSfd7YGkaErkl8DwNGJPvc8Ti
-NRIZljyN2Vzl39WnNXNePc7o/RjXoUkz2c0Qt/bsxq8QnwqS966sRsd1kC28GVib
-rc2DMU3waXKPSgHnSPIoQeIEmjt+DiF5ntmkW78kJbtWRSwtd08XQ0MXKwrj0mS7
-l9eMxUxtSkE2ULpWZT5TCsxkDHj9hi2/JfuHN5UHOi7RnMmzgZgp6nV7i8DRn7h0
-eQSZSegUcYY5cF4hK3bPd7WpY5TI/RW1hIXswncUstYiGqtvocu8awe2BziyjLcR
-9/Yp9kZWbhv8YW7mrqDl8D7nDVnvax03dgYi2h9UF6K8EArFHPr/VqULy3u/4Hrq
-M4MjV3Ie9aXRHX8AEQEAAbQdTGVtbXlEZXZzIDxzZWN1cml0eUBsZW1teS5tbD6J
-Ac4EEwEIADgWIQRxXizPuj+wfOAE+y1xTTbGeag9FwUCX4W/5AIbAwULCQgHAgYV
-CgkICwIEFgIDAQIeAQIXgAAKCRBxTTbGeag9FyIhC/wJucTFG6U+3Q52kfdiGI1v
-jKtzlAjzxTybz6QriYzICqwsX5zRTsOb3z/QmfkfMVdctvCUde3+WlayAT4u45Ud
-L0GWjd8UhfHns2zuBZKlE1vpqwWGgmCV1bl/qnWHDfPBIgrz2Z494LlWcD4RzEGo
-NCfylKEw1mNEukL8MY4d3p1VP8ENTWf3SFoxZb0Qv+kGDpcGyB5jfTlQhM8MPUzA
-MrjqN1kGoLeYuaW3f/bxcZ8jvetApgd91kEw+T4bZ3KfKjChQfuys7LHBjPGV0xq
-IIG4Y2DeatJljZGIqRkWUEEKo3/w5qWUXLep9jDUMIeIifFH7e4qYdmZAQNavkRo
-MYazW2MFmHgnFFsWzx6eJk7IRqSdjkg/EmmSxGsbHqEO08qOt5KkKVBNf1VFkEGv
-MgJr+UEBKYDmQNSEiW/XurvMwdtrqYpyDlbq8cKV8/OtHzlLM4TPE7jkWSKqAnht
-4U6SBAa+oxMaau2WwQNR5oNBYoIcFUryqBn3Qxhpv7G5AY0EX4W/5AEMAMMbJ3LC
-r8v0t+z7OceC8oDpNLXOiVUsjGS5XE+sUdHwdKbBb5LA9TBxW2PJIhH68QYq82Oi
-2SwKpRhBI1Yqar4ffDxmLeEJck3SeizBD2B4LYaFoDYKgCUph67Ckgr4pfBYRX6H
-NlxZzjX0YgOrie6Vont3E1PK4dY/N+fcin1H162JZ/IG4oQE5MmHP4Gs+FPJaIF7
-82DiihTojRuLy5pbeJwbqtRbGMwIYC/WQG6hxsz1BzPs3QIgluCikr3g8RKD5V83
-ufwNqm/KA4uTbvzf/i7ocdZZyWfbDEldNr9pyut3z+2OImnPOjk5cqEZCVO4Q7+a
-0jKLQPBO1ULk1FK0jdYvoVTtyOAgztM3ItP0IvGqi0th3sLW4VAVvcdx0rnXI9uo
-qLICH0UeuZxyKNc1KKQc+hljNFe71DXsZ4UJ03ECUdfVR1KAWtUbPoKZV/EgRm3E
-yuUfQssL1eGSoE+gw4D0v30nTJfs5GQUwNztk3Ys+djRkpvA+GzXjwQedQARAQAB
-iQG2BBgBCAAgFiEEcV4sz7o/sHzgBPstcU02xnmoPRcFAl+Fv+QCGwwACgkQcU02
-xnmoPRc+bAv/X4GaPMY4ViAdgE5qBCDf5cqelbkQ28EdnujAmLpz/yMZ57SGQnpP
-BtR7Go3btLZLiU8f0Pj9U03EelOAGm+5GL787gNoY8BscK204AKFtgD+xWwA94RR
-efDhH3B+etvl1nVkz+ut0RNyEy8fh/eB+tKUqpyOmuPQ9F9Gl0eE7P8RLwZ2xCKV
-M8GlT7/ZsOWM5Ee5UzRPcNrRB9hOu+7PJZ5XgtgJrIafkIq7Y/kn/I5f/4NX19Lc
-cYDqpMHjNPkWV0bJmq6mfjcphQ9MXMgSAmTA+TtsnFqESLRZELFWlsaMTpBqXF7P
-myNHmfV8k8JPfuwsQG+cN3J8TIUkbawa7gw3a6m8NPb84QaKyZq/vHzvlAihQUZ3
-b689MNfXMU7hl6iTalhvEdcw7J2n7WuIn6AK/MoILNVJHhJDu+AE/UD0wMbY6Hgi
-qmD9J124tdP1q/HWq/VTL9CgLbpi9QXNt4NNwo9OJAQf3I2SjqywjhIzGzYrj0PP
-RnELNHhlJZ4s
-=VWLX
------END PGP PUBLIC KEY BLOCK-----
-
+
+
+
+ -----BEGIN PGP PUBLIC KEY BLOCK-----
+ mQGNBF+Fv+QBDACZO6MZiGq60I0UxsSyl3XCyYa2RD2gGJy4rjYe7m/cYvOBrjbb
+ 0mPgBqGl6NexB/zWE94hD7hyQ92ueTShgS+QiWEuWPIql16flnrEOynbZM7VcTWi
+ F5vjH+MFHsyK7tw6nKoTQQPTu9ts0ifolzUfPgBWSfd7YGkaErkl8DwNGJPvc8Ti
+ NRIZljyN2Vzl39WnNXNePc7o/RjXoUkz2c0Qt/bsxq8QnwqS966sRsd1kC28GVib
+ rc2DMU3waXKPSgHnSPIoQeIEmjt+DiF5ntmkW78kJbtWRSwtd08XQ0MXKwrj0mS7
+ l9eMxUxtSkE2ULpWZT5TCsxkDHj9hi2/JfuHN5UHOi7RnMmzgZgp6nV7i8DRn7h0
+ eQSZSegUcYY5cF4hK3bPd7WpY5TI/RW1hIXswncUstYiGqtvocu8awe2BziyjLcR
+ 9/Yp9kZWbhv8YW7mrqDl8D7nDVnvax03dgYi2h9UF6K8EArFHPr/VqULy3u/4Hrq
+ M4MjV3Ie9aXRHX8AEQEAAbQdTGVtbXlEZXZzIDxzZWN1cml0eUBsZW1teS5tbD6J
+ Ac4EEwEIADgWIQRxXizPuj+wfOAE+y1xTTbGeag9FwUCX4W/5AIbAwULCQgHAgYV
+ CgkICwIEFgIDAQIeAQIXgAAKCRBxTTbGeag9FyIhC/wJucTFG6U+3Q52kfdiGI1v
+ jKtzlAjzxTybz6QriYzICqwsX5zRTsOb3z/QmfkfMVdctvCUde3+WlayAT4u45Ud
+ L0GWjd8UhfHns2zuBZKlE1vpqwWGgmCV1bl/qnWHDfPBIgrz2Z494LlWcD4RzEGo
+ NCfylKEw1mNEukL8MY4d3p1VP8ENTWf3SFoxZb0Qv+kGDpcGyB5jfTlQhM8MPUzA
+ MrjqN1kGoLeYuaW3f/bxcZ8jvetApgd91kEw+T4bZ3KfKjChQfuys7LHBjPGV0xq
+ IIG4Y2DeatJljZGIqRkWUEEKo3/w5qWUXLep9jDUMIeIifFH7e4qYdmZAQNavkRo
+ MYazW2MFmHgnFFsWzx6eJk7IRqSdjkg/EmmSxGsbHqEO08qOt5KkKVBNf1VFkEGv
+ MgJr+UEBKYDmQNSEiW/XurvMwdtrqYpyDlbq8cKV8/OtHzlLM4TPE7jkWSKqAnht
+ 4U6SBAa+oxMaau2WwQNR5oNBYoIcFUryqBn3Qxhpv7G5AY0EX4W/5AEMAMMbJ3LC
+ r8v0t+z7OceC8oDpNLXOiVUsjGS5XE+sUdHwdKbBb5LA9TBxW2PJIhH68QYq82Oi
+ 2SwKpRhBI1Yqar4ffDxmLeEJck3SeizBD2B4LYaFoDYKgCUph67Ckgr4pfBYRX6H
+ NlxZzjX0YgOrie6Vont3E1PK4dY/N+fcin1H162JZ/IG4oQE5MmHP4Gs+FPJaIF7
+ 82DiihTojRuLy5pbeJwbqtRbGMwIYC/WQG6hxsz1BzPs3QIgluCikr3g8RKD5V83
+ ufwNqm/KA4uTbvzf/i7ocdZZyWfbDEldNr9pyut3z+2OImnPOjk5cqEZCVO4Q7+a
+ 0jKLQPBO1ULk1FK0jdYvoVTtyOAgztM3ItP0IvGqi0th3sLW4VAVvcdx0rnXI9uo
+ qLICH0UeuZxyKNc1KKQc+hljNFe71DXsZ4UJ03ECUdfVR1KAWtUbPoKZV/EgRm3E
+ yuUfQssL1eGSoE+gw4D0v30nTJfs5GQUwNztk3Ys+djRkpvA+GzXjwQedQARAQAB
+ iQG2BBgBCAAgFiEEcV4sz7o/sHzgBPstcU02xnmoPRcFAl+Fv+QCGwwACgkQcU02
+ xnmoPRc+bAv/X4GaPMY4ViAdgE5qBCDf5cqelbkQ28EdnujAmLpz/yMZ57SGQnpP
+ BtR7Go3btLZLiU8f0Pj9U03EelOAGm+5GL787gNoY8BscK204AKFtgD+xWwA94RR
+ efDhH3B+etvl1nVkz+ut0RNyEy8fh/eB+tKUqpyOmuPQ9F9Gl0eE7P8RLwZ2xCKV
+ M8GlT7/ZsOWM5Ee5UzRPcNrRB9hOu+7PJZ5XgtgJrIafkIq7Y/kn/I5f/4NX19Lc
+ cYDqpMHjNPkWV0bJmq6mfjcphQ9MXMgSAmTA+TtsnFqESLRZELFWlsaMTpBqXF7P
+ myNHmfV8k8JPfuwsQG+cN3J8TIUkbawa7gw3a6m8NPb84QaKyZq/vHzvlAihQUZ3
+ b689MNfXMU7hl6iTalhvEdcw7J2n7WuIn6AK/MoILNVJHhJDu+AE/UD0wMbY6Hgi
+ qmD9J124tdP1q/HWq/VTL9CgLbpi9QXNt4NNwo9OJAQf3I2SjqywjhIzGzYrj0PP
+ RnELNHhlJZ4s =VWLX -----END PGP PUBLIC KEY BLOCK-----
+
+
-
- );
+
+ );
}
}
diff --git a/src/shared/components/footer.tsx b/src/shared/components/footer.tsx
index 526e79a..48bd288 100644
--- a/src/shared/components/footer.tsx
+++ b/src/shared/components/footer.tsx
@@ -32,7 +32,7 @@ export class Footer extends Component {
-
+
diff --git a/src/shared/components/join.tsx b/src/shared/components/join.tsx
index 9ad63f1..c04ca1f 100644
--- a/src/shared/components/join.tsx
+++ b/src/shared/components/join.tsx
@@ -28,7 +28,10 @@ export class Join extends Component {
-
+
The flagship instance of lemmy.
@@ -103,7 +106,10 @@ export class Join extends Component {
-
+
@@ -207,7 +213,10 @@ export class Join extends Component {
-
+
A Basque Lemmy instance.
@@ -279,7 +288,10 @@ export class Join extends Component {
-
+
A polish anti-fascist instance.
diff --git a/src/shared/components/link-line.tsx b/src/shared/components/link-line.tsx
index 2a3fdae..9d73659 100644
--- a/src/shared/components/link-line.tsx
+++ b/src/shared/components/link-line.tsx
@@ -7,16 +7,16 @@ export class LinkLine extends Component {
}
render() {
return (
- <>
- Join
- Apps
- Sponsors
- Docs
-
- CoC
-
- Contact
- >
- );
+ <>
+ Join
+ Apps
+ Sponsors
+ Docs
+
+ CoC
+
+ Contact
+ >
+ );
}
}
diff --git a/src/shared/components/navbar.tsx b/src/shared/components/navbar.tsx
index 798396f..0576bd7 100644
--- a/src/shared/components/navbar.tsx
+++ b/src/shared/components/navbar.tsx
@@ -10,32 +10,38 @@ export class Navbar extends Component {
render() {
return (
- <>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- >
+ <>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ >
);
}
}
diff --git a/src/shared/components/sponsors.tsx b/src/shared/components/sponsors.tsx
index fd40ef8..ec7f25f 100644
--- a/src/shared/components/sponsors.tsx
+++ b/src/shared/components/sponsors.tsx
@@ -14,92 +14,126 @@ export class Sponsors extends Component {
+
+
Donate to Lemmy
+
+ Lemmy is free, open-source software, meaning no advertising,
+ monetizing, or venture capital, ever.{" "}
+ Your donations directly support full-time
+ development of the project.
+
+
+
-
-
Donate to Lemmy
-
Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
-
-
-
+
-
+
+
Sponsors
+
Silver Sponsors are those that pledged $40 to Lemmy.
+
+
+
General Sponsors are those that pledged $10 to $39 to Lemmy.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
Sponsors
-
Silver Sponsors are those that pledged $40 to Lemmy.
-
-
-
General Sponsors are those that pledged $10 to $39 to Lemmy.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Crypto
-
- bitcoin 1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK
- ethereum 0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01
- monero 41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV
-
-
-
-
-);
- }
+
+
Crypto
+
+
+ bitcoin
+
+ 1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK
+
+
+
+ ethereum
+
+ 0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01
+
+
+
+ monero
+
+
+ 41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV
+
+
+
+
+
+
+
+ );
+ }
}