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

fix(openapi): removed repeated breadcrumb blocks in favour of $ref

Browse Source
This commit is contained in:
Julian Lam
2020-04-08 17:06:26 -04:00
parent ac579f9dc2
commit 646fac1e53
1 changed files with 23 additions and 207 deletions
Download Patch File Download Diff File Expand all files Collapse all files

230
public/openapi/read.yaml
View File

@@ -2925,15 +2925,6 @@ paths:
type: string type: string
imageClass: imageClass:
type: string type: string
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
topics: topics:
type: array type: array
items: items:
@@ -3135,6 +3126,7 @@ paths:
type: string type: string
isQuestion: isQuestion:
nullable: true nullable: true
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/categories/{cid}/moderators": "/api/categories/{cid}/moderators":
get: get:
@@ -3536,21 +3528,13 @@ paths:
type: boolean type: boolean
allowLoginWith: allowLoginWith:
type: string type: string
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
title: title:
type: string type: string
allowPasswordReset: allowPasswordReset:
type: boolean type: boolean
allowLocalLogin: allowLocalLogin:
type: boolean type: boolean
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
/api/register: /api/register:
get: get:
@@ -3595,15 +3579,6 @@ paths:
type: number type: number
minimumPasswordStrength: minimumPasswordStrength:
type: number type: number
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
regFormEntry: regFormEntry:
type: array type: array
items: items:
@@ -3617,6 +3592,7 @@ paths:
type: string type: string
title: title:
type: string type: string
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
/api/register/complete: /api/register/complete:
get: get:
@@ -3791,15 +3767,6 @@ paths:
type: string type: string
categoriesCount: categoriesCount:
type: number type: number
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
expandSearch: expandSearch:
type: boolean type: boolean
showAsPosts: showAsPosts:
@@ -3811,6 +3778,7 @@ paths:
searchDefaultSortBy: searchDefaultSortBy:
type: string type: string
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/reset/{code?}": "/api/reset/{code?}":
get: get:
@@ -4168,15 +4136,6 @@ paths:
icons: icons:
type: array type: array
items: {} items: {}
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
privileges: privileges:
type: object type: object
properties: properties:
@@ -4242,6 +4201,7 @@ paths:
postIndex: postIndex:
type: number type: number
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/topic/{topic_id}/{slug?}": "/api/topic/{topic_id}/{slug?}":
get: get:
@@ -4626,15 +4586,6 @@ paths:
icons: icons:
type: array type: array
items: {} items: {}
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
privileges: privileges:
type: object type: object
properties: properties:
@@ -4722,6 +4673,7 @@ paths:
the user's auto-generated icon the user's auto-generated icon
example: "#f44336" example: "#f44336"
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/post/{pid}": "/api/post/{pid}":
get: get:
@@ -5467,15 +5419,6 @@ paths:
type: number type: number
tag: tag:
type: string type: string
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
title: title:
type: string type: string
categories: categories:
@@ -5507,6 +5450,7 @@ paths:
rssFeedUrl: rssFeedUrl:
type: string type: string
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
/api/tags: /api/tags:
get: get:
@@ -5546,17 +5490,9 @@ paths:
type: boolean type: boolean
nextStart: nextStart:
type: number type: number
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
title: title:
type: string type: string
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
/api/popular: /api/popular:
get: get:
@@ -5870,16 +5806,8 @@ paths:
type: boolean type: boolean
term: term:
type: string type: string
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
/api/recent: /api/recent:
get: get:
@@ -6192,16 +6120,8 @@ paths:
type: boolean type: boolean
term: term:
type: string type: string
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
/api/top: /api/top:
get: get:
@@ -6534,16 +6454,8 @@ paths:
type: boolean type: boolean
term: term:
type: string type: string
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
/api/unread: /api/unread:
get: get:
@@ -6801,15 +6713,6 @@ paths:
selectedCids: selectedCids:
type: array type: array
items: {} items: {}
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
filters: filters:
type: array type: array
items: items:
@@ -6835,6 +6738,7 @@ paths:
filter: filter:
type: string type: string
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/category/{category_id}/{slug}/{topic_index}": "/api/category/{category_id}/{slug}/{topic_index}":
get: get:
@@ -7113,15 +7017,6 @@ paths:
type: boolean type: boolean
isIgnored: isIgnored:
type: boolean type: boolean
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
title: title:
type: string type: string
privileges: privileges:
@@ -7155,6 +7050,7 @@ paths:
reputation:disabled: reputation:disabled:
type: number type: number
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/category/{category_id}/{slug?}": "/api/category/{category_id}/{slug?}":
get: get:
@@ -7444,15 +7340,6 @@ paths:
type: boolean type: boolean
isIgnored: isIgnored:
type: boolean type: boolean
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
title: title:
type: string type: string
privileges: privileges:
@@ -7486,6 +7373,7 @@ paths:
reputation:disabled: reputation:disabled:
type: number type: number
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
/api/me/*: /api/me/*:
get: get:
@@ -7863,15 +7751,6 @@ paths:
type: boolean type: boolean
hasPrivateChat: hasPrivateChat:
type: number type: number
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
title: title:
type: string type: string
allowCoverPicture: allowCoverPicture:
@@ -7927,6 +7806,7 @@ paths:
type: string type: string
cover:thumb:url: cover:thumb:url:
type: string type: string
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/user/{userslug}/following": "/api/user/{userslug}/following":
get: get:
@@ -8494,15 +8374,6 @@ paths:
type: string type: string
title: title:
type: string type: string
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
showSort: showSort:
type: boolean type: boolean
sortOptions: sortOptions:
@@ -8517,6 +8388,7 @@ paths:
selected: selected:
type: boolean type: boolean
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/user/{userslug}/best": "/api/user/{userslug}/best":
get: get:
@@ -8836,15 +8708,6 @@ paths:
type: string type: string
title: title:
type: string type: string
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
showSort: showSort:
type: boolean type: boolean
sortOptions: sortOptions:
@@ -8859,6 +8722,7 @@ paths:
selected: selected:
type: boolean type: boolean
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/user/{userslug}/watched": "/api/user/{userslug}/watched":
get: get:
@@ -9255,15 +9119,6 @@ paths:
type: string type: string
title: title:
type: string type: string
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
showSort: showSort:
type: boolean type: boolean
sortOptions: sortOptions:
@@ -9279,6 +9134,7 @@ paths:
type: boolean type: boolean
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs - $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/user/{userslug}/ignored": "/api/user/{userslug}/ignored":
get: get:
@@ -10018,15 +9874,7 @@ paths:
items: {} items: {}
title: title:
type: string type: string
breadcrumbs: - $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/user/{userslug}/session/{uuid}": "/api/user/{userslug}/session/{uuid}":
delete: delete:
@@ -10170,16 +10018,8 @@ paths:
type: boolean type: boolean
title: title:
type: string type: string
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/user/{userslug}/chats/{roomid?}": "/api/user/{userslug}/chats/{roomid?}":
get: get:
@@ -10571,15 +10411,6 @@ paths:
type: number type: number
title: title:
type: string type: string
breadcrumbs:
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
isAdminOrGlobalMod: isAdminOrGlobalMod:
type: boolean type: boolean
isAdmin: isAdmin:
@@ -10603,6 +10434,7 @@ paths:
reputation:disabled: reputation:disabled:
type: number type: number
- $ref: components/schemas/Pagination.yaml#/Pagination - $ref: components/schemas/Pagination.yaml#/Pagination
- $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
/api/groups: /api/groups:
get: get:
@@ -10709,15 +10541,7 @@ paths:
type: number type: number
title: title:
type: string type: string
breadcrumbs: - $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/groups/{slug}": "/api/groups/{slug}":
get: get:
@@ -10985,15 +10809,7 @@ paths:
type: boolean type: boolean
allowPrivateGroups: allowPrivateGroups:
type: number type: number
breadcrumbs: - $ref: components/schemas/Breadcrumbs.yaml#/Breadcrumbs
type: array
items:
type: object
properties:
text:
type: string
url:
type: string
- $ref: components/schemas/CommonProps.yaml#/CommonProps - $ref: components/schemas/CommonProps.yaml#/CommonProps
"/api/groups/{slug}/members": "/api/groups/{slug}/members":
get: get: