Skip to content

Commit 8623fca

Browse files
tisniktisnik
authored
Merge pull request #1052 from tisnik/lcore-1224
LCORE-1224: up-to-date OpenAPI documentation after Splunk patch was merged
2 parents 6590f7c + b0271a3 commit 8623fca

2 files changed

Lines changed: 129 additions & 4 deletions

File tree

‎docs/openapi.json‎

Lines changed: 92 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3884,7 +3884,7 @@
38843884
"health"
38853885
],
38863886
"summary": "Readiness Probe Get Method",
3887-
"description": "Handle the readiness probe endpoint, returning service readiness.\n\nIf any provider reports an error status, responds with HTTP 503\nand details of unhealthy providers; otherwise, indicates the\nservice is ready.",
3887+
"description": "Handle the readiness probe endpoint, returning service readiness.\n\nIf any provider reports an error status, responds with HTTP 503\nand details of unhealthy providers; otherwise, indicates the\nservice is ready.\n\nReturns:\n ReadinessResponse: Object with `ready` indicating overall readiness,\n `reason` explaining the outcome, and `providers` containing the list of\n unhealthy ProviderHealthStatus entries (empty when ready).",
38883888
"operationId": "readiness_probe_get_method_readiness_get",
38893889
"responses": {
38903890
"200": {
@@ -4127,7 +4127,7 @@
41274127
"metrics"
41284128
],
41294129
"summary": "Metrics Endpoint Handler",
4130-
"description": "Handle request to the /metrics endpoint.\n\nProcess GET requests to the /metrics endpoint, returning the\nlatest Prometheus metrics in form of a plain text.\n\nInitializes model metrics on the first request if not already\nset up, then responds with the current metrics snapshot in\nPrometheus format.",
4130+
"description": "Handle request to the /metrics endpoint.\n\nProcess GET requests to the /metrics endpoint, returning the\nlatest Prometheus metrics in form of a plain text.\n\nInitializes model metrics on the first request if not already\nset up, then responds with the current metrics snapshot in\nPrometheus format.\n\nReturns:\n PlainTextResponse: Response body containing the Prometheus metrics text\n and the Prometheus content type.",
41314131
"operationId": "metrics_endpoint_handler_metrics_get",
41324132
"responses": {
41334133
"200": {
@@ -4290,7 +4290,7 @@
42904290
],
42914291
"summary": "Handle A2A Jsonrpc",
42924292
"description": "Handle A2A JSON-RPC requests following the A2A protocol specification.\n\nThis endpoint uses the DefaultRequestHandler from the A2A SDK to handle\nall JSON-RPC requests including message/send, message/stream, etc.\n\nThe A2A SDK application is created per-request to include authentication\ncontext while still leveraging FastAPI's authorization middleware.\n\nAutomatically detects streaming requests (message/stream JSON-RPC method)\nand returns a StreamingResponse to enable real-time chunk delivery.\n\nArgs:\n request: FastAPI request object\n auth: Authentication tuple\n mcp_headers: MCP headers for context propagation\n\nReturns:\n JSON-RPC response or streaming response",
4293-
"operationId": "handle_a2a_jsonrpc_a2a_post",
4293+
"operationId": "handle_a2a_jsonrpc_a2a_get",
42944294
"responses": {
42954295
"200": {
42964296
"description": "Successful Response",
@@ -4308,7 +4308,7 @@
43084308
],
43094309
"summary": "Handle A2A Jsonrpc",
43104310
"description": "Handle A2A JSON-RPC requests following the A2A protocol specification.\n\nThis endpoint uses the DefaultRequestHandler from the A2A SDK to handle\nall JSON-RPC requests including message/send, message/stream, etc.\n\nThe A2A SDK application is created per-request to include authentication\ncontext while still leveraging FastAPI's authorization middleware.\n\nAutomatically detects streaming requests (message/stream JSON-RPC method)\nand returns a StreamingResponse to enable real-time chunk delivery.\n\nArgs:\n request: FastAPI request object\n auth: Authentication tuple\n mcp_headers: MCP headers for context propagation\n\nReturns:\n JSON-RPC response or streaming response",
4311-
"operationId": "handle_a2a_jsonrpc_a2a_post",
4311+
"operationId": "handle_a2a_jsonrpc_a2a_get",
43124312
"responses": {
43134313
"200": {
43144314
"description": "Successful Response",
@@ -5538,6 +5538,24 @@
55385538
"type": "null"
55395539
}
55405540
]
5541+
},
5542+
"splunk": {
5543+
"anyOf": [
5544+
{
5545+
"$ref": "#/components/schemas/SplunkConfiguration"
5546+
},
5547+
{
5548+
"type": "null"
5549+
}
5550+
],
5551+
"title": "Splunk configuration",
5552+
"description": "Splunk HEC configuration for sending telemetry events."
5553+
},
5554+
"deployment_environment": {
5555+
"type": "string",
5556+
"title": "Deployment environment",
5557+
"description": "Deployment environment name (e.g., 'development', 'staging', 'production'). Used in telemetry events.",
5558+
"default": "development"
55415559
}
55425560
},
55435561
"additionalProperties": false,
@@ -8824,6 +8842,76 @@
88248842
}
88258843
]
88268844
},
8845+
"SplunkConfiguration": {
8846+
"properties": {
8847+
"enabled": {
8848+
"type": "boolean",
8849+
"title": "Enabled",
8850+
"description": "Enable or disable Splunk HEC integration.",
8851+
"default": false
8852+
},
8853+
"url": {
8854+
"anyOf": [
8855+
{
8856+
"type": "string"
8857+
},
8858+
{
8859+
"type": "null"
8860+
}
8861+
],
8862+
"title": "HEC URL",
8863+
"description": "Splunk HEC endpoint URL."
8864+
},
8865+
"token_path": {
8866+
"anyOf": [
8867+
{
8868+
"type": "string",
8869+
"format": "file-path"
8870+
},
8871+
{
8872+
"type": "null"
8873+
}
8874+
],
8875+
"title": "Token path",
8876+
"description": "Path to file containing the Splunk HEC authentication token."
8877+
},
8878+
"index": {
8879+
"anyOf": [
8880+
{
8881+
"type": "string"
8882+
},
8883+
{
8884+
"type": "null"
8885+
}
8886+
],
8887+
"title": "Index",
8888+
"description": "Target Splunk index for events."
8889+
},
8890+
"source": {
8891+
"type": "string",
8892+
"title": "Source",
8893+
"description": "Event source identifier.",
8894+
"default": "lightspeed-stack"
8895+
},
8896+
"timeout": {
8897+
"type": "integer",
8898+
"exclusiveMinimum": 0.0,
8899+
"title": "Timeout",
8900+
"description": "HTTP timeout in seconds for HEC requests.",
8901+
"default": 5
8902+
},
8903+
"verify_ssl": {
8904+
"type": "boolean",
8905+
"title": "Verify SSL",
8906+
"description": "Whether to verify SSL certificates for HEC endpoint.",
8907+
"default": true
8908+
}
8909+
},
8910+
"additionalProperties": false,
8911+
"type": "object",
8912+
"title": "SplunkConfiguration",
8913+
"description": "Splunk HEC (HTTP Event Collector) configuration.\n\nSplunk HEC allows sending events directly to Splunk over HTTP/HTTPS.\nThis configuration is used to send telemetry events for inference\nrequests to the corporate Splunk deployment.\n\nUseful resources:\n\n - [Splunk HEC Docs](https://docs.splunk.com/Documentation/SplunkCloud)\n - [About HEC](https://docs.splunk.com/Documentation/Splunk/latest/Data)"
8914+
},
88278915
"StatusResponse": {
88288916
"properties": {
88298917
"functionality": {

‎docs/openapi.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3425,6 +3425,11 @@ If any provider reports an error status, responds with HTTP 503
34253425
and details of unhealthy providers; otherwise, indicates the
34263426
service is ready.
34273427

3428+
Returns:
3429+
ReadinessResponse: Object with `ready` indicating overall readiness,
3430+
`reason` explaining the outcome, and `providers` containing the list of
3431+
unhealthy ProviderHealthStatus entries (empty when ready).
3432+
34283433

34293434

34303435

@@ -3643,6 +3648,10 @@ Initializes model metrics on the first request if not already
36433648
set up, then responds with the current metrics snapshot in
36443649
Prometheus format.
36453650

3651+
Returns:
3652+
PlainTextResponse: Response body containing the Prometheus metrics text
3653+
and the Prometheus content type.
3654+
36463655

36473656

36483657

@@ -4239,6 +4248,8 @@ Global service configuration.
42394248
| a2a_state | | Configuration for A2A protocol persistent state storage. |
42404249
| quota_handlers | | Quota handlers configuration |
42414250
| azure_entra_id | | |
4251+
| splunk | | Splunk HEC configuration for sending telemetry events. |
4252+
| deployment_environment | string | Deployment environment name (e.g., 'development', 'staging', 'production'). Used in telemetry events. |
42424253

42434254

42444255
## ConfigurationResponse
@@ -5524,6 +5535,32 @@ Model representing a response to shields request.
55245535
| shields | array | List of shields available |
55255536

55265537

5538+
## SplunkConfiguration
5539+
5540+
5541+
Splunk HEC (HTTP Event Collector) configuration.
5542+
5543+
Splunk HEC allows sending events directly to Splunk over HTTP/HTTPS.
5544+
This configuration is used to send telemetry events for inference
5545+
requests to the corporate Splunk deployment.
5546+
5547+
Useful resources:
5548+
5549+
- [Splunk HEC Docs](https://docs.splunk.com/Documentation/SplunkCloud)
5550+
- [About HEC](https://docs.splunk.com/Documentation/Splunk/latest/Data)
5551+
5552+
5553+
| Field | Type | Description |
5554+
|-------|------|-------------|
5555+
| enabled | boolean | Enable or disable Splunk HEC integration. |
5556+
| url | | Splunk HEC endpoint URL. |
5557+
| token_path | | Path to file containing the Splunk HEC authentication token. |
5558+
| index | | Target Splunk index for events. |
5559+
| source | string | Event source identifier. |
5560+
| timeout | integer | HTTP timeout in seconds for HEC requests. |
5561+
| verify_ssl | boolean | Whether to verify SSL certificates for HEC endpoint. |
5562+
5563+
55275564
## StatusResponse
55285565

55295566

0 commit comments

Comments
 (0)