summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Svantesson <davidsvantesson@gmail.com>2019-08-24 05:17:10 +0200
committertechknowlogick <techknowlogick@gitea.io>2019-08-23 23:17:10 -0400
commit26af3401c36e6316b81b92bf6a776bf2442d251c (patch)
treee1745d59e0fab4fa671e911cd7bc13f1623d7a6f
parentce45a8c257bee0aba37ecb92d3eaaefe0153091c (diff)
downloadgitea-26af3401c36e6316b81b92bf6a776bf2442d251c.tar.gz
gitea-26af3401c36e6316b81b92bf6a776bf2442d251c.zip
Document possibility to limit API Repo search to topics only. (#7957)
Signed-off-by: David Svantesson <davidsvantesson@gmail.com>
-rw-r--r--routers/api/v1/repo/repo.go4
-rw-r--r--templates/swagger/v1_json.tmpl6
2 files changed, 10 insertions, 0 deletions
diff --git a/routers/api/v1/repo/repo.go b/routers/api/v1/repo/repo.go
index 5fe41927fa..4afe1661d0 100644
--- a/routers/api/v1/repo/repo.go
+++ b/routers/api/v1/repo/repo.go
@@ -51,6 +51,10 @@ func Search(ctx *context.APIContext) {
// in: query
// description: keyword
// type: string
+ // - name: topic
+ // in: query
+ // description: Limit search to repositories with keyword as topic
+ // type: boolean
// - name: uid
// in: query
// description: search only for repos that the user with the given id owns or contributes to
diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl
index 2d5f8c5c9c..ee05345697 100644
--- a/templates/swagger/v1_json.tmpl
+++ b/templates/swagger/v1_json.tmpl
@@ -1094,6 +1094,12 @@
"in": "query"
},
{
+ "type": "boolean",
+ "description": "Limit search to repositories with keyword as topic",
+ "name": "topic",
+ "in": "query"
+ },
+ {
"type": "integer",
"format": "int64",
"description": "search only for repos that the user with the given id owns or contributes to",