diff --git a/docs/docs.go b/docs/docs.go index a247c3ca..59818015 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -1311,6 +1311,70 @@ const docTemplate = `{ } } }, + "/api/v3/cluster/process/probe": { + "post": { + "security": [ + { + "ApiKeyAuth": [] + } + ], + "description": "Probe a process config to get a detailed stream information on the inputs.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "v16.?.?" + ], + "summary": "Probe a process in the cluster", + "operationId": "cluster-3-probe-process-config", + "parameters": [ + { + "description": "Process config", + "name": "config", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/api.ProcessConfig" + } + }, + { + "type": "string", + "description": "Core to execute the probe on", + "name": "coreid", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/api.Probe" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/api.Error" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/api.Error" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/api.Error" + } + } + } + } + }, "/api/v3/cluster/process/{id}": { "get": { "security": [ @@ -1695,7 +1759,7 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Probe an existing process to get a detailed stream information on the inputs.", + "description": "Probe an existing process to get a detailed stream information on the inputs. The probe is executed on the same node as the process.", "produces": [ "application/json" ], diff --git a/docs/swagger.json b/docs/swagger.json index 50c1373f..8c0f3aa2 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -1303,6 +1303,70 @@ } } }, + "/api/v3/cluster/process/probe": { + "post": { + "security": [ + { + "ApiKeyAuth": [] + } + ], + "description": "Probe a process config to get a detailed stream information on the inputs.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "v16.?.?" + ], + "summary": "Probe a process in the cluster", + "operationId": "cluster-3-probe-process-config", + "parameters": [ + { + "description": "Process config", + "name": "config", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/api.ProcessConfig" + } + }, + { + "type": "string", + "description": "Core to execute the probe on", + "name": "coreid", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/api.Probe" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/api.Error" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/api.Error" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/api.Error" + } + } + } + } + }, "/api/v3/cluster/process/{id}": { "get": { "security": [ @@ -1687,7 +1751,7 @@ "ApiKeyAuth": [] } ], - "description": "Probe an existing process to get a detailed stream information on the inputs.", + "description": "Probe an existing process to get a detailed stream information on the inputs. The probe is executed on the same node as the process.", "produces": [ "application/json" ], diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 39386848..804a5819 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -3547,7 +3547,7 @@ paths: /api/v3/cluster/process/{id}/probe: get: description: Probe an existing process to get a detailed stream information - on the inputs. + on the inputs. The probe is executed on the same node as the process. operationId: cluster-3-process-probe parameters: - description: Process ID @@ -3575,6 +3575,48 @@ paths: summary: Probe a process in the cluster tags: - v16.?.? + /api/v3/cluster/process/probe: + post: + consumes: + - application/json + description: Probe a process config to get a detailed stream information on + the inputs. + operationId: cluster-3-probe-process-config + parameters: + - description: Process config + in: body + name: config + required: true + schema: + $ref: '#/definitions/api.ProcessConfig' + - description: Core to execute the probe on + in: query + name: coreid + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/api.Probe' + "400": + description: Bad Request + schema: + $ref: '#/definitions/api.Error' + "403": + description: Forbidden + schema: + $ref: '#/definitions/api.Error' + "500": + description: Internal Server Error + schema: + $ref: '#/definitions/api.Error' + security: + - ApiKeyAuth: [] + summary: Probe a process in the cluster + tags: + - v16.?.? /api/v3/cluster/snapshot: get: description: Retrieve snapshot of the cluster DB