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

feat: openapi component

Browse Source
This commit is contained in:
Barış Soner Uşaklı
2020-04-06 23:40:08 -04:00
parent 9987813f30
commit 1af5507ac7
1 changed files with 906 additions and 1042 deletions
Download Patch File Download Diff File Expand all files Collapse all files

288
public/openapi/read.yaml
View File

@@ -33,6 +33,73 @@ tags:
description: Disparate method of categorizing topics description: Disparate method of categorizing topics
- name: shorthand - name: shorthand
description: Convenience and utility routes for accessing other part of the API description: Convenience and utility routes for accessing other part of the API
components:
schemas:
CommonProps:
type: object
properties:
loggedIn:
type: boolean
relative_path:
type: string
url:
type: string
bodyClass:
type: string
_header:
type: object
properties:
tags:
type: object
properties:
meta:
type: array
items:
type: object
properties:
name:
type: string
content:
type: string
noEscape:
type: boolean
property:
type: string
required:
- name
- content
- noEscape
- property
link:
type: array
items:
type: object
properties:
rel:
type: string
type:
type: string
href:
type: string
title:
type: string
sizes:
type: string
required:
- rel
- href
- type
- sizes
widgets:
type: object
properties:
footer:
type: array
items:
type: object
properties:
html:
type: string
paths: paths:
/api/: /api/:
get: get:
@@ -45,7 +112,8 @@ paths:
content: content:
application/json: application/json:
schema: schema:
type: object allOf:
- type: object
properties: properties:
title: title:
type: string type: string
@@ -375,10 +443,6 @@ paths:
- posts - posts
- teaser - teaser
- imageClass - imageClass
loggedIn:
type: boolean
relative_path:
type: string
template: template:
type: object type: object
properties: properties:
@@ -386,10 +450,6 @@ paths:
type: string type: string
categories: categories:
type: boolean type: boolean
url:
type: string
bodyClass:
type: string
topics: topics:
type: array type: array
items: items:
@@ -612,83 +672,7 @@ paths:
type: number type: number
enableCarouselPagination: enableCarouselPagination:
type: number type: number
_header: - $ref: '#/components/schemas/CommonProps'
type: object
properties:
tags:
type: object
properties:
meta:
type: array
items:
type: object
properties:
name:
type: string
content:
type: string
noEscape:
type: boolean
property:
type: string
required:
- name
- content
- noEscape
- property
link:
type: array
items:
type: object
properties:
rel:
type: string
type:
type: string
href:
type: string
title:
type: string
sizes:
type: string
required:
- rel
- href
- type
- sizes
widgets:
type: object
properties:
sidebar:
type: array
items:
type: object
properties:
html:
type: string
required:
- html
header:
type: array
items:
type: object
properties:
html:
type: string
footer:
type: array
items:
type: object
properties:
html:
type: string
motd:
type: array
items:
type: object
properties:
html:
type: string
"304": "304":
description: "" description: ""
"/api/post/{pid}/raw": "/api/post/{pid}/raw":
@@ -9724,7 +9708,8 @@ paths:
content: content:
application/json: application/json:
schema: schema:
type: object allOf:
- type: object
properties: properties:
topics: topics:
type: array type: array
@@ -10058,10 +10043,6 @@ paths:
type: string type: string
rssFeedUrl: rssFeedUrl:
type: string type: string
loggedIn:
type: boolean
relative_path:
type: string
template: template:
type: object type: object
properties: properties:
@@ -10069,64 +10050,7 @@ paths:
type: string type: string
tag: tag:
type: boolean type: boolean
url: - $ref: '#/components/schemas/CommonProps'
type: string
bodyClass:
type: string
_header:
type: object
properties:
tags:
type: object
properties:
meta:
type: array
items:
type: object
properties:
name:
type: string
content:
type: string
noEscape:
type: boolean
property:
type: string
required:
- name
- content
- noEscape
- property
link:
type: array
items:
type: object
properties:
rel:
type: string
type:
type: string
href:
type: string
title:
type: string
sizes:
type: string
required:
- rel
- href
- type
- sizes
widgets:
type: object
properties:
footer:
type: array
items:
type: object
properties:
html:
type: string
/api/tags: /api/tags:
get: get:
tags: tags:
@@ -10139,7 +10063,8 @@ paths:
content: content:
application/json: application/json:
schema: schema:
type: object allOf:
- type: object
properties: properties:
tags: tags:
type: array type: array
@@ -10181,12 +10106,6 @@ paths:
type: string type: string
required: required:
- text - text
title:
type: string
loggedIn:
type: boolean
relative_path:
type: string
template: template:
type: object type: object
properties: properties:
@@ -10194,64 +10113,9 @@ paths:
type: string type: string
tags: tags:
type: boolean type: boolean
url:
type: string
bodyClass:
type: string
_header:
type: object
properties:
tags:
type: object
properties:
meta:
type: array
items:
type: object
properties:
name:
type: string
content:
type: string
noEscape:
type: boolean
property:
type: string
required:
- name
- content
- noEscape
- property
link:
type: array
items:
type: object
properties:
rel:
type: string
type:
type: string
href:
type: string
title: title:
type: string type: string
sizes: - $ref: '#/components/schemas/CommonProps'
type: string
required:
- rel
- href
- type
- sizes
widgets:
type: object
properties:
footer:
type: array
items:
type: object
properties:
html:
type: string
/api/categories: /api/categories:
get: get:
tags: tags: