summaryrefslogtreecommitdiff
path: root/pkg/api/server/register_events.go
diff options
context:
space:
mode:
authorJhon Honce <jhonce@redhat.com>2020-01-22 10:41:35 -0700
committerJhon Honce <jhonce@redhat.com>2020-01-22 15:17:14 -0700
commitda1186ae639c8101f05e4350986fdab0b1bd3566 (patch)
treedfc8a73189dc16f9f36b3cf9f56f571ccbc4cfc3 /pkg/api/server/register_events.go
parentc42383f70a7832faf1ba920d6c9e169a88b0e4d9 (diff)
downloadpodman-da1186ae639c8101f05e4350986fdab0b1bd3566.tar.gz
podman-da1186ae639c8101f05e4350986fdab0b1bd3566.tar.bz2
podman-da1186ae639c8101f05e4350986fdab0b1bd3566.zip
Enable swagger validation for each PR
* Update swagger:operation's to pass validation * 'name' path parameter now used throughout API * Added #/response/ok for 200 returns, TBD values have been replaced with legal values. Signed-off-by: Jhon Honce <jhonce@redhat.com>
Diffstat (limited to 'pkg/api/server/register_events.go')
-rw-r--r--pkg/api/server/register_events.go13
1 files changed, 9 insertions, 4 deletions
diff --git a/pkg/api/server/register_events.go b/pkg/api/server/register_events.go
index 56cf96de1..a32244f4d 100644
--- a/pkg/api/server/register_events.go
+++ b/pkg/api/server/register_events.go
@@ -8,24 +8,29 @@ import (
func (s *APIServer) RegisterEventsHandlers(r *mux.Router) error {
// swagger:operation GET /events system getEvents
// ---
+ // tags:
+ // - system
// summary: Returns events filtered on query parameters
+ // description: Returns events filtered on query parameters
// produces:
// - application/json
// parameters:
// - name: since
+ // type: string
// in: query
// description: start streaming events from this time
// - name: until
+ // type: string
// in: query
// description: stop streaming events later than this
// - name: filters
+ // type: string
// in: query
// description: JSON encoded map[string][]string of constraints
// responses:
- // "200":
- // description: OK
- // "500":
- // description: Failed
+ // 200:
+ // $ref: "#/responses/ok"
+ // 500:
// "$ref": "#/responses/InternalError"
r.Handle(VersionedPath("/events"), APIHandler(s.Context, handlers.GetEvents))
return nil