wy_qcos.api.schemas package

Submodules

wy_qcos.api.schemas.auth module

pydantic model wy_qcos.api.schemas.auth.LoginRequest

基类：BaseModel

Login request schema.

Show JSON schema
{
   "title": "LoginRequest",
   "description": "Login request schema.",
   "type": "object",
   "properties": {
      "username": {
         "description": "Username for authentication",
         "maxLength": 64,
         "minLength": 2,
         "title": "Username",
         "type": "string"
      },
      "password": {
         "description": "Password for authentication",
         "is_sensitive": true,
         "maxLength": 32,
         "minLength": 6,
         "title": "Password",
         "type": "string"
      }
   },
   "required": [
      "username",
      "password"
   ]
}

Fields:
field username: str [Required]

Username for authentication

Constraints:

  • min_length = 2

  • max_length = 64

field password: str [Required]

Password for authentication

Constraints:

  • min_length = 6

  • max_length = 32

pydantic model wy_qcos.api.schemas.auth.LoginResponse

基类：BaseModel

Login response schema.

Show JSON schema
{
   "title": "LoginResponse",
   "description": "Login response schema.",
   "type": "object",
   "properties": {
      "user_name": {
         "description": "User name",
         "title": "User Name",
         "type": "string"
      },
      "access_token": {
         "description": "JWT access token",
         "title": "Access Token",
         "type": "string"
      },
      "refresh_token": {
         "description": "JWT refresh token",
         "title": "Refresh Token",
         "type": "string"
      },
      "token_type": {
         "default": "bearer",
         "description": "Token type",
         "title": "Token Type",
         "type": "string"
      },
      "expires_in": {
         "description": "Access token expiration time in seconds",
         "title": "Expires In",
         "type": "integer"
      },
      "refresh_expires_in": {
         "description": "Refresh token expiration time in seconds",
         "title": "Refresh Expires In",
         "type": "integer"
      }
   },
   "required": [
      "user_name",
      "access_token",
      "refresh_token",
      "expires_in",
      "refresh_expires_in"
   ]
}

Fields:
field user_name: str [Required]

User name

field access_token: str [Required]

JWT access token

field refresh_token: str [Required]

JWT refresh token

field token_type: str = 'bearer'

Token type

field expires_in: int [Required]

Access token expiration time in seconds

field refresh_expires_in: int [Required]

Refresh token expiration time in seconds

pydantic model wy_qcos.api.schemas.auth.LogoutRequest

基类：BaseModel

Logout request schema.

Show JSON schema
{
   "title": "LogoutRequest",
   "description": "Logout request schema.",
   "type": "object",
   "properties": {}
}

pydantic model wy_qcos.api.schemas.auth.LogoutResponse

基类：BaseModel

Logout response schema.

Show JSON schema
{
   "title": "LogoutResponse",
   "description": "Logout response schema.",
   "type": "object",
   "properties": {
      "message": {
         "description": "Logout confirmation message",
         "title": "Message",
         "type": "string"
      }
   },
   "required": [
      "message"
   ]
}

Fields:
field message: str [Required]

Logout confirmation message

pydantic model wy_qcos.api.schemas.auth.TokenRefreshRequest

基类：BaseModel

Token refresh request schema.

Show JSON schema
{
   "title": "TokenRefreshRequest",
   "description": "Token refresh request schema.",
   "type": "object",
   "properties": {
      "refresh_token": {
         "description": "JWT refresh token",
         "is_sensitive": true,
         "title": "Refresh Token",
         "type": "string"
      }
   },
   "required": [
      "refresh_token"
   ]
}

Fields:
field refresh_token: str [Required]

JWT refresh token

pydantic model wy_qcos.api.schemas.auth.TokenRefreshResponse

基类：BaseModel

Token refresh response schema.

Show JSON schema
{
   "title": "TokenRefreshResponse",
   "description": "Token refresh response schema.",
   "type": "object",
   "properties": {
      "user_name": {
         "description": "User name",
         "title": "User Name",
         "type": "string"
      },
      "access_token": {
         "description": "New JWT access token",
         "title": "Access Token",
         "type": "string"
      },
      "refresh_token": {
         "description": "New JWT refresh token",
         "title": "Refresh Token",
         "type": "string"
      },
      "token_type": {
         "default": "bearer",
         "description": "Token type",
         "title": "Token Type",
         "type": "string"
      },
      "expires_in": {
         "description": "Access token expiration time in seconds",
         "title": "Expires In",
         "type": "integer"
      },
      "refresh_expires_in": {
         "description": "Refresh token expiration time in seconds",
         "title": "Refresh Expires In",
         "type": "integer"
      }
   },
   "required": [
      "user_name",
      "access_token",
      "refresh_token",
      "expires_in",
      "refresh_expires_in"
   ]
}

Fields:
field user_name: str [Required]

User name

field access_token: str [Required]

New JWT access token

field refresh_token: str [Required]

New JWT refresh token

field token_type: str = 'bearer'

Token type

field expires_in: int [Required]

Access token expiration time in seconds

field refresh_expires_in: int [Required]

Refresh token expiration time in seconds

wy_qcos.api.schemas.device module

pydantic model wy_qcos.api.schemas.device.GetDevicesRequest

基类：BaseModel

Get Devices Request.

Pydantic Model for Get Devices Request.

Show JSON schema
{
   "title": "GetDevicesRequest",
   "description": "Get Devices Request.\n\nPydantic Model for Get Devices Request.",
   "type": "object",
   "properties": {}
}

pydantic model wy_qcos.api.schemas.device.GetDeviceRequest

基类：BaseModel

Get Device Request.

Pydantic Model for Get Device Request.

Show JSON schema
{
   "title": "GetDeviceRequest",
   "description": "Get Device Request.\n\nPydantic Model for Get Device Request.",
   "type": "object",
   "properties": {
      "name": {
         "description": "Device name",
         "title": "Name",
         "type": "string"
      },
      "details": {
         "description": "Details info needed or not",
         "title": "Details",
         "type": "boolean"
      }
   },
   "required": [
      "name",
      "details"
   ]
}

Fields:
field name: str [Required]

Device name

field details: bool [Required]

Details info needed or not

pydantic model wy_qcos.api.schemas.device.GetDeviceResponse

基类：BaseModel

Get Device Response.

Pydantic Model for Get Device Response.

Show JSON schema
{
   "title": "GetDeviceResponse",
   "description": "Get Device Response.\n\nPydantic Model for Get Device Response.",
   "type": "object",
   "properties": {
      "name": {
         "description": "Device name",
         "title": "Name",
         "type": "string"
      },
      "alias_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Device alias name",
         "title": "Alias Name"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Description",
         "title": "Description"
      },
      "driver_name": {
         "description": "Driver name",
         "title": "Driver Name",
         "type": "string"
      },
      "enable": {
         "description": "Device enable status",
         "title": "Enable",
         "type": "boolean"
      },
      "status": {
         "description": "Device status",
         "title": "Status",
         "type": "string"
      },
      "timestamp": {
         "description": "Device status timestamp",
         "title": "Timestamp",
         "type": "string"
      },
      "tech_type": {
         "description": "Technology type",
         "title": "Tech Type",
         "type": "string"
      },
      "max_qubits": {
         "description": "Maximum number of qubits",
         "title": "Max Qubits",
         "type": "integer"
      },
      "configs": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Device configurations",
         "title": "Configs"
      },
      "details": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Details info",
         "title": "Details"
      }
   },
   "required": [
      "name",
      "driver_name",
      "enable",
      "status",
      "timestamp",
      "tech_type",
      "max_qubits"
   ]
}

Fields:
field name: str [Required]

Device name

field alias_name: str | None = None

Device alias name

field description: str | None = None

Description

field driver_name: str [Required]

Driver name

field enable: bool [Required]

Device enable status

field status: str [Required]

Device status

field timestamp: str [Required]

Device status timestamp

field tech_type: str [Required]

Technology type

field max_qubits: int [Required]

Maximum number of qubits

field configs: dict | None = None

Device configurations

field details: dict | None = None

Details info

pydantic model wy_qcos.api.schemas.device.CalibrateDeviceRequest

基类：BaseModel

Calibrate Device.

Pydantic Model for Get Calibrate Device.

Show JSON schema
{
   "title": "CalibrateDeviceRequest",
   "description": "Calibrate Device.\n\nPydantic Model for Get Calibrate Device.",
   "type": "object",
   "properties": {
      "device_name": {
         "description": "Device name",
         "title": "Device Name",
         "type": "string"
      },
      "method": {
         "description": "method name",
         "title": "Method",
         "type": "string"
      },
      "options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Calibrate Options",
         "title": "Options"
      }
   },
   "required": [
      "device_name",
      "method"
   ]
}

Fields:
field device_name: str [Required]

Device name

field method: str [Required]

method name

field options: dict | None = None

Calibrate Options

pydantic model wy_qcos.api.schemas.device.CalibrateDeviceResponse

基类：BaseModel

Get Calibrate Device Response.

Pydantic Model for Get Calibrate Device Response.

Show JSON schema
{
   "title": "CalibrateDeviceResponse",
   "description": "Get Calibrate Device Response.\n\nPydantic Model for Get Calibrate Device Response.",
   "type": "object",
   "properties": {
      "details": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Calibrate Response details",
         "title": "Details"
      }
   }
}

Fields:
field details: dict | None = None

Calibrate Response details

pydantic model wy_qcos.api.schemas.device.GetCalibrateResultRequest

基类：BaseModel

Get Calibrate Result Request.

Pydantic Model for Get Calibrate Result.

Show JSON schema
{
   "title": "GetCalibrateResultRequest",
   "description": "Get Calibrate Result Request.\n\nPydantic Model for Get Calibrate Result.",
   "type": "object",
   "properties": {
      "device_name": {
         "description": "Device name",
         "title": "Device Name",
         "type": "string"
      },
      "method": {
         "description": "method name",
         "title": "Method",
         "type": "string"
      }
   },
   "required": [
      "device_name",
      "method"
   ]
}

Fields:
field device_name: str [Required]

Device name

field method: str [Required]

method name

pydantic model wy_qcos.api.schemas.device.GetCalibrateResultResponse

基类：BaseModel

Get Calibrate Result Response.

Pydantic Model for Get Calibrate Result.

Show JSON schema
{
   "title": "GetCalibrateResultResponse",
   "description": "Get Calibrate Result Response.\n\nPydantic Model for Get Calibrate Result.",
   "type": "object",
   "properties": {
      "details": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Calibrate Response details",
         "title": "Details"
      }
   }
}

Fields:
field details: dict | None = None

Calibrate Response details

pydantic model wy_qcos.api.schemas.device.SetDeviceOptionsRequest

基类：BaseModel

Set Device Options.

Pydantic Model for Set Device Options.

Show JSON schema
{
   "title": "SetDeviceOptionsRequest",
   "description": "Set Device Options.\n\nPydantic Model for Set Device Options.",
   "type": "object",
   "properties": {
      "device_name": {
         "description": "Device name",
         "title": "Device Name",
         "type": "string"
      },
      "method": {
         "description": "method name",
         "title": "Method",
         "type": "string"
      },
      "options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Device Options",
         "title": "Options"
      }
   },
   "required": [
      "device_name",
      "method"
   ]
}

Fields:
field device_name: str [Required]

Device name

field method: str [Required]

method name

field options: dict | None = None

Device Options

pydantic model wy_qcos.api.schemas.device.SetDeviceOptionsResponse

基类：BaseModel

Set Device Options Response.

Pydantic Model for Set Device Options Response.

Show JSON schema
{
   "title": "SetDeviceOptionsResponse",
   "description": "Set Device Options Response.\n\nPydantic Model for Set Device Options Response.",
   "type": "object",
   "properties": {
      "details": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Set Device Options Response details",
         "title": "Details"
      }
   }
}

Fields:
field details: dict | None = None

Set Device Options Response details

pydantic model wy_qcos.api.schemas.device.GetDeviceOptionsRequest

基类：BaseModel

Get Device Options Request.

Pydantic Model for Get Device Options Request.

Show JSON schema
{
   "title": "GetDeviceOptionsRequest",
   "description": "Get Device Options Request.\n\nPydantic Model for Get Device Options Request.",
   "type": "object",
   "properties": {
      "device_name": {
         "description": "Device name",
         "title": "Device Name",
         "type": "string"
      },
      "method": {
         "description": "method name",
         "title": "Method",
         "type": "string"
      }
   },
   "required": [
      "device_name",
      "method"
   ]
}

Fields:
field device_name: str [Required]

Device name

field method: str [Required]

method name

pydantic model wy_qcos.api.schemas.device.GetDeviceOptionsResponse

基类：BaseModel

Get Device Options Response.

Pydantic Model for Get Device Options Response.

Show JSON schema
{
   "title": "GetDeviceOptionsResponse",
   "description": "Get Device Options Response.\n\nPydantic Model for Get Device Options Response.",
   "type": "object",
   "properties": {
      "details": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Get Device Options Response details",
         "title": "Details"
      }
   }
}

Fields:
field details: dict | None = None

Get Device Options Response details

wy_qcos.api.schemas.driver module

pydantic model wy_qcos.api.schemas.driver.GetDriversRequest

基类：BaseModel

Get Drivers Request.

Pydantic Model for Get Drivers Request.

Show JSON schema
{
   "title": "GetDriversRequest",
   "description": "Get Drivers Request.\n\nPydantic Model for Get Drivers Request.",
   "type": "object",
   "properties": {}
}

pydantic model wy_qcos.api.schemas.driver.GetDriverRequest

基类：BaseModel

Get Driver Request.

Pydantic Model for Get Driver Request.

Show JSON schema
{
   "title": "GetDriverRequest",
   "description": "Get Driver Request.\n\nPydantic Model for Get Driver Request.",
   "type": "object",
   "properties": {
      "name": {
         "description": "Driver name",
         "title": "Name",
         "type": "string"
      }
   },
   "required": [
      "name"
   ]
}

Fields:
field name: str [Required]

Driver name

pydantic model wy_qcos.api.schemas.driver.GetDriverResponse

基类：BaseModel

Get Driver Response.

Pydantic Model for Get Driver Response.

Show JSON schema
{
   "title": "GetDriverResponse",
   "description": "Get Driver Response.\n\nPydantic Model for Get Driver Response.",
   "type": "object",
   "properties": {
      "name": {
         "description": "Driver name",
         "title": "Name",
         "type": "string"
      },
      "alias_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Driver alias name",
         "title": "Alias Name"
      },
      "version": {
         "description": "Driver version",
         "title": "Version",
         "type": "string"
      },
      "description": {
         "description": "Driver description",
         "title": "Description",
         "type": "string"
      },
      "tech_type": {
         "description": "Technology type",
         "title": "Tech Type",
         "type": "string"
      },
      "max_qubits": {
         "description": "Maximum number of qubits",
         "title": "Max Qubits",
         "type": "integer"
      },
      "transpiler": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Transpiler",
         "title": "Transpiler"
      },
      "supported_transpilers": {
         "description": "Supported transpilers",
         "items": {},
         "title": "Supported Transpilers",
         "type": "array"
      },
      "enable_circuit_aggregation": {
         "description": "Enable circuit aggregation",
         "title": "Enable Circuit Aggregation",
         "type": "boolean"
      },
      "supported_code_types": {
         "description": "Supported code types",
         "items": {},
         "title": "Supported Code Types",
         "type": "array"
      },
      "supported_basis_gates": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Supported basis gates",
         "title": "Supported Basis Gates"
      },
      "results_fetch_mode": {
         "description": "Results fetch mode",
         "title": "Results Fetch Mode",
         "type": "string"
      }
   },
   "required": [
      "name",
      "version",
      "description",
      "tech_type",
      "max_qubits",
      "supported_transpilers",
      "enable_circuit_aggregation",
      "supported_code_types",
      "results_fetch_mode"
   ]
}

Fields:
field name: str [Required]

Driver name

field alias_name: str | None = None

Driver alias name

field version: str [Required]

Driver version

field description: str [Required]

Driver description

field tech_type: str [Required]

Technology type

field max_qubits: int [Required]

Maximum number of qubits

field transpiler: str | None = None

Transpiler

field supported_transpilers: list [Required]

Supported transpilers

field enable_circuit_aggregation: bool [Required]

Enable circuit aggregation

field supported_code_types: list [Required]

Supported code types

field supported_basis_gates: list | None = None

Supported basis gates

field results_fetch_mode: str [Required]

Results fetch mode

wy_qcos.api.schemas.job module

pydantic model wy_qcos.api.schemas.job.SubmitJobRequest

基类：BaseModel

Submit Job Request.

Pydantic Model for Submit Job Request.

Show JSON schema
{
   "title": "SubmitJobRequest",
   "description": "Submit Job Request.\n\nPydantic Model for Submit Job Request.",
   "type": "object",
   "properties": {
      "code_type": {
         "default": "qasm",
         "description": "Code types: qasm, qasm2, qasm3, qubo",
         "title": "Code Type",
         "type": "string"
      },
      "source_code": {
         "default": [],
         "description": "Source code list",
         "items": {},
         "title": "Source Code",
         "type": "array"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Job description",
         "title": "Description"
      },
      "backend": {
         "default": "dummy",
         "description": "Backend device name",
         "title": "Backend",
         "type": "string"
      },
      "driver_options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Driver options",
         "title": "Driver Options"
      },
      "transpiler": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Transpiler",
         "title": "Transpiler"
      },
      "transpiler_options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Transpiler options",
         "title": "Transpiler Options"
      },
      "circuit_aggregation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Circuit aggregation: internal, multi",
         "title": "Circuit Aggregation"
      },
      "job_id": {
         "anyOf": [
            {
               "format": "uuid",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Job ID",
         "title": "Job Id"
      },
      "job_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Job name",
         "title": "Job Name"
      },
      "job_type": {
         "default": "sampling",
         "description": "Job type",
         "title": "Job Type",
         "type": "string"
      },
      "job_priority": {
         "default": 5,
         "description": "Job priority. Values: 1-10, Default: 5. Highest priority: 1, Lowest Priority: 10",
         "title": "Job Priority",
         "type": "integer"
      },
      "profiling": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Profiling",
         "title": "Profiling"
      },
      "shots": {
         "default": 1,
         "description": "Shots",
         "title": "Shots",
         "type": "integer"
      },
      "callbacks": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Callbacks",
         "title": "Callbacks"
      },
      "dry_run": {
         "default": false,
         "description": "Dry-run flag",
         "title": "Dry Run",
         "type": "boolean"
      },
      "creation_date": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Creation date",
         "title": "Creation Date"
      }
   }
}

Fields:
field code_type: str = 'qasm'

Code types: qasm, qasm2, qasm3, qubo

field source_code: list = []

Source code list

field description: str | None = None

Job description

field backend: str = 'dummy'

Backend device name

field driver_options: dict | None = None

Driver options

field transpiler: str | None = None

Transpiler

field transpiler_options: dict | None = None

Transpiler options

field circuit_aggregation: str | None = None

Circuit aggregation: internal, multi

field job_id: UUID | None = None

Job ID

field job_name: str | None = None

Job name

field job_type: str = 'sampling'

Job type

field job_priority: int = 5

Job priority. Values: 1-10, Default: 5. Highest priority: 1, Lowest Priority: 10

field profiling: list | None = None

Profiling

field shots: int = 1

Shots

field callbacks: list | None = None

Callbacks

field dry_run: bool = False

Dry-run flag

field creation_date: datetime | None = None

Creation date

pydantic model wy_qcos.api.schemas.job.SubmitJobResponse

基类：BaseModel

Submit Job Response.

Pydantic Model for Submit Job Response.

Show JSON schema
{
   "title": "SubmitJobResponse",
   "description": "Submit Job Response.\n\nPydantic Model for Submit Job Response.",
   "type": "object",
   "properties": {
      "job_id": {
         "description": "Job ID",
         "format": "uuid",
         "title": "Job Id",
         "type": "string"
      },
      "job_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Job name",
         "title": "Job Name"
      },
      "job_type": {
         "description": "Job type",
         "title": "Job Type",
         "type": "string"
      },
      "job_status": {
         "description": "Job status",
         "title": "Job Status",
         "type": "string"
      },
      "job_priority": {
         "default": 5,
         "description": "Job priority. Values: 1-10, Default: 5. Highest priority: 1, Lowest Priority: 10",
         "title": "Job Priority",
         "type": "integer"
      },
      "code_type": {
         "description": "Code type",
         "title": "Code Type",
         "type": "string"
      },
      "source_code": {
         "description": "Source code list",
         "items": {},
         "title": "Source Code",
         "type": "array"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Description",
         "title": "Description"
      },
      "backend": {
         "description": "Backend device name",
         "title": "Backend",
         "type": "string"
      },
      "driver_options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Driver options",
         "title": "Driver Options"
      },
      "transpiler": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Transpiler",
         "title": "Transpiler"
      },
      "transpiler_options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Transpiler options",
         "title": "Transpiler Options"
      },
      "circuit_aggregation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Circuit aggregation: internal, multi",
         "title": "Circuit Aggregation"
      },
      "shots": {
         "description": "Shots",
         "title": "Shots",
         "type": "integer"
      },
      "profiling": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Profiling",
         "title": "Profiling"
      },
      "dry_run": {
         "description": "Dry-run flag",
         "title": "Dry Run",
         "type": "boolean"
      },
      "callbacks": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Callbacks",
         "title": "Callbacks"
      },
      "creation_date": {
         "description": "Creation date",
         "format": "date-time",
         "title": "Creation Date",
         "type": "string"
      },
      "end_date": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "End date",
         "title": "End Date"
      }
   },
   "required": [
      "job_id",
      "job_type",
      "job_status",
      "code_type",
      "source_code",
      "backend",
      "shots",
      "dry_run",
      "creation_date"
   ]
}

Fields:
field job_id: UUID [Required]

Job ID

field job_name: str | None = None

Job name

field job_type: str [Required]

Job type

field job_status: str [Required]

Job status

field job_priority: int = 5

Job priority. Values: 1-10, Default: 5. Highest priority: 1, Lowest Priority: 10

field code_type: str [Required]

Code type

field source_code: list [Required]

Source code list

field description: str | None = None

Description

field backend: str [Required]

Backend device name

field driver_options: dict | None = None

Driver options

field transpiler: str | None = None

Transpiler

field transpiler_options: dict | None = None

Transpiler options

field circuit_aggregation: str | None = None

Circuit aggregation: internal, multi

field shots: int [Required]

Shots

field profiling: list | None = None

Profiling

field dry_run: bool [Required]

Dry-run flag

field callbacks: list | None = None

Callbacks

field creation_date: datetime [Required]

Creation date

field end_date: datetime | None = None

End date

pydantic model wy_qcos.api.schemas.job.GetJobStatusRequest

基类：BaseModel

Get Job Status Request.

Pydantic Model for Get Job Status Request.

Show JSON schema
{
   "title": "GetJobStatusRequest",
   "description": "Get Job Status Request.\n\nPydantic Model for Get Job Status Request.",
   "type": "object",
   "properties": {
      "job_id": {
         "description": "Job ID",
         "format": "uuid",
         "title": "Job Id",
         "type": "string"
      }
   },
   "required": [
      "job_id"
   ]
}

Fields:
field job_id: UUID [Required]

Job ID

pydantic model wy_qcos.api.schemas.job.GetJobStatusResponse

基类：BaseModel

Get Job Status Response.

Pydantic Model for Get Job Status Response.

Show JSON schema
{
   "title": "GetJobStatusResponse",
   "description": "Get Job Status Response.\n\nPydantic Model for Get Job Status Response.",
   "type": "object",
   "properties": {
      "job_id": {
         "description": "Job ID",
         "format": "uuid",
         "title": "Job Id",
         "type": "string"
      },
      "job_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Job name",
         "title": "Job Name"
      },
      "job_status": {
         "description": "Job status",
         "title": "Job Status",
         "type": "string"
      },
      "job_priority": {
         "default": 5,
         "description": "Job priority. Values: 1-10, Default: 5. Highest priority: 1, Lowest Priority: 10",
         "title": "Job Priority",
         "type": "integer"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Description",
         "title": "Description"
      },
      "backend": {
         "description": "Backend device name",
         "title": "Backend",
         "type": "string"
      },
      "driver_options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Driver options",
         "title": "Driver Options"
      },
      "transpiler": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Transpiler",
         "title": "Transpiler"
      },
      "transpiler_options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Transpiler options",
         "title": "Transpiler Options"
      },
      "circuit_aggregation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Circuit aggregation: internal, multi",
         "title": "Circuit Aggregation"
      },
      "shots": {
         "description": "Shots",
         "title": "Shots",
         "type": "integer"
      },
      "dry_run": {
         "description": "Dry-run flag",
         "title": "Dry Run",
         "type": "boolean"
      },
      "progress": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -1,
         "description": "Progress",
         "title": "Progress"
      },
      "creation_date": {
         "description": "Creation date",
         "format": "date-time",
         "title": "Creation Date",
         "type": "string"
      },
      "end_date": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "End date",
         "title": "End Date"
      }
   },
   "required": [
      "job_id",
      "job_status",
      "backend",
      "shots",
      "dry_run",
      "creation_date"
   ]
}

Fields:
field job_id: UUID [Required]

Job ID

field job_name: str | None = None

Job name

field job_status: str [Required]

Job status

field job_priority: int = 5

Job priority. Values: 1-10, Default: 5. Highest priority: 1, Lowest Priority: 10

field description: str | None = None

Description

field backend: str [Required]

Backend device name

field driver_options: dict | None = None

Driver options

field transpiler: str | None = None

Transpiler

field transpiler_options: dict | None = None

Transpiler options

field circuit_aggregation: str | None = None

Circuit aggregation: internal, multi

field shots: int [Required]

Shots

field dry_run: bool [Required]

Dry-run flag

field progress: int | None = -1

Progress

field creation_date: datetime [Required]

Creation date

field end_date: datetime | None = None

End date

pydantic model wy_qcos.api.schemas.job.GetJobResultsRequest

基类：BaseModel

Get Job Results Request.

Pydantic Model for Get Job Results Request.

Show JSON schema
{
   "title": "GetJobResultsRequest",
   "description": "Get Job Results Request.\n\nPydantic Model for Get Job Results Request.",
   "type": "object",
   "properties": {
      "job_id": {
         "description": "Job ID",
         "format": "uuid",
         "title": "Job Id",
         "type": "string"
      }
   },
   "required": [
      "job_id"
   ]
}

Fields:
field job_id: UUID [Required]

Job ID

pydantic model wy_qcos.api.schemas.job.GetJobResultsResponse

基类：BaseModel

Get Job Results Response.

Pydantic Model for Get Job Results Response.

Show JSON schema
{
   "title": "GetJobResultsResponse",
   "description": "Get Job Results Response.\n\nPydantic Model for Get Job Results Response.",
   "type": "object",
   "properties": {
      "job_id": {
         "description": "Job ID",
         "format": "uuid",
         "title": "Job Id",
         "type": "string"
      },
      "job_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Job name",
         "title": "Job Name"
      },
      "job_status": {
         "description": "Job status",
         "title": "Job Status",
         "type": "string"
      },
      "job_priority": {
         "default": 5,
         "description": "Job priority. Values: 1-10, Default: 5. Highest priority: 1, Lowest Priority: 10",
         "title": "Job Priority",
         "type": "integer"
      },
      "code_type": {
         "description": "Code type",
         "title": "Code Type",
         "type": "string"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Description",
         "title": "Description"
      },
      "source_code": {
         "description": "Source code list",
         "items": {},
         "title": "Source Code",
         "type": "array"
      },
      "backend": {
         "description": "Backend device name",
         "title": "Backend",
         "type": "string"
      },
      "driver_options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Driver options",
         "title": "Driver Options"
      },
      "transpiler": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Transpiler",
         "title": "Transpiler"
      },
      "transpiler_options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Transpiler options",
         "title": "Transpiler Options"
      },
      "circuit_aggregation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Circuit aggregation: internal, multi",
         "title": "Circuit Aggregation"
      },
      "shots": {
         "description": "Shots",
         "title": "Shots",
         "type": "integer"
      },
      "dry_run": {
         "description": "Dry-run flag",
         "title": "Dry Run",
         "type": "boolean"
      },
      "progress": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -1,
         "description": "Progress",
         "title": "Progress"
      },
      "results": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "integer"
            },
            {
               "items": {},
               "type": "array"
            },
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Results",
         "title": "Results"
      },
      "creation_date": {
         "description": "Creation date",
         "format": "date-time",
         "title": "Creation Date",
         "type": "string"
      },
      "end_date": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "End date",
         "title": "End Date"
      }
   },
   "required": [
      "job_id",
      "job_status",
      "code_type",
      "source_code",
      "backend",
      "shots",
      "dry_run",
      "creation_date"
   ]
}

Fields:
field job_id: UUID [Required]

Job ID

field job_name: str | None = None

Job name

field job_status: str [Required]

Job status

field job_priority: int = 5

Job priority. Values: 1-10, Default: 5. Highest priority: 1, Lowest Priority: 10

field code_type: str [Required]

Code type

field description: str | None = None

Description

field source_code: list [Required]

Source code list

field backend: str [Required]

Backend device name

field driver_options: dict | None = None

Driver options

field transpiler: str | None = None

Transpiler

field transpiler_options: dict | None = None

Transpiler options

field circuit_aggregation: str | None = None

Circuit aggregation: internal, multi

field shots: int [Required]

Shots

field dry_run: bool [Required]

Dry-run flag

field progress: int | None = -1

Progress

field results: str | int | list | dict | None = None

Results

field creation_date: datetime [Required]

Creation date

field end_date: datetime | None = None

End date

pydantic model wy_qcos.api.schemas.job.GetJobsRequest

基类：BaseModel

Get Jobs Request.

Pydantic Model for Get Jobs Request.

Show JSON schema
{
   "title": "GetJobsRequest",
   "description": "Get Jobs Request.\n\nPydantic Model for Get Jobs Request.",
   "type": "object",
   "properties": {}
}

pydantic model wy_qcos.api.schemas.job.CancelJobsRequest

基类：BaseModel

Cancel Jobs Request.

Pydantic Model for Cancel Jobs Request.

Show JSON schema
{
   "title": "CancelJobsRequest",
   "description": "Cancel Jobs Request.\n\nPydantic Model for Cancel Jobs Request.",
   "type": "object",
   "properties": {
      "job_ids": {
         "description": "Job IDs to cancel",
         "items": {
            "format": "uuid",
            "type": "string"
         },
         "title": "Job Ids",
         "type": "array"
      }
   },
   "required": [
      "job_ids"
   ]
}

Fields:
field job_ids: list[UUID] [Required]

Job IDs to cancel

pydantic model wy_qcos.api.schemas.job.CancelJobsResponse

基类：BaseModel

Cancel Jobs Response.

Pydantic Model for Cancel Jobs Response.

Show JSON schema
{
   "title": "CancelJobsResponse",
   "description": "Cancel Jobs Response.\n\nPydantic Model for Cancel Jobs Response.",
   "type": "object",
   "properties": {
      "job_id": {
         "description": "Job ID",
         "format": "uuid",
         "title": "Job Id",
         "type": "string"
      },
      "job_status": {
         "description": "Job status",
         "title": "Job Status",
         "type": "string"
      }
   },
   "required": [
      "job_id",
      "job_status"
   ]
}

Fields:
field job_id: UUID [Required]

Job ID

field job_status: str [Required]

Job status

pydantic model wy_qcos.api.schemas.job.DeleteJobsRequest

基类：BaseModel

Delete Jobs Request.

Pydantic Model for Delete Jobs Request.

Show JSON schema
{
   "title": "DeleteJobsRequest",
   "description": "Delete Jobs Request.\n\nPydantic Model for Delete Jobs Request.",
   "type": "object",
   "properties": {
      "job_ids": {
         "description": "Job IDs to delete",
         "items": {
            "format": "uuid",
            "type": "string"
         },
         "title": "Job Ids",
         "type": "array"
      }
   },
   "required": [
      "job_ids"
   ]
}

Fields:
field job_ids: list[UUID] [Required]

Job IDs to delete

pydantic model wy_qcos.api.schemas.job.DeleteJobsResponse

基类：BaseModel

Delete Jobs Response.

Pydantic Model for Delete Jobs Response.

Show JSON schema
{
   "title": "DeleteJobsResponse",
   "description": "Delete Jobs Response.\n\nPydantic Model for Delete Jobs Response.",
   "type": "object",
   "properties": {
      "job_id": {
         "description": "Job ID",
         "format": "uuid",
         "title": "Job Id",
         "type": "string"
      },
      "job_status": {
         "description": "Job status",
         "title": "Job Status",
         "type": "string"
      }
   },
   "required": [
      "job_id",
      "job_status"
   ]
}

Fields:
field job_id: UUID [Required]

Job ID

field job_status: str [Required]

Job status

pydantic model wy_qcos.api.schemas.job.SetJobResultsRequest

基类：BaseModel

Set Job Results Request.

