Skip to main content

ServiceEntrySchema

The ServiceEntrySchema represents the configuration and status of a service in the ConfidentialMind system.

Properties

PropertyTypeDescription
idstringUnique identifier for the service
typeServiceTypeThe type of the service
deployment_stateDeploymentStateCurrent deployment state of the service
display_namestring | nullOptional display name for the service
metadataMetadataSchema | nullOptional metadata for the service
configobject | nullOptional configuration object for the service
config_schemaobject | nullOptional schema for the configuration
connectorsConnectorsConfig | nullOptional connectors configuration

Enums

ServiceType

  • playground
  • api
  • model
  • external_llm
  • database
  • bucket
  • external_database
  • frontend

DeploymentState

  • not_deployed
  • starting
  • stopping
  • deployed
  • error

Example

{
"id": "service-123",
"type": "api",
"deployment_state": "deployed",
"display_name": "My API Service",
"metadata": {
"deployment_image": "myimage",
"deployment_image_version": "1.0.0",
"chart_version": "0.1.0",
"overwrite_values": {
"replicaCount": 3
}
},
"config": {
"api_key": "secret-key"
},
"config_schema": {
"type": "object",
"properties": {
"api_key": { "type": "string" }
}
},
"connectors": {
"connectors": [
{
"type": "database",
"label": "Main Database",
"config_id": "db-001",
"stack_id": null
}
]
}
}

This schema is used in various endpoints of the ConfidentialMind Manager API, including GET, POST, and PATCH operations on services.