From 92dfbada3793fc2be23d38783d6842eac9825f58 Mon Sep 17 00:00:00 2001
From: Gusted <williamzijl7@hotmail.com>
Date: Thu, 28 Apr 2022 14:57:56 +0000
Subject: [PATCH] Better describe what `/repos/{owner}/{repo}/raw/{filepath}`
returns on 200 (#19542)
- Set on the description that it returns the raw file content.
- Resolves #19514
---
routers/api/v1/repo/file.go | 2 +-
templates/swagger/v1_json.tmpl | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/routers/api/v1/repo/file.go b/routers/api/v1/repo/file.go
index ed51f6f4df..d907e770ae 100644
--- a/routers/api/v1/repo/file.go
+++ b/routers/api/v1/repo/file.go
@@ -53,7 +53,7 @@ func GetRawFile(ctx *context.APIContext) {
// required: false
// responses:
// 200:
- // description: success
+ // description: Returns raw file content.
// "404":
// "$ref": "#/responses/notFound"
diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl
index 0374a53a65..ea03380d43 100644
--- a/templates/swagger/v1_json.tmpl
+++ b/templates/swagger/v1_json.tmpl
@@ -8628,7 +8628,7 @@
],
"responses": {
"200": {
- "description": "success"
+ "description": "Returns raw file content."
},
"404": {
"$ref": "#/responses/notFound"