mirror of
https://github.com/go-gitea/gitea
synced 2024-11-10 20:24:24 +00:00
Add return type to GetRawFileOrLFS and GetRawFile (#31680)
Document return type for the endpoints that fetch specific files from a repository. This allows the swagger generated code to read the returned data. Co-authored-by: Giteabot <teabot@gitea.io>
This commit is contained in:
parent
cc044818c3
commit
bae87dfb09
@ -42,7 +42,7 @@ func GetRawFile(ctx *context.APIContext) {
|
||||
// ---
|
||||
// summary: Get a file from a repository
|
||||
// produces:
|
||||
// - application/json
|
||||
// - application/octet-stream
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
@ -67,6 +67,8 @@ func GetRawFile(ctx *context.APIContext) {
|
||||
// responses:
|
||||
// 200:
|
||||
// description: Returns raw file content.
|
||||
// schema:
|
||||
// type: file
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
|
||||
@ -92,6 +94,8 @@ func GetRawFileOrLFS(ctx *context.APIContext) {
|
||||
// swagger:operation GET /repos/{owner}/{repo}/media/{filepath} repository repoGetRawFileOrLFS
|
||||
// ---
|
||||
// summary: Get a file or it's LFS object from a repository
|
||||
// produces:
|
||||
// - application/octet-stream
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
@ -116,6 +120,8 @@ func GetRawFileOrLFS(ctx *context.APIContext) {
|
||||
// responses:
|
||||
// 200:
|
||||
// description: Returns raw file content.
|
||||
// schema:
|
||||
// type: file
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
|
||||
|
15
templates/swagger/v1_json.tmpl
generated
15
templates/swagger/v1_json.tmpl
generated
@ -10609,6 +10609,9 @@
|
||||
},
|
||||
"/repos/{owner}/{repo}/media/{filepath}": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/octet-stream"
|
||||
],
|
||||
"tags": [
|
||||
"repository"
|
||||
],
|
||||
@ -10645,7 +10648,10 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Returns raw file content."
|
||||
"description": "Returns raw file content.",
|
||||
"schema": {
|
||||
"type": "file"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
@ -12682,7 +12688,7 @@
|
||||
"/repos/{owner}/{repo}/raw/{filepath}": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
"application/octet-stream"
|
||||
],
|
||||
"tags": [
|
||||
"repository"
|
||||
@ -12720,7 +12726,10 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Returns raw file content."
|
||||
"description": "Returns raw file content.",
|
||||
"schema": {
|
||||
"type": "file"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
|
Loading…
Reference in New Issue
Block a user