Pydantic Model for Set Job Results Request.

Show JSON schema
{
   "title": "SetJobResultsRequest",
   "description": "Set Job Results Request.\n\nPydantic Model for Set Job Results Request.",
   "type": "object",
   "properties": {
      "job_id": {
         "description": "Job ID",
         "format": "uuid",
         "title": "Job Id",
         "type": "string"
      },
      "results": {
         "description": "Job results",
         "items": {},
         "title": "Results",
         "type": "array"
      },
      "errors": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "integer"
            },
            {
               "items": {},
               "type": "array"
            },
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Errors",
         "title": "Errors"
      }
   },
   "required": [
      "job_id",
      "results"
   ]
}

Fields:
field job_id: UUID [Required]

Job ID

field results: list [Required]

Job results

field errors: str | int | list | dict | None = None

Errors

pydantic model wy_qcos.api.schemas.job.SetJobResultsResponse

基类：BaseModel

Set Job Results Response.

Pydantic Model for Set Job Results Response.

Show JSON schema
{
   "title": "SetJobResultsResponse",
   "description": "Set Job Results Response.\n\nPydantic Model for Set Job Results Response.",
   "type": "object",
   "properties": {
      "job_id": {
         "description": "Job ID",
         "format": "uuid",
         "title": "Job Id",
         "type": "string"
      },
      "backend": {
         "description": "Backend device name",
         "title": "Backend",
         "type": "string"
      },
      "job_status": {
         "description": "Job status",
         "title": "Job Status",
         "type": "string"
      }
   },
   "required": [
      "job_id",
      "backend",
      "job_status"
   ]
}

Fields:
field job_id: UUID [Required]

Job ID

field backend: str [Required]

Backend device name

field job_status: str [Required]

Job status

pydantic model wy_qcos.api.schemas.job.UpdateJobRequest

基类：BaseModel

Update Job Request.

Pydantic Model for Update Job Request.

Show JSON schema
{
   "title": "UpdateJobRequest",
   "description": "Update Job Request.\n\nPydantic Model for Update Job Request.",
   "type": "object",
   "properties": {
      "job_id": {
         "description": "Job ID",
         "format": "uuid",
         "title": "Job Id",
         "type": "string"
      },
      "job_priority": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Job priority. Values: 1-10, Default: 5. Highest priority: 1, Lowest Priority: 10",
         "title": "Job Priority"
      }
   },
   "required": [
      "job_id"
   ]
}

Fields:
field job_id: UUID [Required]

Job ID

field job_priority: int | None = None

Job priority. Values: 1-10, Default: 5. Highest priority: 1, Lowest Priority: 10

pydantic model wy_qcos.api.schemas.job.UpdateJobResponse

基类：BaseModel

Update Job Response.

Pydantic Model for Update Job Response.

Show JSON schema
{
   "title": "UpdateJobResponse",
   "description": "Update Job Response.\n\nPydantic Model for Update Job Response.",
   "type": "object",
   "properties": {
      "job_id": {
         "description": "Job ID",
         "format": "uuid",
         "title": "Job Id",
         "type": "string"
      },
      "job_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Job name",
         "title": "Job Name"
      },
      "job_type": {
         "description": "Job type",
         "title": "Job Type",
         "type": "string"
      },
      "job_status": {
         "description": "Job status",
         "title": "Job Status",
         "type": "string"
      },
      "job_priority": {
         "default": 5,
         "description": "Job priority. Values: 1-10, Default: 5. Highest priority: 1, Lowest Priority: 10",
         "title": "Job Priority",
         "type": "integer"
      },
      "code_type": {
         "description": "Code type",
         "title": "Code Type",
         "type": "string"
      },
      "source_code": {
         "description": "Source code list",
         "items": {},
         "title": "Source Code",
         "type": "array"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Description",
         "title": "Description"
      },
      "backend": {
         "description": "Backend device name",
         "title": "Backend",
         "type": "string"
      },
      "driver_options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Driver options",
         "title": "Driver Options"
      },
      "transpiler": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Transpiler",
         "title": "Transpiler"
      },
      "transpiler_options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Transpiler options",
         "title": "Transpiler Options"
      },
      "circuit_aggregation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Circuit aggregation: internal, multi",
         "title": "Circuit Aggregation"
      },
      "shots": {
         "description": "Shots",
         "title": "Shots",
         "type": "integer"
      },
      "profiling": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Profiling",
         "title": "Profiling"
      },
      "dry_run": {
         "description": "Dry-run flag",
         "title": "Dry Run",
         "type": "boolean"
      },
      "callbacks": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Callbacks",
         "title": "Callbacks"
      },
      "creation_date": {
         "description": "Creation date",
         "format": "date-time",
         "title": "Creation Date",
         "type": "string"
      },
      "end_date": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "End date",
         "title": "End Date"
      }
   },
   "required": [
      "job_id",
      "job_type",
      "job_status",
      "code_type",
      "source_code",
      "backend",
      "shots",
      "dry_run",
      "creation_date"
   ]
}

Fields:
field job_id: UUID [Required]

Job ID

field job_name: str | None = None

Job name

field job_type: str [Required]

Job type

field job_status: str [Required]

Job status

field job_priority: int = 5

Job priority. Values: 1-10, Default: 5. Highest priority: 1, Lowest Priority: 10

field code_type: str [Required]

Code type

field source_code: list [Required]

Source code list

field description: str | None = None

Description

field backend: str [Required]

Backend device name

field driver_options: dict | None = None

Driver options

field transpiler: str | None = None

Transpiler

field transpiler_options: dict | None = None

Transpiler options

field circuit_aggregation: str | None = None

Circuit aggregation: internal, multi

field shots: int [Required]

Shots

field profiling: list | None = None

Profiling

field dry_run: bool [Required]

Dry-run flag

field callbacks: list | None = None

Callbacks

field creation_date: datetime [Required]

Creation date

field end_date: datetime | None = None

End date

wy_qcos.api.schemas.metrics module

pydantic model wy_qcos.api.schemas.metrics.GetMetricsRequest

基类：BaseModel

Get metrics request.

Show JSON schema
{
   "title": "GetMetricsRequest",
   "description": "Get metrics request.",
   "type": "object",
   "properties": {}
}

pydantic model wy_qcos.api.schemas.metrics.GetMetricsResponse

基类：BaseModel

Get metrics response.

Show JSON schema
{
   "title": "GetMetricsResponse",
   "description": "Get metrics response.",
   "type": "object",
   "properties": {
      "metrics": {
         "description": "Metrics data",
         "title": "Metrics",
         "type": "string"
      }
   },
   "required": [
      "metrics"
   ]
}

Fields:
field metrics: str [Required]

Metrics data

pydantic model wy_qcos.api.schemas.metrics.GetSystemHealthRequest

基类：BaseModel

Get system health request.

Show JSON schema
{
   "title": "GetSystemHealthRequest",
   "description": "Get system health request.",
   "type": "object",
   "properties": {}
}

pydantic model wy_qcos.api.schemas.metrics.GetSystemHealthResponse

基类：BaseModel

Get system health response.

Show JSON schema
{
   "title": "GetSystemHealthResponse",
   "description": "Get system health response.",
   "type": "object",
   "properties": {
      "system_healthy": {
         "description": "Overall system health status",
         "examples": [
            true,
            false
         ],
         "title": "System Healthy",
         "type": "boolean"
      },
      "heartbeat_timestamp": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Last heartbeat timestamp",
         "examples": [
            1234567890.123
         ],
         "title": "Heartbeat Timestamp"
      },
      "component_status": {
         "additionalProperties": {
            "type": "string"
         },
         "description": "Status of individual system components",
         "examples": [
            {
               "fastapi": "online",
               "redis": "online"
            }
         ],
         "title": "Component Status",
         "type": "object"
      }
   },
   "required": [
      "system_healthy",
      "component_status"
   ]
}

Fields:
field system_healthy: bool [Required]

Overall system health status

field heartbeat_timestamp: float | None = None

Last heartbeat timestamp

field component_status: dict[str, str] [Required]

Status of individual system components

pydantic model wy_qcos.api.schemas.metrics.GetApiStatsRequest

基类：BaseModel

Get API statistics request.

Show JSON schema
{
   "title": "GetApiStatsRequest",
   "description": "Get API statistics request.",
   "type": "object",
   "properties": {}
}

pydantic model wy_qcos.api.schemas.metrics.GetApiStatsResponse

基类：BaseModel

Get API statistics response.

Show JSON schema
{
   "title": "GetApiStatsResponse",
   "description": "Get API statistics response.",
   "type": "object",
   "properties": {
      "total_requests": {
         "description": "Total API requests",
         "title": "Total Requests",
         "type": "integer"
      },
      "last_hour_requests": {
         "description": "API requests in the last hour",
         "title": "Last Hour Requests",
         "type": "integer"
      },
      "last_day_requests": {
         "description": "API requests in the last day",
         "title": "Last Day Requests",
         "type": "integer"
      }
   },
   "required": [
      "total_requests",
      "last_hour_requests",
      "last_day_requests"
   ]
}

Fields:
field total_requests: int [Required]

Total API requests

field last_hour_requests: int [Required]

API requests in the last hour

field last_day_requests: int [Required]

API requests in the last day

pydantic model wy_qcos.api.schemas.metrics.GetJobStatsRequest

基类：BaseModel

Get job statistics request.

Show JSON schema
{
   "title": "GetJobStatsRequest",
   "description": "Get job statistics request.",
   "type": "object",
   "properties": {}
}

pydantic model wy_qcos.api.schemas.metrics.GetJobStatsResponse

基类：BaseModel

Get job statistics response.

Show JSON schema
{
   "title": "GetJobStatsResponse",
   "description": "Get job statistics response.",
   "type": "object",
   "properties": {
      "total": {
         "description": "Total number of jobs",
         "title": "Total",
         "type": "integer"
      },
      "completed": {
         "description": "Number of completed jobs",
         "title": "Completed",
         "type": "integer"
      },
      "failed": {
         "description": "Number of failed jobs",
         "title": "Failed",
         "type": "integer"
      },
      "running": {
         "description": "Number of running jobs",
         "title": "Running",
         "type": "integer"
      },
      "queued": {
         "description": "Number of queued jobs",
         "title": "Queued",
         "type": "integer"
      },
      "cancelling": {
         "description": "Number of cancelling jobs",
         "title": "Cancelling",
         "type": "integer"
      },
      "cancelled": {
         "description": "Number of cancelled jobs",
         "title": "Cancelled",
         "type": "integer"
      },
      "deleted": {
         "description": "Number of deleted jobs",
         "title": "Deleted",
         "type": "integer"
      },
      "unknown": {
         "description": "Number of unknown jobs",
         "title": "Unknown",
         "type": "integer"
      }
   },
   "required": [
      "total",
      "completed",
      "failed",
      "running",
      "queued",
      "cancelling",
      "cancelled",
      "deleted",
      "unknown"
   ]
}

Fields:
field total: int [Required]

Total number of jobs

field completed: int [Required]

Number of completed jobs

field failed: int [Required]

Number of failed jobs

field running: int [Required]

Number of running jobs

field queued: int [Required]

