mirror of
https://github.com/NodeBB/NodeBB.git
synced 2025-10-26 16:46:12 +01:00
feat: add missing schemas for various ACP settings routes
This commit is contained in:
@@ -57,8 +57,12 @@ tags:
|
|||||||
paths:
|
paths:
|
||||||
/api/:
|
/api/:
|
||||||
$ref: 'read/index.yaml'
|
$ref: 'read/index.yaml'
|
||||||
|
/api/admin:
|
||||||
|
$ref: 'read/admin.yaml'
|
||||||
/api/admin/dashboard:
|
/api/admin/dashboard:
|
||||||
$ref: 'read/admin/dashboard.yaml'
|
$ref: 'read/admin/dashboard.yaml'
|
||||||
|
"/api/admin/settings/{term}":
|
||||||
|
$ref: 'read/admin/settings/term.yaml'
|
||||||
/api/admin/settings/languages:
|
/api/admin/settings/languages:
|
||||||
$ref: 'read/admin/settings/languages.yaml'
|
$ref: 'read/admin/settings/languages.yaml'
|
||||||
/api/admin/settings/navigation:
|
/api/admin/settings/navigation:
|
||||||
@@ -67,6 +71,12 @@ paths:
|
|||||||
$ref: 'read/admin/settings/homepage.yaml'
|
$ref: 'read/admin/settings/homepage.yaml'
|
||||||
/api/admin/settings/social:
|
/api/admin/settings/social:
|
||||||
$ref: 'read/admin/settings/social.yaml'
|
$ref: 'read/admin/settings/social.yaml'
|
||||||
|
/api/admin/settings/email:
|
||||||
|
$ref: 'read/admin/settings/email.yaml'
|
||||||
|
/api/admin/settings/user:
|
||||||
|
$ref: 'read/admin/settings/user.yaml'
|
||||||
|
/api/admin/settings/post:
|
||||||
|
$ref: 'read/admin/settings/post.yaml'
|
||||||
/api/admin/manage/categories:
|
/api/admin/manage/categories:
|
||||||
$ref: 'read/admin/manage/categories.yaml'
|
$ref: 'read/admin/manage/categories.yaml'
|
||||||
"/api/admin/manage/categories/{category_id}":
|
"/api/admin/manage/categories/{category_id}":
|
||||||
@@ -91,8 +101,6 @@ paths:
|
|||||||
$ref: 'read/admin/manage/uploads.yaml'
|
$ref: 'read/admin/manage/uploads.yaml'
|
||||||
/api/admin/manage/digest:
|
/api/admin/manage/digest:
|
||||||
$ref: 'read/admin/manage/digest.yaml'
|
$ref: 'read/admin/manage/digest.yaml'
|
||||||
"/api/admin/settings/{term}":
|
|
||||||
$ref: 'read/admin/settings/term.yaml'
|
|
||||||
"/api/admin/appearance/{term}":
|
"/api/admin/appearance/{term}":
|
||||||
$ref: 'read/admin/appearance/term.yaml'
|
$ref: 'read/admin/appearance/term.yaml'
|
||||||
/api/admin/extend/plugins:
|
/api/admin/extend/plugins:
|
||||||
|
|||||||
19
public/openapi/read/admin.yaml
Normal file
19
public/openapi/read/admin.yaml
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- admin
|
||||||
|
summary: Get administrative index
|
||||||
|
description: |
|
||||||
|
Internally, NodeBB will redirect you to a different page based on your privilege levels.
|
||||||
|
|
||||||
|
The default is "dashboard" for superadmins and those with the "dashboard" privilege. If the requesting user is neither, then they will be redirected to a page that they have privileges to view (e.g. `/categories`, `/privileges`, `/users`, or `/settings/general`).
|
||||||
|
|
||||||
|
Failing that, the request will be denied.
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: |
|
||||||
|
A JSON object containing data for the default admin index.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties: {}
|
||||||
|
additionalProperties: {}
|
||||||
43
public/openapi/read/admin/settings/email.yaml
Normal file
43
public/openapi/read/admin/settings/email.yaml
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- admin
|
||||||
|
summary: Get emailer settings
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: ""
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
allOf:
|
||||||
|
- type: object
|
||||||
|
properties:
|
||||||
|
emails:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
path:
|
||||||
|
type: string
|
||||||
|
description: The name of the email template
|
||||||
|
fullpath:
|
||||||
|
type: string
|
||||||
|
description: Full system path to the email template
|
||||||
|
text:
|
||||||
|
type: string
|
||||||
|
description: Customized email template text, if applicable, otherwise identical to `original`
|
||||||
|
original:
|
||||||
|
type: string
|
||||||
|
description: The email template text as provided by NodeBB core
|
||||||
|
isCustom:
|
||||||
|
type: boolean
|
||||||
|
sendable:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: The name of the email template
|
||||||
|
services:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: A list of email services which can be used to send emails on behalf of NodeBB
|
||||||
|
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps
|
||||||
18
public/openapi/read/admin/settings/post.yaml
Normal file
18
public/openapi/read/admin/settings/post.yaml
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- admin
|
||||||
|
summary: Get post settings
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: ""
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
allOf:
|
||||||
|
- type: object
|
||||||
|
properties:
|
||||||
|
groupsExemptFromPostQueue:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: ../../../components/schemas/GroupObject.yaml#/GroupDataObject
|
||||||
|
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps
|
||||||
25
public/openapi/read/admin/settings/user.yaml
Normal file
25
public/openapi/read/admin/settings/user.yaml
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- admin
|
||||||
|
summary: Get user settings
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: ""
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
allOf:
|
||||||
|
- type: object
|
||||||
|
properties:
|
||||||
|
notificationSettings:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: The notification type
|
||||||
|
label:
|
||||||
|
type: string
|
||||||
|
description: The language key for the notification type (for localisation client-side)
|
||||||
|
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps
|
||||||
Reference in New Issue
Block a user