From bbddaadf5184b4fa849716ec57ee34b5038e2dc6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bar=C4=B1=C5=9F=20Soner=20U=C5=9Fakl=C4=B1?= Date: Mon, 6 Apr 2020 21:00:08 -0400 Subject: [PATCH 1/2] feat: tag route doc --- public/openapi/read.yaml | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/public/openapi/read.yaml b/public/openapi/read.yaml index 5f12ed9099..cc6ad748a0 100644 --- a/public/openapi/read.yaml +++ b/public/openapi/read.yaml @@ -9704,8 +9704,10 @@ paths: tags: - tags summary: /api/tags/{tag} + description: Returns a list of topics that are tagged with {tag} parameters: - name: tag + description: The tag used to retrieve the topics in: path required: true schema: @@ -9720,6 +9722,7 @@ paths: properties: topics: type: array + description: An array of topics that are all tagged with {tag} items: type: object properties: @@ -10118,13 +10121,12 @@ paths: properties: html: type: string - "304": - description: "" /api/tags: get: tags: - tags summary: /api/tags + description: Returns a list of tags with the most topics responses: "200": description: "" @@ -10135,15 +10137,19 @@ paths: properties: tags: type: array + description: An array of tags with the most topics items: type: object properties: value: type: string + description: The raw tag score: type: number + description: Number of topics tagged by this tag valueEscaped: type: string + description: This is the escaped tag value, equal to validator.escape(value) color: type: string bgColor: From 9987813f30cfca422c7f6feba6afee7ca1cb6fdb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bar=C4=B1=C5=9F=20Soner=20U=C5=9Fakl=C4=B1?= Date: Mon, 6 Apr 2020 21:09:49 -0400 Subject: [PATCH 2/2] feat: add page query param to docs --- public/openapi/read.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/public/openapi/read.yaml b/public/openapi/read.yaml index cc6ad748a0..8c37ab554f 100644 --- a/public/openapi/read.yaml +++ b/public/openapi/read.yaml @@ -9712,6 +9712,12 @@ paths: required: true schema: type: string + - name: page + description: Page number used in pagination + in: query + required: false + schema: + type: number responses: "200": description: ""