mirror of
https://github.com/NodeBB/NodeBB.git
synced 2025-11-17 11:11:04 +01:00
feat(openapi): refactor into indiv. files to match API & tpl routing
This commit is contained in:
psychobunny
204
public/openapi/api/admin/extend/plugins.yaml
Normal file
204
public/openapi/api/admin/extend/plugins.yaml
Normal file
@@ -0,0 +1,204 @@
|
||||
get:
|
||||
tags:
|
||||
- admin
|
||||
summary: Get system plugin settings
|
||||
responses:
|
||||
"200":
|
||||
description: ""
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
installed:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
latest:
|
||||
type: string
|
||||
description:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
updated:
|
||||
type: string
|
||||
url:
|
||||
type: string
|
||||
numInstalls:
|
||||
type: number
|
||||
isCompatible:
|
||||
type: boolean
|
||||
id:
|
||||
type: string
|
||||
installed:
|
||||
type: boolean
|
||||
active:
|
||||
type: boolean
|
||||
isTheme:
|
||||
type: boolean
|
||||
error:
|
||||
type: boolean
|
||||
version:
|
||||
type: string
|
||||
license:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
text:
|
||||
type: string
|
||||
nullable: true
|
||||
outdated:
|
||||
type: boolean
|
||||
settingsRoute:
|
||||
type: string
|
||||
required:
|
||||
- latest
|
||||
- description
|
||||
- name
|
||||
- id
|
||||
- installed
|
||||
- active
|
||||
- isTheme
|
||||
- error
|
||||
- version
|
||||
- license
|
||||
- outdated
|
||||
installedCount:
|
||||
type: number
|
||||
activeCount:
|
||||
type: number
|
||||
inactiveCount:
|
||||
type: number
|
||||
upgradeCount:
|
||||
type: number
|
||||
download:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
updated:
|
||||
type: string
|
||||
description:
|
||||
type: string
|
||||
latest:
|
||||
type: string
|
||||
url:
|
||||
type: string
|
||||
numInstalls:
|
||||
type: number
|
||||
isCompatible:
|
||||
type: boolean
|
||||
id:
|
||||
type: string
|
||||
installed:
|
||||
type: boolean
|
||||
active:
|
||||
type: boolean
|
||||
required:
|
||||
- name
|
||||
- updated
|
||||
- latest
|
||||
- url
|
||||
- numInstalls
|
||||
- isCompatible
|
||||
- id
|
||||
- installed
|
||||
- active
|
||||
incompatible:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
latest:
|
||||
type: string
|
||||
description:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
updated:
|
||||
type: string
|
||||
url:
|
||||
type: string
|
||||
numInstalls:
|
||||
type: number
|
||||
isCompatible:
|
||||
type: boolean
|
||||
id:
|
||||
type: string
|
||||
installed:
|
||||
type: boolean
|
||||
active:
|
||||
type: boolean
|
||||
required:
|
||||
- name
|
||||
- updated
|
||||
- latest
|
||||
- url
|
||||
- numInstalls
|
||||
- isCompatible
|
||||
- id
|
||||
- installed
|
||||
- active
|
||||
trending:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
latest:
|
||||
type: string
|
||||
description:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
updated:
|
||||
type: string
|
||||
url:
|
||||
type: string
|
||||
numInstalls:
|
||||
type: number
|
||||
isCompatible:
|
||||
type: boolean
|
||||
id:
|
||||
type: string
|
||||
installed:
|
||||
type: boolean
|
||||
active:
|
||||
type: boolean
|
||||
isTheme:
|
||||
type: boolean
|
||||
error:
|
||||
type: boolean
|
||||
version:
|
||||
type: string
|
||||
license:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
text:
|
||||
type: string
|
||||
nullable: true
|
||||
outdated:
|
||||
type: boolean
|
||||
settingsRoute:
|
||||
type: string
|
||||
downloads:
|
||||
type: number
|
||||
required:
|
||||
- latest
|
||||
- description
|
||||
- name
|
||||
- id
|
||||
- installed
|
||||
- active
|
||||
- downloads
|
||||
submitPluginUsage:
|
||||
type: number
|
||||
version:
|
||||
type: string
|
||||
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps
|
||||
85
public/openapi/api/admin/extend/rewards.yaml
Normal file
85
public/openapi/api/admin/extend/rewards.yaml
Normal file
@@ -0,0 +1,85 @@
|
||||
get:
|
||||
tags:
|
||||
- admin
|
||||
summary: Get rewards settings
|
||||
responses:
|
||||
"200":
|
||||
description: "A JSON object containing rewards and their settings"
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
active:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
condition:
|
||||
type: string
|
||||
conditional:
|
||||
type: string
|
||||
value:
|
||||
type: number
|
||||
rid:
|
||||
type: string
|
||||
claimable:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
disabled:
|
||||
type: boolean
|
||||
rewards:
|
||||
type: array
|
||||
items:
|
||||
additionalProperties: {}
|
||||
description: Reward-specific properties
|
||||
conditions:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
condition:
|
||||
type: string
|
||||
conditionals:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
conditional:
|
||||
type: string
|
||||
rewards:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
rid:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
inputs:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
label:
|
||||
type: string
|
||||
values:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
value:
|
||||
type: string
|
||||
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps
|
||||
90
public/openapi/api/admin/extend/widgets.yaml
Normal file
90
public/openapi/api/admin/extend/widgets.yaml
Normal file
@@ -0,0 +1,90 @@
|
||||
get:
|
||||
tags:
|
||||
- admin
|
||||
summary: Get widget settings
|
||||
responses:
|
||||
"200":
|
||||
description: ""
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
templates:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
template:
|
||||
type: string
|
||||
areas:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
location:
|
||||
type: string
|
||||
areas:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
template:
|
||||
type: string
|
||||
location:
|
||||
type: string
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
widget:
|
||||
type: string
|
||||
data:
|
||||
type: object
|
||||
properties:
|
||||
html:
|
||||
type: string
|
||||
cid:
|
||||
type: string
|
||||
title:
|
||||
type: string
|
||||
container:
|
||||
type: string
|
||||
groups:
|
||||
type: array
|
||||
items: {}
|
||||
groupsHideFrom:
|
||||
type: array
|
||||
items: {}
|
||||
hide-mobile:
|
||||
type: string
|
||||
numTags:
|
||||
type: string
|
||||
numUsers:
|
||||
type: string
|
||||
text:
|
||||
type: string
|
||||
parseAsPost:
|
||||
type: string
|
||||
numTopics:
|
||||
type: string
|
||||
availableWidgets:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
widget:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
description:
|
||||
type: string
|
||||
content:
|
||||
type: string
|
||||
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps
|
||||
Reference in New Issue
Block a user