Skip to content

Commit

Permalink
correct node checkin API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jertel committed Jan 24, 2025
1 parent 07397c6 commit 6a25c0c
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions server/nodehandler.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,18 @@ func RegisterNodeRoutes(srv *Server, r chi.Router, prefix string) {
})
}

// @Summary Node Check-in / Get Pending Jobs
// @Summary Node Check-in
// @Description Used by Security Onion agent nodes to check-in with their current metrics and request any pending jobs assigned to it.
// @Tags Grid, Jobs
// @Description It is not recommended to make calls to this API endpoint, as this is intended to be used exclusively by official Security Onion nodes only.
// @Tags Grid
// @Security bearer[nodes/write,jobs/process]
// @Param request body model.Node true "The node object with recent metrics"
// @Produce json
// @Success 200 {array} model.Job "The array of assigned, pending jobs that this node is responsible for processing, if any"
// @Failure 400 "The provided input object or parameters are malformed or invalid"
// @Failure 401 "Request was not properly authenticated"
// @Failure 500 "Internal SOC error; review SOC logs"
// @Router /connect/node/{jobId} [post]
// @Router /connect/node [post]
func (h *NodeHandler) postNode(w http.ResponseWriter, r *http.Request) {
ctx := r.Context()

Expand Down

0 comments on commit 6a25c0c

Please sign in to comment.