github/drone
5
0
Fork 0
mirror of https://github.com/harness/drone.git synced 2025-05-07 04:51:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: Add swagger support for uploads API (#678)

Browse Source
This commit is contained in:
Akhilesh Pandey 2023-10-27 08:37:12 +00:00 committed by Harness
parent 4e3a43efdd
commit 66416c55a6
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
app/api/openapi/upload.go
View File

@ -25,19 +25,20 @@ import (
type UploadRequest struct { type UploadRequest struct {
repoRequest repoRequest
//nolint:lll //Note: Below line won't produce the file upload interface in Swagger UI, ref: https://swagger.io/docs/specification/2-0/file-upload/ // Note: Below line won't produce the file upload interface in Swagger UI,
// ref: https://swagger.io/docs/specification/2-0/file-upload/
Content string `json:"-" format:"binary" description:"Binary file to upload"` Content string `json:"-" format:"binary" description:"Binary file to upload"`
} }
type DownloadRequest struct { type DownloadRequest struct {
repoRequest repoRequest
NameRef string `path:"name_ref"` FilePathRef string `path:"file_ref"`
} }
func uploadOperations(reflector *openapi3.Reflector) { func uploadOperations(reflector *openapi3.Reflector) {
opUpload := openapi3.Operation{} opUpload := openapi3.Operation{}
opUpload.WithTags("upload") opUpload.WithTags("upload")
opUpload.WithMapOfAnything(map[string]interface{}{"operationId": "upload"}) opUpload.WithMapOfAnything(map[string]interface{}{"operationId": "repoArtifactUpload"})
_ = reflector.SetRequest(&opUpload, new(UploadRequest), http.MethodPost) _ = reflector.SetRequest(&opUpload, new(UploadRequest), http.MethodPost)
_ = reflector.SetJSONResponse(&opUpload, new(upload.Result), http.StatusCreated) _ = reflector.SetJSONResponse(&opUpload, new(upload.Result), http.StatusCreated)
_ = reflector.SetJSONResponse(&opUpload, new(usererror.Error), http.StatusBadRequest) _ = reflector.SetJSONResponse(&opUpload, new(usererror.Error), http.StatusBadRequest)
@ -50,7 +51,7 @@ func uploadOperations(reflector *openapi3.Reflector) {
downloadOp := openapi3.Operation{} downloadOp := openapi3.Operation{}
downloadOp.WithTags("upload") downloadOp.WithTags("upload")
downloadOp.WithMapOfAnything(map[string]interface{}{"operationId": "download"}) downloadOp.WithMapOfAnything(map[string]interface{}{"operationId": "repoArtifactDownload"})
_ = reflector.SetRequest(&downloadOp, new(DownloadRequest), http.MethodGet) _ = reflector.SetRequest(&downloadOp, new(DownloadRequest), http.MethodGet)
_ = reflector.SetJSONResponse(&downloadOp, nil, http.StatusTemporaryRedirect) _ = reflector.SetJSONResponse(&downloadOp, nil, http.StatusTemporaryRedirect)
_ = reflector.SetJSONResponse(&downloadOp, new(usererror.Error), http.StatusNotFound) _ = reflector.SetJSONResponse(&downloadOp, new(usererror.Error), http.StatusNotFound)
@ -59,5 +60,5 @@ func uploadOperations(reflector *openapi3.Reflector) {
_ = reflector.SetJSONResponse(&downloadOp, new(usererror.Error), http.StatusUnauthorized) _ = reflector.SetJSONResponse(&downloadOp, new(usererror.Error), http.StatusUnauthorized)
_ = reflector.SetJSONResponse(&downloadOp, new(usererror.Error), http.StatusForbidden) _ = reflector.SetJSONResponse(&downloadOp, new(usererror.Error), http.StatusForbidden)
_ = reflector.Spec.AddOperation(http.MethodGet, "/repos/{repo_ref}/uploads/{name_ref}", downloadOp) _ = reflector.Spec.AddOperation(http.MethodGet, "/repos/{repo_ref}/uploads/{file_ref}", downloadOp)
} }