USEFULL/drone
1
0
Fork 0
mirror of https://github.com/harness/drone.git synced 2025-04-27 13:13:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: [CODE-285]: Add openapi spec for space recent check list (#3115)

Browse Source 
* Add openapi spec for space recent check list
This commit is contained in:
Darko Draskovic 2024-12-06 13:07:21 +00:00 committed by Harness
parent 3f608cd3db
commit 7b214b58d5
2 changed files with 33 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
app/api/openapi/check.go
View File

@ -54,6 +54,21 @@ var queryParameterStatusCheckSince = openapi3.ParameterOrRef{
}, },
} }
var QueryParameterRecursive = openapi3.ParameterOrRef{
Parameter: &openapi3.Parameter{
Name: request.QueryParamRecursive,
In: openapi3.ParameterInQuery,
Description: ptr.String("The result should include entities from child spaces."),
Required: ptr.Bool(false),
Schema: &openapi3.SchemaOrRef{
Schema: &openapi3.Schema{
Type: ptrSchemaType(openapi3.SchemaTypeBoolean),
Default: ptrptr(false),
},
},
},
}
func checkOperations(reflector *openapi3.Reflector) { func checkOperations(reflector *openapi3.Reflector) {
const tag = "status_checks" const tag = "status_checks"
@ -106,4 +121,21 @@ func checkOperations(reflector *openapi3.Reflector) {
_ = reflector.SetJSONResponse(&listStatusCheckRecent, new(usererror.Error), http.StatusForbidden) _ = reflector.SetJSONResponse(&listStatusCheckRecent, new(usererror.Error), http.StatusForbidden)
_ = reflector.Spec.AddOperation(http.MethodGet, "/repos/{repo_ref}/checks/recent", _ = reflector.Spec.AddOperation(http.MethodGet, "/repos/{repo_ref}/checks/recent",
listStatusCheckRecent) listStatusCheckRecent)
listStatusCheckRecentSpace := openapi3.Operation{}
listStatusCheckRecentSpace.WithTags(tag)
listStatusCheckRecentSpace.WithParameters(
queryParameterStatusCheckQuery, queryParameterStatusCheckSince, QueryParameterRecursive)
listStatusCheckRecentSpace.WithMapOfAnything(map[string]interface{}{"operationId": "listStatusCheckRecentSpace"})
_ = reflector.SetRequest(&listStatusCheckRecentSpace, struct {
spaceRequest
Since int
}{}, http.MethodGet)
_ = reflector.SetJSONResponse(&listStatusCheckRecentSpace, new([]string), http.StatusOK)
_ = reflector.SetJSONResponse(&listStatusCheckRecentSpace, new(usererror.Error), http.StatusBadRequest)
_ = reflector.SetJSONResponse(&listStatusCheckRecentSpace, new(usererror.Error), http.StatusInternalServerError)
_ = reflector.SetJSONResponse(&listStatusCheckRecentSpace, new(usererror.Error), http.StatusUnauthorized)
_ = reflector.SetJSONResponse(&listStatusCheckRecentSpace, new(usererror.Error), http.StatusForbidden)
_ = reflector.Spec.AddOperation(http.MethodGet, "/spaces/{space_ref}/checks/recent",
listStatusCheckRecentSpace)
} }

2
app/router/api.go
View File

@ -295,7 +295,7 @@ func setupSpaces(
SetupWebhookSpace(r, webhookCtrl) SetupWebhookSpace(r, webhookCtrl)
SetupRulesSpace(r, spaceCtrl) SetupRulesSpace(r, spaceCtrl)
r.Get("/checks", handlercheck.HandleCheckListRecentSpace(checkCtrl)) r.Get("/checks/recent", handlercheck.HandleCheckListRecentSpace(checkCtrl))
}) })
}) })
} }