Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
style(openapi): move schemas and responses out of write.yaml
- Loading branch information
1 parent
9c157de
commit ffac3c7
Showing
12 changed files
with
337 additions
and
340 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
'400': | ||
description: Bad Request | ||
content: | ||
application/json: | ||
schema: | ||
$ref: ../../components/schemas/Error.yaml#/Error |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
'401': | ||
description: Not Authorized | ||
content: | ||
application/json: | ||
schema: | ||
$ref: ../../components/schemas/Error.yaml#/Error |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
'403': | ||
description: Forbidden | ||
content: | ||
application/json: | ||
schema: | ||
$ref: ../../components/schemas/Error.yaml#/Error |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
'404': | ||
description: Not Found | ||
content: | ||
application/json: | ||
schema: | ||
$ref: ../../components/schemas/Error.yaml#/Error |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
'426': | ||
description: Upgrade Required | ||
content: | ||
application/json: | ||
schema: | ||
$ref: ../../components/schemas/Error.yaml#/Error |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
'500': | ||
description: Internal Server Error | ||
content: | ||
application/json: | ||
schema: | ||
$ref: ../../components/schemas/Error.yaml#/Error |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
CategoryObj: | ||
properties: | ||
cid: | ||
type: number | ||
example: 1 | ||
name: | ||
type: string | ||
example: My New Category | ||
description: | ||
type: string | ||
example: Lorem ipsum, dolor sit amet | ||
descriptionParsed: | ||
type: string | ||
example: Lorem ipsum, dolor sit amet | ||
icon: | ||
type: string | ||
example: bullhorn | ||
bgColor: | ||
type: string | ||
example: '#ffffff' | ||
color: | ||
type: string | ||
example: '#000000' | ||
slug: | ||
type: string | ||
example: 1/my-new-category | ||
parentCid: | ||
type: number | ||
example: 0 | ||
topic_count: | ||
type: number | ||
example: 0 | ||
post_count: | ||
type: number | ||
example: 0 | ||
disabled: | ||
type: number | ||
example: 0 | ||
order: | ||
type: number | ||
example: 5 | ||
link: | ||
type: number | ||
example: 'https://example.org' | ||
numRecentReplies: | ||
type: number | ||
example: 1 | ||
class: | ||
type: string | ||
example: col-md-3 col-xs-6 | ||
imageClass: | ||
type: string | ||
example: cover | ||
isSection: | ||
type: number | ||
example: 0 | ||
totalPostCount: | ||
type: number | ||
example: 0 | ||
totalTopicCount: | ||
type: number | ||
example: 0 | ||
tagWhitelist: | ||
type: array | ||
example: | ||
- some-tag | ||
- another-tag | ||
unread-class: | ||
type: string | ||
backgroundImage: | ||
type: string | ||
example: '/assets/images/covers/Circuit1.png' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
Error: | ||
type: object | ||
properties: | ||
status: | ||
type: object | ||
properties: | ||
code: | ||
type: string | ||
message: | ||
type: string | ||
response: | ||
type: object |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
Status: | ||
type: object | ||
properties: | ||
code: | ||
type: string | ||
example: ok | ||
message: | ||
type: string | ||
example: OK |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
UserObj: | ||
properties: | ||
uid: | ||
type: number | ||
example: 1 | ||
username: | ||
type: string | ||
example: Dragon Fruit | ||
userslug: | ||
type: string | ||
example: dragon-fruit | ||
email: | ||
type: string | ||
example: dragonfruit@example.org | ||
'email:confirmed': | ||
type: number | ||
example: 1 | ||
joindate: | ||
type: number | ||
example: 1585337827953 | ||
lastonline: | ||
type: number | ||
example: 1585337827953 | ||
picture: | ||
type: string | ||
example: 'https://images.unsplash.com/photo-1560070094-e1f2ddec4337?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=256&h=256&q=80' | ||
fullname: | ||
type: string | ||
example: Mr. Dragon Fruit Jr. | ||
location: | ||
type: string | ||
example: 'Toronto, Canada' | ||
birthday: | ||
type: string | ||
description: A birthdate given in an ISO format parseable by the Date object | ||
example: 03/27/2020 | ||
website: | ||
type: string | ||
example: 'https://example.org' | ||
aboutme: | ||
type: string | ||
example: | | ||
This is a paragraph all about how my life got twist-turned upside-down | ||
and I'd like to take a minute and sit right here, | ||
to tell you all about how I because the administrator of NodeBB | ||
signature: | ||
type: string | ||
example: | | ||
This is an example signature | ||
It can span multiple lines. | ||
uploadedpicture: | ||
type: string | ||
example: /assets/profile/1-profileimg.png | ||
description: 'In almost all cases, defer to "picture" instead. Use this if you need to specifically reference the picture uploaded to the forum.' | ||
profileviews: | ||
type: number | ||
example: 1000 | ||
reputation: | ||
type: number | ||
example: 100 | ||
postcount: | ||
type: number | ||
example: 1000 | ||
topiccount: | ||
type: number | ||
example: 50 | ||
lastposttime: | ||
type: number | ||
example: 1585337827953 | ||
banned: | ||
type: number | ||
example: 0 | ||
'banned:expire': | ||
type: number | ||
example: 1585337827953 | ||
status: | ||
type: string | ||
example: online | ||
flags: | ||
type: number | ||
example: 0 | ||
followercount: | ||
type: number | ||
example: 2 | ||
followingcount: | ||
type: number | ||
example: 5 | ||
'cover:url': | ||
type: string | ||
example: /assets/profile/1-cover.png | ||
'cover:position': | ||
type: string | ||
example: 50.0301% 19.2464% | ||
groupTitle: | ||
type: string | ||
example: '["administrators","Staff"]' | ||
groupTitleArray: | ||
type: array | ||
example: | ||
- administrators | ||
- Staff | ||
'icon:text': | ||
type: string | ||
example: D | ||
'icon:bgColor': | ||
type: string | ||
example: '#9c27b0' | ||
joindateISO: | ||
type: string | ||
example: '2020-03-27T20:30:36.590Z' | ||
lastonlineISO: | ||
type: string | ||
example: '2020-03-27T20:30:36.590Z' | ||
banned_until: | ||
type: number | ||
example: 0 | ||
banned_until_readable: | ||
type: string | ||
example: Not Banned |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
UserRequest: | ||
properties: | ||
username: | ||
type: string | ||
example: Dragon Fruit | ||
email: | ||
type: string | ||
example: dragonfruit@example.org | ||
fullname: | ||
type: string | ||
example: Mr. Dragon Fruit Jr. | ||
website: | ||
type: string | ||
example: 'https://example.org' | ||
location: | ||
type: string | ||
example: 'Toronto, Canada' | ||
groupTitle: | ||
type: string | ||
example: '["administrators","Staff"]' | ||
birthday: | ||
type: string | ||
description: A birthdate given in an ISO format parseable by the Date object | ||
example: 03/27/2020 | ||
signature: | ||
type: string | ||
example: | | ||
This is an example signature | ||
It can span multiple lines. | ||
aboutme: | ||
type: string | ||
example: | | ||
This is a paragraph all about how my life got twist-turned upside-down | ||
and I'd like to take a minute and sit right here, | ||
to tell you all about how I because the administrator of NodeBB |
Oops, something went wrong.