Skip to content

Commit 883f832

Browse files
tisniktisnik
authored
Merge pull request #153 from onmete/update-schema
LCORE-285: Update openapi.json
2 parents e813395 + 6536786 commit 883f832

1 file changed

Lines changed: 132 additions & 29 deletions

File tree

‎docs/openapi.json‎

Lines changed: 132 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@
150150
"health"
151151
],
152152
"summary": "Readiness Probe Get Method",
153-
"description": "Ready status of service.",
153+
"description": "Ready status of service with provider health details.",
154154
"operationId": "readiness_probe_get_method_v1_readiness_get",
155155
"responses": {
156156
"200": {
@@ -168,7 +168,7 @@
168168
"content": {
169169
"application/json": {
170170
"schema": {
171-
"$ref": "#/components/schemas/NotAvailableResponse"
171+
"$ref": "#/components/schemas/ReadinessResponse"
172172
}
173173
}
174174
}
@@ -358,6 +358,14 @@
358358
},
359359
"user_data_collection": {
360360
"$ref": "#/components/schemas/UserDataCollection"
361+
},
362+
"mcp_servers": {
363+
"items": {
364+
"$ref": "#/components/schemas/ModelContextProtocolServer"
365+
},
366+
"type": "array",
367+
"title": "Mcp Servers",
368+
"default": []
361369
}
362370
},
363371
"type": "object",
@@ -557,6 +565,30 @@
557565
}
558566
]
559567
},
568+
"ModelContextProtocolServer": {
569+
"properties": {
570+
"name": {
571+
"type": "string",
572+
"title": "Name"
573+
},
574+
"provider_id": {
575+
"type": "string",
576+
"title": "Provider Id",
577+
"default": "model-context-protocol"
578+
},
579+
"url": {
580+
"type": "string",
581+
"title": "Url"
582+
}
583+
},
584+
"type": "object",
585+
"required": [
586+
"name",
587+
"url"
588+
],
589+
"title": "ModelContextProtocolServer",
590+
"description": "model context protocol server configuration."
591+
},
560592
"ModelsResponse": {
561593
"properties": {
562594
"models": {
@@ -575,36 +607,35 @@
575607
"title": "ModelsResponse",
576608
"description": "Model representing a response to models request."
577609
},
578-
"NotAvailableResponse": {
610+
"ProviderHealthStatus": {
579611
"properties": {
580-
"detail": {
581-
"additionalProperties": {
582-
"type": "string"
583-
},
584-
"type": "object",
585-
"title": "Detail"
612+
"provider_id": {
613+
"type": "string",
614+
"title": "Provider Id"
615+
},
616+
"status": {
617+
"type": "string",
618+
"title": "Status"
619+
},
620+
"message": {
621+
"anyOf": [
622+
{
623+
"type": "string"
624+
},
625+
{
626+
"type": "null"
627+
}
628+
],
629+
"title": "Message"
586630
}
587631
},
588632
"type": "object",
589633
"required": [
590-
"detail"
634+
"provider_id",
635+
"status"
591636
],
592-
"title": "NotAvailableResponse",
593-
"description": "Model representing error response for readiness endpoint.",
594-
"examples": [
595-
{
596-
"detail": {
597-
"cause": "Index is not ready",
598-
"response": "Service is not ready"
599-
}
600-
},
601-
{
602-
"detail": {
603-
"cause": "LLM is not ready",
604-
"response": "Service is not ready"
605-
}
606-
}
607-
]
637+
"title": "ProviderHealthStatus",
638+
"description": "Model representing the health status of a provider.\n\nAttributes:\n provider_id: The ID of the provider.\n status: The health status ('ok', 'unhealthy', 'not_implemented').\n message: Optional message about the health status."
608639
},
609640
"QueryRequest": {
610641
"properties": {
@@ -745,19 +776,28 @@
745776
"reason": {
746777
"type": "string",
747778
"title": "Reason"
779+
},
780+
"providers": {
781+
"items": {
782+
"$ref": "#/components/schemas/ProviderHealthStatus"
783+
},
784+
"type": "array",
785+
"title": "Providers"
748786
}
749787
},
750788
"type": "object",
751789
"required": [
752790
"ready",
753-
"reason"
791+
"reason",
792+
"providers"
754793
],
755794
"title": "ReadinessResponse",
756-
"description": "Model representing a response to a readiness request.\n\nAttributes:\n ready: The readiness of the service.\n reason: The reason for the readiness.\n\nExample:\n ```python\n readiness_response = ReadinessResponse(ready=True, reason=\"service is ready\")\n ```",
795+
"description": "Model representing response to a readiness request.\n\nAttributes:\n ready: If service is ready.\n reason: The reason for the readiness.\n providers: List of unhealthy providers in case of readiness failure.\n\nExample:\n ```python\n readiness_response = ReadinessResponse(\n ready=False,\n reason=\"Service is not ready\",\n providers=[\n ProviderHealthStatus(\n provider_id=\"ollama\",\n status=\"Error\",\n message=\"Server is unavailable\"\n )\n ]\n )\n ```",
757796
"examples": [
758797
{
798+
"providers": [],
759799
"ready": true,
760-
"reason": "service is ready"
800+
"reason": "Service is ready"
761801
}
762802
]
763803
},
@@ -792,6 +832,10 @@
792832
"type": "boolean",
793833
"title": "Access Log",
794834
"default": true
835+
},
836+
"tls_config": {
837+
"$ref": "#/components/schemas/TLSConfiguration",
838+
"default": {}
795839
}
796840
},
797841
"type": "object",
@@ -826,6 +870,49 @@
826870
}
827871
]
828872
},
873+
"TLSConfiguration": {
874+
"properties": {
875+
"tls_certificate_path": {
876+
"anyOf": [
877+
{
878+
"type": "string",
879+
"format": "file-path"
880+
},
881+
{
882+
"type": "null"
883+
}
884+
],
885+
"title": "Tls Certificate Path"
886+
},
887+
"tls_key_path": {
888+
"anyOf": [
889+
{
890+
"type": "string",
891+
"format": "file-path"
892+
},
893+
{
894+
"type": "null"
895+
}
896+
],
897+
"title": "Tls Key Path"
898+
},
899+
"tls_key_password": {
900+
"anyOf": [
901+
{
902+
"type": "string",
903+
"format": "file-path"
904+
},
905+
{
906+
"type": "null"
907+
}
908+
],
909+
"title": "Tls Key Password"
910+
}
911+
},
912+
"type": "object",
913+
"title": "TLSConfiguration",
914+
"description": "TLS configuration."
915+
},
829916
"UserDataCollection": {
830917
"properties": {
831918
"feedback_disabled": {
@@ -843,6 +930,22 @@
843930
}
844931
],
845932
"title": "Feedback Storage"
933+
},
934+
"transcripts_disabled": {
935+
"type": "boolean",
936+
"title": "Transcripts Disabled",
937+
"default": true
938+
},
939+
"transcripts_storage": {
940+
"anyOf": [
941+
{
942+
"type": "string"
943+
},
944+
{
945+
"type": "null"
946+
}
947+
],
948+
"title": "Transcripts Storage"
846949
}
847950
},
848951
"type": "object",

0 commit comments

Comments
 (0)