Merge pull request #5458 from baude/apiv2eventslibpod

[CI:DOCS]Add libpod event endpoint
This commit is contained in:
OpenShift Merge Robot 2020-03-11 16:34:03 -04:00 committed by GitHub
commit 78e090092b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 2 deletions

View File

@ -11,8 +11,8 @@ func (s *APIServer) registerEventsHandlers(r *mux.Router) error {
// swagger:operation GET /events system getEvents // swagger:operation GET /events system getEvents
// --- // ---
// tags: // tags:
// - system // - system (compat)
// summary: Returns events filtered on query parameters // summary: Get events
// description: Returns events filtered on query parameters // description: Returns events filtered on query parameters
// produces: // produces:
// - application/json // - application/json
@ -37,5 +37,32 @@ func (s *APIServer) registerEventsHandlers(r *mux.Router) error {
r.Handle(VersionedPath("/events"), s.APIHandler(compat.GetEvents)).Methods(http.MethodGet) r.Handle(VersionedPath("/events"), s.APIHandler(compat.GetEvents)).Methods(http.MethodGet)
// Added non version path to URI to support docker non versioned paths // Added non version path to URI to support docker non versioned paths
r.Handle("/events", s.APIHandler(compat.GetEvents)).Methods(http.MethodGet) r.Handle("/events", s.APIHandler(compat.GetEvents)).Methods(http.MethodGet)
// swagger:operation GET /libpod/events system libpodGetEvents
// ---
// tags:
// - system
// summary: Get events
// 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: returns a string of json data describing an event
// 500:
// "$ref": "#/responses/InternalError"
r.Handle(VersionedPath("/events"), s.APIHandler(compat.GetEvents)).Methods(http.MethodGet)
return nil return nil
} }