Files
NodeBB/public/openapi/read/search.yaml
Barış Soner Uşaklı d1364c3130 Categories refactor (#9233)
* feat: wip categories pagination

* feat: add subCategoriesPerPage setting

* feat: add load more sub categories button to category page

* fix: openapi spec

* feat: show sub categories left on category page

hide button when no more categories left

* breaking: rename categories to allCategories on /search

categories contains the search results

* fix: spec

* refactor: remove cidsPerPage

* fix: tests

* feat: use component for subcategories

* fix: prevent negative subCategoriesLeft
2021-02-01 15:19:32 -05:00

77 lines
2.4 KiB
YAML

get:
tags:
- search
summary: Get search results
responses:
"200":
description: ""
content:
application/json:
schema:
allOf:
- type: object
properties:
posts:
$ref: ../components/schemas/PostsObject.yaml#/PostsObject
matchCount:
type: number
pageCount:
type: number
time:
type: string
multiplePages:
type: boolean
search_query:
type: string
term:
type: string
allCategories:
type: array
items:
type: object
properties:
value:
oneOf:
- type: string
- type: number
text:
type: string
allCategoriesCount:
type: number
expandSearch:
type: boolean
showAsPosts:
type: boolean
showAsTopics:
type: boolean
title:
type: string
searchDefaultSortBy:
type: string
privileges:
type: object
properties:
search:users:
type: boolean
search:content:
type: boolean
search:tags:
type: boolean
required:
- posts
- matchCount
- pageCount
- time
- multiplePages
- search_query
- allCategories
- allCategoriesCount
- expandSearch
- showAsPosts
- showAsTopics
- title
- searchDefaultSortBy
- permissions
- $ref: ../components/schemas/Pagination.yaml#/Pagination
- $ref: ../components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: ../components/schemas/CommonProps.yaml#/CommonProps