Nemcio/NodeBB
1
0
Fork 0
mirror of https://github.com/NodeBB/NodeBB.git synced 2025-10-26 16:46:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix: have category sync routes return full api response, openapi schema for that pair of routes

Browse Source
This commit is contained in:
Julian Lam
2024-04-29 11:45:40 -04:00
parent 596a5e4ba2
commit b7ad4317cc
4 changed files with 103 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
public/openapi/write.yaml
View File

@@ -136,6 +136,8 @@ paths:
$ref: 'write/categories/cid/privileges/privilege.yaml'
/categories/{cid}/moderator/{uid}:
$ref: 'write/categories/cid/moderator/uid.yaml'
/categories/{cid}/follow:
$ref: 'write/categories/cid/follow.yaml'
/topics/:
$ref: 'write/topics.yaml'
/topics/{tid}:

85
public/openapi/write/categories/cid/follow.yaml Normal file
View File

@@ -0,0 +1,85 @@
put:
tags:
- categories
summary: synchronize category
description: |
**This operation requires an enabled activitypub integration**
Establishes a "follow" relationship between another activitypub-enabled actor.
Until an "accept" response is received, the synchronization will stay in a pending state.
Upon acceptance, a one-way sync is achieved; the other actor will need to follow the same category in order to achieve full two-way synchronization.
parameters:
- in: path
name: cid
schema:
type: string
required: true
description: a valid category id
example: 1
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
actor:
type: string
description: A valid actor uri or webfinger handle
example: 'foobar@example.org'
responses:
'200':
description: successfully sent category synchronization request
content:
application/json:
schema:
type: object
properties:
status:
$ref: ../../../components/schemas/Status.yaml#/Status
response:
type: object
properties: {}
delete:
tags:
- categories
summary: unsynchronize category
description: |
**This operation requires an enabled activitypub integration**
Removes a "follow" relationship between another activitypub-enabled actor.
Unlike the synchronization request, this does not require an acceptance from the remote end.
N.B. This method only severs the link for incoming content.
parameters:
- in: path
name: cid
schema:
type: string
required: true
description: a valid category id
example: 1
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
actor:
type: string
description: A valid actor uri or webfinger handle
example: 'foobar@example.org'
responses:
'200':
description: successfully unsynchronized category
content:
application/json:
schema:
type: object
properties:
status:
$ref: ../../../components/schemas/Status.yaml#/Status
response:
type: object
properties: {}

20
src/controllers/write/categories.js
View File

@@ -106,9 +106,13 @@ Categories.setModerator = async (req, res) => {
helpers.formatApiResponse(200, res, privilegeSet);
};
Categories.follow = async (req, res) => {
Categories.follow = async (req, res, next) => {
const { actor } = req.body;
const id = req.params.cid;
const id = parseInt(req.params.cid, 10);
if (!id) { // disallow cid 0
return next();
}
await api.activitypub.follow(req, {
type: 'cid',
@@ -116,12 +120,16 @@ Categories.follow = async (req, res) => {
actor,
});
res.sendStatus(200);
helpers.formatApiResponse(200, res, {});
};
Categories.unfollow = async (req, res) => {
Categories.unfollow = async (req, res, next) => {
const { actor } = req.body;
const id = req.params.cid;
const id = parseInt(req.params.cid, 10);
if (!id) { // disallow cid 0
return next();
}
await api.activitypub.unfollow(req, {
type: 'cid',
@@ -129,5 +137,5 @@ Categories.unfollow = async (req, res) => {
actor,
});
res.sendStatus(200);
helpers.formatApiResponse(200, res, {});
};

4
src/routes/write/categories.js
View File

@@ -31,8 +31,8 @@ module.exports = function () {
setupApiRoute(router, 'put', '/:cid/moderator/:uid', [...middlewares, middleware.assert.category], controllers.write.categories.setModerator);
setupApiRoute(router, 'delete', '/:cid/moderator/:uid', [...middlewares, middleware.assert.category], controllers.write.categories.setModerator);
setupApiRoute(router, 'put', '/:cid/follow', [...middlewares, middleware.admin.checkPrivileges, middleware.assert.category], controllers.write.categories.follow);
setupApiRoute(router, 'delete', '/:cid/follow', [...middlewares, middleware.admin.checkPrivileges, middleware.assert.category], controllers.write.categories.unfollow);
setupApiRoute(router, 'put', '/:cid/follow', [...middlewares, middleware.activitypub.enabled, middleware.admin.checkPrivileges, middleware.assert.category], controllers.write.categories.follow);
setupApiRoute(router, 'delete', '/:cid/follow', [...middlewares, middleware.activitypub.enabled, middleware.admin.checkPrivileges, middleware.assert.category], controllers.write.categories.unfollow);
return router;
};