Number of queued jobs

field cancelling: int [Required]

Number of cancelling jobs

field cancelled: int [Required]

Number of cancelled jobs

field deleted: int [Required]

Number of deleted jobs

field unknown: int [Required]

Number of unknown jobs

wy_qcos.api.schemas.system module

pydantic model wy_qcos.api.schemas.system.PingRequest

基类：BaseModel

Ping Request.

Pydantic Model for Ping Request.

Show JSON schema
{
   "title": "PingRequest",
   "description": "Ping Request.\n\nPydantic Model for Ping Request.",
   "type": "object",
   "properties": {
      "message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Ping message",
         "title": "Message"
      }
   }
}

Fields:
field message: str | None = None

Ping message

pydantic model wy_qcos.api.schemas.system.PongResponse

基类：BaseModel

Pong Response.

Pydantic Model for Pong Response.

Show JSON schema
{
   "title": "PongResponse",
   "description": "Pong Response.\n\nPydantic Model for Pong Response.",
   "type": "object",
   "properties": {
      "message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Pong message",
         "title": "Message"
      }
   }
}

Fields:
field message: str | None = None

Pong message

pydantic model wy_qcos.api.schemas.system.SystemInfoRequest

基类：BaseModel

System Info Request.

Pydantic Model for System Info Request.

Show JSON schema
{
   "title": "SystemInfoRequest",
   "description": "System Info Request.\n\nPydantic Model for System Info Request.",
   "type": "object",
   "properties": {}
}

pydantic model wy_qcos.api.schemas.system.SystemInfoResponse

基类：BaseModel

System Info Response.

Pydantic Model for System Info Response.

Show JSON schema
{
   "title": "SystemInfoResponse",
   "description": "System Info Response.\n\nPydantic Model for System Info Response.",
   "type": "object",
   "properties": {
      "total_jobs_count": {
         "description": "Total number of jobs in the system",
         "title": "Total Jobs Count",
         "type": "integer"
      }
   },
   "required": [
      "total_jobs_count"
   ]
}

Fields:
field total_jobs_count: int [Required]

Total number of jobs in the system

wy_qcos.api.schemas.transpiler module

pydantic model wy_qcos.api.schemas.transpiler.GetTranspilersRequest

基类：BaseModel

Get Transpilers Request.

Pydantic Model for Get Transpilers Request.

Show JSON schema
{
   "title": "GetTranspilersRequest",
   "description": "Get Transpilers Request.\n\nPydantic Model for Get Transpilers Request.",
   "type": "object",
   "properties": {}
}

pydantic model wy_qcos.api.schemas.transpiler.GetTranspilerRequest

基类：BaseModel

Get Transpiler Request.

Pydantic Model for Get Transpiler Request.

Show JSON schema
{
   "title": "GetTranspilerRequest",
   "description": "Get Transpiler Request.\n\nPydantic Model for Get Transpiler Request.",
   "type": "object",
   "properties": {
      "name": {
         "description": "transpiler name",
         "title": "Name",
         "type": "string"
      }
   },
   "required": [
      "name"
   ]
}

Fields:
field name: str [Required]

transpiler name

pydantic model wy_qcos.api.schemas.transpiler.GetTranspilerResponse

基类：BaseModel

Get Transpiler Response.

Pydantic Model for Get Transpiler Response.

Show JSON schema
{
   "title": "GetTranspilerResponse",
   "description": "Get Transpiler Response.\n\nPydantic Model for Get Transpiler Response.",
   "type": "object",
   "properties": {
      "name": {
         "description": "transpiler name",
         "title": "Name",
         "type": "string"
      },
      "alias_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "transpiler alias name",
         "title": "Alias Name"
      },
      "version": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "version",
         "title": "Version"
      },
      "enable": {
         "default": true,
         "description": "enable this transpiler or not",
         "title": "Enable",
         "type": "boolean"
      },
      "supported_code_types": {
         "description": "supported code types",
         "items": {},
         "title": "Supported Code Types",
         "type": "array"
      },
      "transpiler_options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "transpiler_options",
         "title": "Transpiler Options"
      },
      "transpiler_options_schema": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "transpiler_options schema",
         "title": "Transpiler Options Schema"
      }
   },
   "required": [
      "name"
   ]
}

Fields:
field name: str [Required]

transpiler name

field alias_name: str | None = None

transpiler alias name

field version: str | None = None

version

field enable: bool = True

enable this transpiler or not

field supported_code_types: list [Optional]

supported code types

field transpiler_options: dict | None = None

transpiler_options

field transpiler_options_schema: dict | None = None

transpiler_options schema

wy_qcos.api.schemas.user module

pydantic model wy_qcos.api.schemas.user.UserRead

基类：BaseModel

User read schema.

Show JSON schema
{
   "title": "UserRead",
   "description": "User read schema.",
   "type": "object",
   "properties": {
      "id": {
         "description": "User ID (UUID)",
         "title": "Id",
         "type": "string"
      },
      "user_name": {
         "description": "User name",
         "title": "User Name",
         "type": "string"
      },
      "roles": {
         "default": [],
         "description": "User roles",
         "items": {
            "type": "string"
         },
         "title": "Roles",
         "type": "array"
      },
      "is_enabled": {
         "default": true,
         "description": "Is user enabled",
         "title": "Is Enabled",
         "type": "boolean"
      },
      "is_locked": {
         "default": false,
         "description": "Is user locked",
         "title": "Is Locked",
         "type": "boolean"
      },
      "last_login": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Last login time",
         "title": "Last Login"
      },
      "password_changed_at": {
         "description": "Password last changed timestamp",
         "title": "Password Changed At",
         "type": "string"
      },
      "locked_until": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Locked until timestamp",
         "title": "Locked Until"
      },
      "password_expiry_days": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Password expiry days",
         "title": "Password Expiry Days"
      },
      "failed_login_attempts": {
         "default": 0,
         "description": "Failed login attempts count",
         "title": "Failed Login Attempts",
         "type": "integer"
      },
      "description": {
         "anyOf": [
            {
               "maxLength": 255,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User description",
         "title": "Description"
      },
      "created_at": {
         "description": "User creation timestamp",
         "title": "Created At",
         "type": "string"
      },
      "updated_at": {
         "description": "User last updated timestamp",
         "title": "Updated At",
         "type": "string"
      }
   },
   "required": [
      "id",
      "user_name",
      "password_changed_at",
      "created_at",
      "updated_at"
   ]
}

Config:

  • from_attributes: bool = True

Fields:
field id: str [Required]

User ID (UUID)

field user_name: str [Required]

User name

field roles: list[str] = []

User roles

field is_enabled: bool = True

Is user enabled

field is_locked: bool = False

Is user locked

field last_login: str | None = None

Last login time

field password_changed_at: str [Required]

Password last changed timestamp

field locked_until: str | None = None

Locked until timestamp

field password_expiry_days: int | None = None

Password expiry days

field failed_login_attempts: int = 0

Failed login attempts count

field description: str | None = None

User description

Constraints:

  • min_length = 1

  • max_length = 255

field created_at: str [Required]

User creation timestamp

field updated_at: str [Required]

User last updated timestamp

pydantic model wy_qcos.api.schemas.user.UserCreate

基类：BaseModel

User create schema.

Show JSON schema
{
   "title": "UserCreate",
   "description": "User create schema.",
   "type": "object",
   "properties": {
      "user_name": {
         "description": "User name",
         "maxLength": 64,
         "minLength": 2,
         "title": "User Name",
         "type": "string"
      },
      "password": {
         "description": "Password",
         "maxLength": 32,
         "minLength": 6,
         "title": "Password",
         "type": "string"
      },
      "roles": {
         "default": [
            "user"
         ],
         "description": "User roles",
         "items": {
            "type": "string"
         },
         "title": "Roles",
         "type": "array"
      },
      "is_locked": {
         "default": false,
         "description": "Is user locked",
         "title": "Is Locked",
         "type": "boolean"
      },
      "password_expiry_days": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Password expiry days",
         "title": "Password Expiry Days"
      },
      "description": {
         "anyOf": [
            {
               "maxLength": 255,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User description",
         "title": "Description"
      }
   },
   "required": [
      "user_name",
      "password"
   ]
}

Fields:
field user_name: str [Required]

User name

Constraints:

  • min_length = 2

  • max_length = 64

field password: str [Required]

Password

Constraints:

  • min_length = 6

  • max_length = 32

field roles: list[str] = ['user']

User roles

field is_locked: bool = False

Is user locked

field password_expiry_days: int | None = None

Password expiry days

field description: str | None = None

User description

Constraints:

  • min_length = 1

  • max_length = 255

pydantic model wy_qcos.api.schemas.user.UserUpdate

基类：BaseModel

User update schema.

Show JSON schema
{
   "title": "UserUpdate",
   "description": "User update schema.",
   "type": "object",
   "properties": {
      "user_name": {
         "anyOf": [
            {
               "maxLength": 64,
               "minLength": 2,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User name",
         "title": "User Name"
      },
      "roles": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User roles",
         "title": "Roles"
      },
      "is_locked": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Is user locked",
         "title": "Is Locked"
      },
      "password_expiry_days": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Password expiry days",
         "title": "Password Expiry Days"
      },
      "description": {
         "anyOf": [
            {
               "maxLength": 255,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User description",
         "title": "Description"
      }
   }
}

Fields:
field user_name: str | None = None

User name

Constraints:

  • min_length = 2

  • max_length = 64

field roles: list[str] | None = None

User roles

field is_locked: bool | None = None

Is user locked

field password_expiry_days: int | None = None

Password expiry days

field description: str | None = None

User description

Constraints:

  • min_length = 1

  • max_length = 255

pydantic model wy_qcos.api.schemas.user.User

基类：BaseModel

User model.

Note: roles are stored in user_roles association table, not in users table. The get_role_names() method on the User ORM model retrieves them dynamically.

Show JSON schema
{
   "title": "User",
   "description": "User model.\n\nNote: roles are stored in user_roles association table, not in\nusers table. The get_role_names() method on the User ORM model\nretrieves them dynamically.",
   "type": "object",
   "properties": {
      "id": {
         "description": "User ID (UUID)",
         "title": "Id",
         "type": "string"
      },
      "project_id": {
         "description": "Project ID (UUID)",
         "title": "Project Id",
         "type": "string"
      },
      "user_name": {
         "description": "User name",
         "title": "User Name",
         "type": "string"
      },
      "hashed_password": {
         "description": "Password hash",
         "is_sensitive": true,
         "title": "Hashed Password",
         "type": "string"
      },
      "roles": {
         "default": [],
         "description": "User roles (from user_roles table)",
         "items": {
            "type": "string"
         },
         "title": "Roles",
         "type": "array"
      },
      "password_expiry_days": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "description": "Password expiry days",
         "title": "Password Expiry Days"
      },
      "is_enabled": {
         "default": true,
         "description": "Is user enabled",
         "title": "Is Enabled",
         "type": "boolean"
      },
      "is_locked": {
         "default": false,
         "description": "Is user locked",
         "title": "Is Locked",
         "type": "boolean"
      },
      "failed_login_attempts": {
         "default": 0,
         "description": "Failed login attempts",
         "title": "Failed Login Attempts",
         "type": "integer"
      },
      "last_login": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Last login time",
         "title": "Last Login"
      },
      "password_changed_at": {
         "description": "Password last changed",
         "format": "date-time",
         "title": "Password Changed At",
         "type": "string"
      },
      "locked_until": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Locked until",
         "title": "Locked Until"
      },
      "created_at": {
         "description": "User creation time",
         "format": "date-time",
         "title": "Created At",
         "type": "string"
      },
      "updated_at": {
         "description": "User last updated time",
         "format": "date-time",
         "title": "Updated At",
         "type": "string"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User description",
         "title": "Description"
      }
   },
   "required": [
      "user_name",
      "hashed_password",
      "password_expiry_days"
   ]
}

Config:

  • from_attributes: bool = True

Fields:
Validators:
field id: str [Optional]

User ID (UUID)

Validated by:
field project_id: str [Optional]

Project ID (UUID)

Validated by:
field user_name: str [Required]

User name

Validated by:
field hashed_password: str [Required]

Password hash

Validated by:
field roles: list[str] = []

User roles (from user_roles table)

Validated by:
field password_expiry_days: int | None [Required]

Password expiry days

Validated by:
field is_enabled: bool = True

Is user enabled

Validated by:
field is_locked: bool = False

Is user locked

Validated by:
field failed_login_attempts: int = 0

Failed login attempts

Validated by:
field last_login: datetime | None = None

Last login time

Validated by:
field password_changed_at: datetime [Optional]

Password last changed

Validated by:
field locked_until: datetime | None = None

Locked until

Validated by:
field created_at: datetime [Optional]

User creation time

Validated by:
field updated_at: datetime [Optional]

User last updated time

Validated by:
field description: str | None = None

User description

Validated by:
validator populate_roles_from_orm  »  all fields

Populate roles from ORM user_roles relationship.

When loading from ORM, if the user object has get_role_names method, call it to populate the roles list from the user_roles association table.

serialize_roles(value)

Serialize roles from ORM user_roles relationship.

返回类型:

list[str]

pydantic model wy_qcos.api.schemas.user.GetUserMgmtRequest

基类：BaseModel

Get user management status request.

Show JSON schema
{
   "title": "GetUserMgmtRequest",
   "description": "Get user management status request.",
   "type": "object",
   "properties": {}
}

pydantic model wy_qcos.api.schemas.user.GetUserMgmtResponse

基类：BaseModel

Get user management status response.

Show JSON schema
{
   "title": "GetUserMgmtResponse",
   "description": "Get user management status response.",
   "type": "object",
   "properties": {
      "auth_mode": {
         "description": "User authentication mode",
         "title": "Auth Mode",
         "type": "string"
      },
      "password_expiry_days": {
         "default": 0,
         "description": "Password expiry days",
         "title": "Password Expiry Days",
         "type": "integer"
      },
      "max_login_attempts": {
         "default": 5,
         "description": "Maximum login attempts",
         "title": "Max Login Attempts",
         "type": "integer"
      },
      "lockout_duration_minutes": {
         "default": 30,
         "description": "Lockout duration in minutes",
         "title": "Lockout Duration Minutes",
         "type": "integer"
      }
   },
   "required": [
      "auth_mode"
   ]
}

Fields:
field auth_mode: str [Required]

User authentication mode

field password_expiry_days: int = 0

Password expiry days

field max_login_attempts: int = 5

Maximum login attempts

field lockout_duration_minutes: int = 30

Lockout duration in minutes

pydantic model wy_qcos.api.schemas.user.SetUserMgmtRequest

基类：BaseModel

Set user management request.

Show JSON schema
{
   "title": "SetUserMgmtRequest",
   "description": "Set user management request.",
   "type": "object",
   "properties": {
      "auth_mode": {
         "description": "Authentication mode: 'no', 'jwt', or 'virtual_instance'",
         "title": "Auth Mode",
         "type": "string"
      }
   },
   "required": [
      "auth_mode"
   ]
}

Fields:
field auth_mode: str [Required]

Authentication mode: 'no', 'jwt', or 'virtual_instance'

pydantic model wy_qcos.api.schemas.user.SetUserMgmtResponse

基类：BaseModel

Set user management response.

Show JSON schema
{
   "title": "SetUserMgmtResponse",
   "description": "Set user management response.",
   "type": "object",
   "properties": {
      "auth_mode": {
         "description": "Updated authentication mode",
         "title": "Auth Mode",
         "type": "string"
      },
      "message": {
         "description": "Success message",
         "title": "Message",
         "type": "string"
      }
   },
   "required": [
      "auth_mode",
      "message"
   ]
}

Fields:
field auth_mode: str [Required]

Updated authentication mode

field message: str [Required]

Success message

pydantic model wy_qcos.api.schemas.user.CreateUserRequest

基类：BaseModel

Create user request.

Show JSON schema
{
   "title": "CreateUserRequest",
   "description": "Create user request.",
   "type": "object",
   "properties": {
      "project_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Project ID (UUID) - optional, defaults to DEFAULT_PROJECT_ID",
         "title": "Project Id"
      },
      "user_name": {
         "description": "User name",
         "maxLength": 64,
         "minLength": 2,
         "title": "User Name",
         "type": "string"
      },
      "password": {
         "description": "Password",
         "is_sensitive": true,
         "maxLength": 32,
         "minLength": 6,
         "title": "Password",
         "type": "string"
      },
      "roles": {
         "default": [
            "user"
         ],
         "description": "User roles",
         "items": {
            "type": "string"
         },
         "title": "Roles",
         "type": "array"
      },
      "password_expiry_days": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Password expiry days (optional)",
         "title": "Password Expiry Days"
      },
      "is_enabled": {
         "default": true,
         "description": "Whether user is enabled",
         "title": "Is Enabled",
         "type": "boolean"
      },
      "is_locked": {
         "default": false,
         "description": "Whether user is locked",
         "title": "Is Locked",
         "type": "boolean"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User description",
         "title": "Description"
      }
   },
   "required": [
      "user_name",
      "password"
   ]
}

Fields:
field project_id: str | None = None

Project ID (UUID) - optional, defaults to DEFAULT_PROJECT_ID

field user_name: str [Required]

User name

Constraints:

  • min_length = 2

  • max_length = 64

field password: str [Required]

Password

Constraints:

  • min_length = 6

  • max_length = 32

field roles: list[str] = ['user']

User roles

field password_expiry_days: int | None = None

Password expiry days (optional)

field is_enabled: bool = True

Whether user is enabled

field is_locked: bool = False

Whether user is locked

field description: str | None = None

User description

pydantic model wy_qcos.api.schemas.user.CreateUserResponse

基类：BaseModel

Create user response.

Show JSON schema
{
   "title": "CreateUserResponse",
   "description": "Create user response.",
   "type": "object",
   "properties": {
      "id": {
         "description": "User ID (UUID)",
         "title": "Id",
         "type": "string"
      },
      "project_id": {
         "description": "Project ID (UUID)",
         "title": "Project Id",
         "type": "string"
      },
      "user_name": {
         "description": "User name",
         "title": "User Name",
         "type": "string"
      },
      "roles": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "description": "User roles",
         "title": "Roles"
      },
      "is_enabled": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "description": "Whether user is enabled",
         "title": "Is Enabled"
      },
      "is_locked": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "description": "Whether user is locked",
         "title": "Is Locked"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User description",
         "title": "Description"
      },
      "created_at": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "Creation timestamp",
         "title": "Created At"
      }
   },
   "required": [
      "id",
      "project_id",
      "user_name",
      "roles",
      "is_enabled",
      "is_locked",
      "created_at"
   ]
}

Fields:
field id: str [Required]

User ID (UUID)

field project_id: str [Required]

Project ID (UUID)

field user_name: str [Required]

User name

field roles: list[str] | None [Required]

User roles

field is_enabled: bool | None [Required]

Whether user is enabled

field is_locked: bool | None [Required]

Whether user is locked

field description: str | None = None

User description

field created_at: str | None [Required]

Creation timestamp

pydantic model wy_qcos.api.schemas.user.GetUserRequest

基类：BaseModel

Get user request by ID.

Show JSON schema
{
   "title": "GetUserRequest",
   "description": "Get user request by ID.",
   "type": "object",
   "properties": {
      "user_id": {
         "description": "User ID (UUID)",
         "title": "User Id",
         "type": "string"
      }
   },
   "required": [
      "user_id"
   ]
}

Fields:
field user_id: str [Required]

User ID (UUID)

pydantic model wy_qcos.api.schemas.user.GetUserResponse

基类：BaseModel

Get user response.

Show JSON schema
{
   "title": "GetUserResponse",
   "description": "Get user response.",
   "type": "object",
   "properties": {
      "id": {
         "description": "User ID (UUID)",
         "title": "Id",
         "type": "string"
      },
      "project_id": {
         "description": "Project ID (UUID)",
         "title": "Project Id",
         "type": "string"
      },
      "user_name": {
         "description": "User name",
         "title": "User Name",
         "type": "string"
      },
      "roles": {
         "description": "User roles",
         "items": {
            "type": "string"
         },
         "title": "Roles",
         "type": "array"
      },
      "is_enabled": {
         "description": "Whether user is enabled",
         "title": "Is Enabled",
         "type": "boolean"
      },
      "is_locked": {
         "description": "Whether user is locked",
         "title": "Is Locked",
         "type": "boolean"
      },
      "password_expiry_days": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Password expiry days",
         "title": "Password Expiry Days"
      },
      "last_login": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Last login timestamp",
         "title": "Last Login"
      },
      "password_changed_at": {
         "description": "Password last changed timestamp",
         "title": "Password Changed At",
         "type": "string"
      },
      "locked_until": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Locked until timestamp",
         "title": "Locked Until"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User description",
         "title": "Description"
      },
      "created_at": {
         "description": "User creation timestamp",
         "title": "Created At",
         "type": "string"
      },
      "updated_at": {
         "description": "User last updated timestamp",
         "title": "Updated At",
         "type": "string"
      }
   },
   "required": [
      "id",
      "project_id",
      "user_name",
      "roles",
      "is_enabled",
      "is_locked",
      "password_changed_at",
      "created_at",
      "updated_at"
   ]
}

Fields:
field id: str [Required]

User ID (UUID)

field project_id: str [Required]

Project ID (UUID)

field user_name: str [Required]

User name

field roles: list[str] [Required]

User roles

field is_enabled: bool [Required]

Whether user is enabled

field is_locked: bool [Required]

Whether user is locked

field password_expiry_days: int | None = None

Password expiry days

field last_login: str | None = None

Last login timestamp

field password_changed_at: str [Required]

Password last changed timestamp

field locked_until: str | None = None

Locked until timestamp

field description: str | None = None

User description

field created_at: str [Required]

User creation timestamp

field updated_at: str [Required]

User last updated timestamp

pydantic model wy_qcos.api.schemas.user.GetUsersRequest

基类：BaseModel

Get users request with optional filtering.

Show JSON schema
{
   "title": "GetUsersRequest",
   "description": "Get users request with optional filtering.",
   "type": "object",
   "properties": {
      "filters": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Filter conditions dict, e.g. {'user_name': 'admin'}",
         "title": "Filters"
      }
   }
}

Fields:
field filters: dict | None = None

Filter conditions dict, e.g. {'user_name': 'admin'}

pydantic model wy_qcos.api.schemas.user.UpdateUserRequest

基类：BaseModel

Update user request by ID.

Show JSON schema
{
   "title": "UpdateUserRequest",
   "description": "Update user request by ID.",
   "type": "object",
   "properties": {
      "user_id": {
         "description": "User ID (UUID)",
         "title": "User Id",
         "type": "string"
      },
      "roles": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User roles",
         "title": "Roles"
      },
      "password_expiry_days": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Password expiry days",
         "title": "Password Expiry Days"
      },
      "is_enabled": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Whether user is enabled",
         "title": "Is Enabled"
      },
      "is_locked": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Whether user is locked",
         "title": "Is Locked"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User description",
         "title": "Description"
      }
   },
   "required": [
      "user_id"
   ]
}

Fields:
field user_id: str [Required]

User ID (UUID)

field roles: list[str] | None = None

User roles

field password_expiry_days: int | None = None

Password expiry days

field is_enabled: bool | None = None

Whether user is enabled

field is_locked: bool | None = None

Whether user is locked

field description: str | None = None

User description

pydantic model wy_qcos.api.schemas.user.PasswordChangeRequest

基类：UpdateUserRequest

Password change request with password field support.

Show JSON schema
{
   "title": "PasswordChangeRequest",
   "description": "Password change request with password field support.",
   "type": "object",
   "properties": {
      "user_id": {
         "description": "User ID (UUID)",
         "title": "User Id",
         "type": "string"
      },
      "roles": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User roles",
         "title": "Roles"
      },
      "password_expiry_days": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Password expiry days",
         "title": "Password Expiry Days"
      },
      "is_enabled": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Whether user is enabled",
         "title": "Is Enabled"
      },
      "is_locked": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Whether user is locked",
         "title": "Is Locked"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User description",
         "title": "Description"
      },
      "password": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "New password",
         "title": "Password"
      }
   },
   "required": [
      "user_id"
   ]
}

Fields:
field password: str | None = None

New password

pydantic model wy_qcos.api.schemas.user.UpdateUserResponse

基类：BaseModel

Update user response.

Show JSON schema
{
   "title": "UpdateUserResponse",
   "description": "Update user response.",
   "type": "object",
   "properties": {
      "id": {
         "description": "User ID (UUID)",
         "title": "Id",
         "type": "string"
      },
      "project_id": {
         "description": "Project ID (UUID)",
         "title": "Project Id",
         "type": "string"
      },
      "user_name": {
         "description": "User name",
         "title": "User Name",
         "type": "string"
      },
      "roles": {
         "description": "User roles",
         "items": {
            "type": "string"
         },
         "title": "Roles",
         "type": "array"
      },
      "is_enabled": {
         "description": "Whether user is enabled",
         "title": "Is Enabled",
         "type": "boolean"
      },
      "is_locked": {
         "description": "Whether user is locked",
         "title": "Is Locked",
         "type": "boolean"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User description",
         "title": "Description"
      },
      "updated_at": {
         "description": "Update timestamp",
         "title": "Updated At",
         "type": "string"
      }
   },
   "required": [
      "id",
      "project_id",
      "user_name",
      "roles",
      "is_enabled",
      "is_locked",
      "updated_at"
   ]
}

Fields:
field id: str [Required]

User ID (UUID)

field project_id: str [Required]

Project ID (UUID)

field user_name: str [Required]

User name

field roles: list[str] [Required]

User roles

field is_enabled: bool [Required]

Whether user is enabled

field is_locked: bool [Required]

Whether user is locked

field description: str | None = None

User description

field updated_at: str [Required]

Update timestamp

pydantic model wy_qcos.api.schemas.user.DeleteUserRequest

基类：BaseModel

Delete user request by ID.

Show JSON schema
{
   "title": "DeleteUserRequest",
   "description": "Delete user request by ID.",
   "type": "object",
   "properties": {
      "user_id": {
         "description": "User ID (UUID)",
         "title": "User Id",
         "type": "string"
      },
      "force": {
         "default": false,
         "description": "Force delete user and cascade delete related resources",
         "title": "Force",
         "type": "boolean"
      }
   },
   "required": [
      "user_id"
   ]
}

Fields:
field user_id: str [Required]

User ID (UUID)

field force: bool = False

Force delete user and cascade delete related resources

pydantic model wy_qcos.api.schemas.user.DeleteUserResponse

基类：BaseModel

Delete user response.

Show JSON schema
{
   "title": "DeleteUserResponse",
   "description": "Delete user response.",
   "type": "object",
   "properties": {
      "id": {
         "description": "User ID (UUID)",
         "title": "Id",
         "type": "string"
      },
      "project_id": {
         "description": "Project ID (UUID)",
         "title": "Project Id",
         "type": "string"
      },
      "user_name": {
         "description": "User name",
         "title": "User Name",
         "type": "string"
      },
      "deleted_at": {
         "description": "Deletion timestamp",
         "title": "Deleted At",
         "type": "string"
      }
   },
   "required": [
      "id",
      "project_id",
      "user_name",
      "deleted_at"
   ]
}

Fields:
field id: str [Required]

User ID (UUID)

field project_id: str [Required]

Project ID (UUID)

field user_name: str [Required]

User name

field deleted_at: str [Required]

Deletion timestamp

pydantic model wy_qcos.api.schemas.user.LockUserRequest

基类：BaseModel

Lock user request.

Show JSON schema
{
   "title": "LockUserRequest",
   "description": "Lock user request.",
   "type": "object",
   "properties": {
      "user_name": {
         "description": "User name",
         "title": "User Name",
         "type": "string"
      },
      "action": {
         "description": "Action: lock or unlock",
         "title": "Action",
         "type": "string"
      }
   },
   "required": [
      "user_name",
      "action"
   ]
}

Fields:
field user_name: str [Required]

User name

field action: str [Required]

Action: lock or unlock

pydantic model wy_qcos.api.schemas.user.LockUserResponse

基类：BaseModel

Lock user response.

Show JSON schema
{
   "title": "LockUserResponse",
   "description": "Lock user response.",
   "type": "object",
   "properties": {
      "user_name": {
         "description": "User name",
         "title": "User Name",
         "type": "string"
      },
      "is_locked": {
         "description": "Whether user is locked",
         "title": "Is Locked",
         "type": "boolean"
      },
      "locked_until": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Locked until timestamp",
         "title": "Locked Until"
      },
      "message": {
         "description": "Action message",
         "title": "Message",
         "type": "string"
      }
   },
   "required": [
      "user_name",
      "is_locked",
      "message"
   ]
}

Fields:
field user_name: str [Required]

User name

field is_locked: bool [Required]

Whether user is locked

field locked_until: str | None = None

Locked until timestamp

field message: str [Required]

Action message

pydantic model wy_qcos.api.schemas.user.ChangePasswordRequest

基类：BaseModel

Change password request by user ID.

Show JSON schema
{
   "title": "ChangePasswordRequest",
   "description": "Change password request by user ID.",
   "type": "object",
   "properties": {
      "user_id": {
         "description": "User ID (UUID)",
         "title": "User Id",
         "type": "string"
      },
      "old_password": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Old password (for non-admin changes)",
         "is_sensitive": true,
         "title": "Old Password"
      },
      "new_password": {
         "description": "New password",
         "is_sensitive": true,
         "maxLength": 32,
         "minLength": 6,
         "title": "New Password",
         "type": "string"
      }
   },
   "required": [
      "user_id",
      "new_password"
   ]
}

Fields:
field user_id: str [Required]

User ID (UUID)

field old_password: str | None = None

Old password (for non-admin changes)

field new_password: str [Required]

New password

Constraints:

  • min_length = 6

  • max_length = 32

pydantic model wy_qcos.api.schemas.user.ChangePasswordResponse

基类：BaseModel

Change password response.

Show JSON schema
{
   "title": "ChangePasswordResponse",
   "description": "Change password response.",
   "type": "object",
   "properties": {
      "user_name": {
         "description": "User name",
         "title": "User Name",
         "type": "string"
      },
      "password_changed_at": {
         "description": "Password changed timestamp",
         "title": "Password Changed At",
         "type": "string"
      },
      "message": {
         "description": "Success message",
         "title": "Message",
         "type": "string"
      }
   },
   "required": [
      "user_name",
      "password_changed_at",
      "message"
   ]
}

Fields:
field user_name: str [Required]

User name

field password_changed_at: str [Required]

Password changed timestamp

field message: str [Required]

Success message

pydantic model wy_qcos.api.schemas.user.LoginLog

基类：BaseModel

Login log model.

Show JSON schema
{
   "title": "LoginLog",
   "description": "Login log model.",
   "type": "object",
   "properties": {
      "user_name": {
         "description": "User name",
         "title": "User Name",
         "type": "string"
      },
      "ip_address": {
         "description": "IP address",
         "title": "Ip Address",
         "type": "string"
      },
      "login_time": {
         "description": "Login time",
         "format": "date-time",
         "title": "Login Time",
         "type": "string"
      },
      "success": {
         "description": "Whether login was successful",
         "title": "Success",
         "type": "boolean"
      },
      "user_agent": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User agent",
         "title": "User Agent"
      },
      "failure_reason": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Reason for login failure if success is False",
         "title": "Failure Reason"
      }
   },
   "required": [
      "user_name",
      "ip_address",
      "success"
   ]
}

Fields:
field user_name: str [Required]

User name

field ip_address: str [Required]

IP address

field login_time: datetime [Optional]

Login time

field success: bool [Required]

Whether login was successful

field user_agent: str | None = None

User agent

field failure_reason: str | None = None

Reason for login failure if success is False

pydantic model wy_qcos.api.schemas.user.GetLoginLogsRequest

基类：BaseModel

Get login logs request by user ID or user_name.

Show JSON schema
{
   "title": "GetLoginLogsRequest",
   "description": "Get login logs request by user ID or user_name.",
   "type": "object",
   "properties": {
      "user_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Filter by user ID (UUID)",
         "title": "User Id"
      },
      "user_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Filter by user name",
         "title": "User Name"
      },
      "start_time": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Filter by start time (ISO format)",
         "title": "Start Time"
      },
      "end_time": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Filter by end time (ISO format)",
         "title": "End Time"
      },
      "limit": {
         "anyOf": [
            {
               "maximum": 1000,
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 100,
         "description": "Maximum number of logs to return",
         "title": "Limit"
      },
      "offset": {
         "anyOf": [
            {
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Number of logs to skip",
         "title": "Offset"
      }
   }
}

Fields:
Validators:
field user_id: str | None = None

Filter by user ID (UUID)

Validated by:
field user_name: str | None = None

Filter by user name

Validated by:
field start_time: str | None = None

Filter by start time (ISO format)

Validated by:
field end_time: str | None = None

Filter by end time (ISO format)

Validated by:
field limit: int | None = 100

Maximum number of logs to return

Constraints:

  • ge = 1

  • le = 1000

Validated by:
field offset: int | None = 0

Number of logs to skip

Constraints:

  • ge = 0

Validated by:
validator validate_user_filter  »  all fields

Ensure user_id and user_name are mutually exclusive.

pydantic model wy_qcos.api.schemas.user.LoginLogResponse

基类：BaseModel

Login log response.

Show JSON schema
{
   "title": "LoginLogResponse",
   "description": "Login log response.",
   "type": "object",
   "properties": {
      "user_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "User ID (UUID)",
         "title": "User Id"
      },
      "project_id": {
         "description": "Project ID (UUID)",
         "title": "Project Id",
         "type": "string"
      },
      "user_name": {
         "description": "User name",
         "title": "User Name",
         "type": "string"
      },
      "login_time": {
         "description": "Login timestamp",
         "title": "Login Time",
         "type": "string"
      },
      "ip_address": {
         "description": "IP address",
         "title": "Ip Address",
         "type": "string"
      },
      "user_agent": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User agent",
         "title": "User Agent"
      },
      "success": {
         "description": "Whether login was successful",
         "title": "Success",
         "type": "boolean"
      },
      "failure_reason": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Failed reason if login failed",
         "title": "Failure Reason"
      }
   },
   "required": [
      "user_id",
      "project_id",
      "user_name",
      "login_time",
      "ip_address",
      "success"
   ]
}

Fields:
field user_id: str | None [Required]

User ID (UUID)

field project_id: str [Required]

Project ID (UUID)

field user_name: str [Required]

User name

field login_time: str [Required]

Login timestamp

field ip_address: str [Required]

IP address

field user_agent: str | None = None

User agent

field success: bool [Required]

Whether login was successful

field failure_reason: str | None = None

Failed reason if login failed

pydantic model wy_qcos.api.schemas.user.Role

基类：BaseModel

Role model.

Show JSON schema
{
   "title": "Role",
   "description": "Role model.",
   "type": "object",
   "properties": {
      "id": {
         "description": "Role ID (UUID)",
         "title": "Id",
         "type": "string"
      },
      "role_name": {
         "description": "Role name",
         "title": "Role Name",
         "type": "string"
      },
      "permissions": {
         "default": [],
         "description": "Role permissions",
         "items": {
            "type": "string"
         },
         "title": "Permissions",
         "type": "array"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Role description",
         "title": "Description"
      }
   },
   "required": [
      "role_name"
   ]
}

Config:

  • from_attributes: bool = True

Fields:
field id: str [Optional]

Role ID (UUID)

field role_name: str [Required]

Role name

field permissions: list[str] = []

Role permissions

field description: str | None = None

Role description

pydantic model wy_qcos.api.schemas.user.CreateRoleRequest

基类：BaseModel

Create role request.

Show JSON schema
{
   "title": "CreateRoleRequest",
   "description": "Create role request.",
   "type": "object",
   "properties": {
      "role_name": {
         "description": "Role name",
         "maxLength": 64,
         "minLength": 2,
         "title": "Role Name",
         "type": "string"
      },
      "permissions": {
         "default": [],
         "description": "Role permissions",
         "items": {
            "type": "string"
         },
         "title": "Permissions",
         "type": "array"
      },
      "description": {
         "anyOf": [
            {
               "maxLength": 255,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Role description",
         "title": "Description"
      }
   },
   "required": [
      "role_name"
   ]
}

Fields:
field role_name: str [Required]

Role name

Constraints:

  • min_length = 2

  • max_length = 64

field permissions: list[str] = []

Role permissions

field description: str | None = None

Role description

Constraints:

  • min_length = 1

  • max_length = 255

pydantic model wy_qcos.api.schemas.user.CreateRoleResponse

基类：BaseModel

Create role response.

Show JSON schema
{
   "title": "CreateRoleResponse",
   "description": "Create role response.",
   "type": "object",
   "properties": {
      "id": {
         "description": "Role ID (UUID)",
         "title": "Id",
         "type": "string"
      },
      "role_name": {
         "description": "Role name",
         "title": "Role Name",
         "type": "string"
      },
      "permissions": {
         "description": "Role permissions",
         "items": {
            "type": "string"
         },
         "title": "Permissions",
         "type": "array"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Role description",
         "title": "Description"
      }
   },
   "required": [
      "id",
      "role_name",
      "permissions"
   ]
}

Fields:
field id: str [Required]

Role ID (UUID)

field role_name: str [Required]

Role name

field permissions: list[str] [Required]

Role permissions

field description: str | None = None

Role description

pydantic model wy_qcos.api.schemas.user.GetRoleRequest

基类：BaseModel

Get role request by ID.

Show JSON schema
{
   "title": "GetRoleRequest",
   "description": "Get role request by ID.",
   "type": "object",
   "properties": {
      "role_id": {
         "description": "Role ID (UUID)",
         "title": "Role Id",
         "type": "string"
      }
   },
   "required": [
      "role_id"
   ]
}

Fields:
field role_id: str [Required]

Role ID (UUID)

pydantic model wy_qcos.api.schemas.user.GetRoleResponse

基类：BaseModel

Get role response.

Show JSON schema
{
   "title": "GetRoleResponse",
   "description": "Get role response.",
   "type": "object",
   "properties": {
      "id": {
         "description": "Role ID (UUID)",
         "title": "Id",
         "type": "string"
      },
      "role_name": {
         "description": "Role name",
         "title": "Role Name",
         "type": "string"
      },
      "permissions": {
         "description": "Role permissions",
         "items": {
            "type": "string"
         },
         "title": "Permissions",
         "type": "array"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Role description",
         "title": "Description"
      }
   },
   "required": [
      "id",
      "role_name",
      "permissions"
   ]
}

Fields:
field id: str [Required]

Role ID (UUID)

field role_name: str [Required]

Role name

field permissions: list[str] [Required]

Role permissions

field description: str | None = None

Role description

pydantic model wy_qcos.api.schemas.user.GetRolesRequest

基类：BaseModel

Get roles request with optional filtering.

Show JSON schema
{
   "title": "GetRolesRequest",
   "description": "Get roles request with optional filtering.",
   "type": "object",
   "properties": {
      "filters": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Filter conditions dict, e.g. {'role_name': 'admin'}",
         "title": "Filters"
      }
   }
}

Fields:
field filters: dict | None = None

Filter conditions dict, e.g. {'role_name': 'admin'}

pydantic model wy_qcos.api.schemas.user.UpdateRoleRequest

基类：BaseModel

Update role request by ID.

Show JSON schema
{
   "title": "UpdateRoleRequest",
   "description": "Update role request by ID.",
   "type": "object",
   "properties": {
      "role_id": {
         "description": "Role ID (UUID)",
         "title": "Role Id",
         "type": "string"
      },
      "permissions": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Role permissions",
         "title": "Permissions"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Role description",
         "title": "Description"
      }
   },
   "required": [
      "role_id"
   ]
}

Fields:
field role_id: str [Required]

Role ID (UUID)

field permissions: list[str] | None = None

Role permissions

field description: str | None = None

Role description

pydantic model wy_qcos.api.schemas.user.UpdateRoleResponse

基类：BaseModel

Update role response.

Show JSON schema
{
   "title": "UpdateRoleResponse",
   "description": "Update role response.",
   "type": "object",
   "properties": {
      "role_name": {
         "description": "Role name",
         "title": "Role Name",
         "type": "string"
      },
      "permissions": {
         "description": "Role permissions",
         "items": {
            "type": "string"
         },
         "title": "Permissions",
         "type": "array"
      },
      "description": {
         "description": "Role description",
         "title": "Description",
         "type": "string"
      }
   },
   "required": [
      "role_name",
      "permissions",
      "description"
   ]
}

Fields:
field role_name: str [Required]

Role name

field permissions: list[str] [Required]

Role permissions

field description: str [Required]

Role description

pydantic model wy_qcos.api.schemas.user.DeleteRoleRequest

基类：BaseModel

Delete role request by ID.

Show JSON schema
{
   "title": "DeleteRoleRequest",
   "description": "Delete role request by ID.",
   "type": "object",
   "properties": {
      "role_id": {
         "description": "Role ID (UUID)",
         "title": "Role Id",
         "type": "string"
      }
   },
   "required": [
      "role_id"
   ]
}

Fields:
field role_id: str [Required]

Role ID (UUID)

pydantic model wy_qcos.api.schemas.user.DeleteRoleResponse

基类：BaseModel

Delete role response.

Show JSON schema
{
   "title": "DeleteRoleResponse",
   "description": "Delete role response.",
   "type": "object",
   "properties": {
      "role_name": {
         "description": "Role name",
         "title": "Role Name",
         "type": "string"
      }
   },
   "required": [
      "role_name"
   ]
}

Fields:
field role_name: str [Required]

Role name

pydantic model wy_qcos.api.schemas.user.ClearLoginLogsRequest

基类：BaseModel

Clear login logs request.

Show JSON schema
{
   "title": "ClearLoginLogsRequest",
   "description": "Clear login logs request.",
   "type": "object",
   "properties": {
      "user_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Clear logs for specific user ID (UUID)",
         "title": "User Id"
      },
      "user_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Clear logs for specific user name",
         "title": "User Name"
      }
   }
}

Fields:
Validators:
field user_id: str | None = None

Clear logs for specific user ID (UUID)

Validated by:
field user_name: str | None = None

Clear logs for specific user name

Validated by:
validator validate_user_filter  »  all fields

Ensure user_id and user_name are mutually exclusive.

wy_qcos.api.schemas.version module

pydantic model wy_qcos.api.schemas.version.GetVersionRequest

基类：BaseModel

Get Version Request.

Pydantic Model for Get Version Request.

Show JSON schema
{
   "title": "GetVersionRequest",
   "description": "Get Version Request.\n\nPydantic Model for Get Version Request.",
   "type": "object",
   "properties": {}
}

pydantic model wy_qcos.api.schemas.version.GetVersionResponse

基类：BaseModel

Get Version Response.

Pydantic Model for Get Version Response.

Show JSON schema
{
   "title": "GetVersionResponse",
   "description": "Get Version Response.\n\nPydantic Model for Get Version Response.",
   "type": "object",
   "properties": {
      "version": {
         "description": "version",
         "title": "Version",
         "type": "string"
      },
      "api_version": {
         "description": "api version",
         "title": "Api Version",
         "type": "string"
      },
      "supported_api_versions": {
         "description": "supported api versions",
         "items": {
            "additionalProperties": true,
            "type": "object"
         },
         "title": "Supported Api Versions",
         "type": "array"
      },
      "platform_version": {
         "description": "platform version",
         "title": "Platform Version",
         "type": "string"
      },
      "capabilities": {
         "additionalProperties": true,
         "description": "capabilities",
         "title": "Capabilities",
         "type": "object"
      }
   },
   "required": [
      "version",
      "api_version",
      "supported_api_versions",
      "platform_version",
      "capabilities"
   ]
}

Fields:
field version: str [Required]

version

field api_version: str [Required]

api version

field supported_api_versions: list[dict] [Required]

supported api versions

field platform_version: str [Required]

platform version

field capabilities: dict [Required]

capabilities

Module contents