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: tag route doc

Browse Source
This commit is contained in:
Barış Soner Uşaklı
2020-04-06 21:00:08 -04:00
parent ac98775f23
commit bbddaadf51
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
public/openapi/read.yaml
View File

@@ -9704,8 +9704,10 @@ paths:
tags: tags:
- tags - tags
summary: /api/tags/{tag} summary: /api/tags/{tag}
description: Returns a list of topics that are tagged with {tag}
parameters: parameters:
- name: tag - name: tag
description: The tag used to retrieve the topics
in: path in: path
required: true required: true
schema: schema:
@@ -9720,6 +9722,7 @@ paths:
properties: properties:
topics: topics:
type: array type: array
description: An array of topics that are all tagged with {tag}
items: items:
type: object type: object
properties: properties:
@@ -10118,13 +10121,12 @@ paths:
properties: properties:
html: html:
type: string type: string
"304":
description: ""
/api/tags: /api/tags:
get: get:
tags: tags:
- tags - tags
summary: /api/tags summary: /api/tags
description: Returns a list of tags with the most topics
responses: responses:
"200": "200":
description: "" description: ""
@@ -10135,15 +10137,19 @@ paths:
properties: properties:
tags: tags:
type: array type: array
description: An array of tags with the most topics
items: items:
type: object type: object
properties: properties:
value: value:
type: string type: string
description: The raw tag
score: score:
type: number type: number
description: Number of topics tagged by this tag
valueEscaped: valueEscaped:
type: string type: string
description: This is the escaped tag value, equal to validator.escape(value)
color: color:
type: string type: string
bgColor: bgColor: