summaryrefslogtreecommitdiff
path: root/docs/api/swagger.yaml
diff options
context:
space:
mode:
authorLibravatar Daenney <daenney@users.noreply.github.com>2024-12-23 16:43:50 +0100
committerLibravatar GitHub <noreply@github.com>2024-12-23 16:43:50 +0100
commit1aa7f706609acf7c0be894559fda36651a35733c (patch)
tree2f612fcc2554434e2a97caf0956e51b09a47d99b /docs/api/swagger.yaml
parent[chore] Update ncruces/go-sqlite3 to 0.21.3 (#3629) (diff)
downloadgotosocial-1aa7f706609acf7c0be894559fda36651a35733c.tar.xz
[chore] Stub /api/v1/announcements implementation (#3630)
* [chore] Stub /api/v1/announcements implementation This implements the /api/v1/announcements endpoint by simply returning an empty array. This indicates there are no instance announcements. Some clients retrieve this endpoint and get surprised by a 404. It tends to be harmless, but results in some unnecessary logging when trying to debug other things. * [fix] Forgot some swagger * [fix] Fix swagger some more
Diffstat (limited to 'docs/api/swagger.yaml')
-rw-r--r--docs/api/swagger.yaml28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml
index d10aa5daa..81b32bb72 100644
--- a/docs/api/swagger.yaml
+++ b/docs/api/swagger.yaml
@@ -6745,6 +6745,34 @@ paths:
summary: View instance rule with the given id.
tags:
- admin
+ /api/v1/announcements:
+ get:
+ description: 'THIS ENDPOINT IS CURRENTLY NOT FULLY IMPLEMENTED: it will always return an empty array.'
+ operationId: announcementsGet
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: ""
+ schema:
+ items:
+ type: object
+ maxItems: 0
+ type: array
+ "400":
+ description: bad request
+ "401":
+ description: unauthorized
+ "406":
+ description: not acceptable
+ "500":
+ description: internal server error
+ security:
+ - OAuth2 Bearer:
+ - read:announcements
+ summary: Get an array of currently active announcements.
+ tags:
+ - announcements
/api/v1/apps:
post:
consumes: