wy_qcos.api.schemas package

Submodules

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:

• details (bool)

• name (str)

field details: bool [Required]

Details info needed or not

field name: str [Required]

Device name

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"
      },
      "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",
      "tech_type",
      "max_qubits"
   ]
}

Fields:

• alias_name (str | None)

• configs (dict | None)

• description (str | None)

• details (dict | None)

• driver_name (str)

• enable (bool)

• max_qubits (int)

• name (str)

• status (str)

• tech_type (str)

field alias_name: str | None = None

Device alias name

field configs: dict | None = None

Device configurations

field description: str | None = None

Description

field details: dict | None = None

Details info

field driver_name: str [Required]

Driver name

field enable: bool [Required]

Device enable status

field max_qubits: int [Required]

Maximum number of qubits

field name: str [Required]

Device name

field status: str [Required]

Device status

field tech_type: str [Required]

Technology type

pydantic model wy_qcos.api.schemas.device.CalibrateDeviceRequest

基类：BaseModel

Get Device Properities.

Pydantic Model for Get Device Properities.

Show JSON schema

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

Fields:

• device_name (str)

• options (dict | None)

field device_name: str [Required]

Device name

field options: dict | None = None

Calibrate Options

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"
      },
      "device_options": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Device Options",
         "title": "Device Options"
      }
   },
   "required": [
      "device_name"
   ]
}

Fields:

• device_name (str)

• device_options (dict | None)

field device_name: str [Required]

Device name

field device_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": {
      "results": {
         "additionalProperties": true,
         "description": "Results",
         "title": "Results",
         "type": "object"
      }
   },
   "required": [
      "results"
   ]
}

Fields:

• results (dict)

field results: dict [Required]

Results

pydantic model wy_qcos.api.schemas.device.EnableAndDisableQubitRequest

基类：BaseModel

Enable and Disable Qubit.

Pydantic Model for Enable and Disable Qubit.

Show JSON schema

{
   "title": "EnableAndDisableQubitRequest",
   "description": "Enable and Disable Qubit.\n\nPydantic Model for Enable and Disable Qubit.",
   "type": "object",
   "properties": {
      "device_name": {
         "description": "Device name",
         "title": "Device Name",
         "type": "string"
      },
      "qubits": {
         "additionalProperties": true,
         "description": "Qubits",
         "title": "Qubits",
         "type": "object"
      }
   },
   "required": [
      "device_name",
      "qubits"
   ]
}

Fields:

• device_name (str)

• qubits (dict)

field device_name: str [Required]

Device name

field qubits: dict [Required]

Qubits

pydantic model wy_qcos.api.schemas.device.EnableAndDisableQubitResponse

基类：BaseModel

Enable and Disable Qubit Response.

Pydantic Model for Enable and Disable Qubit Response.

Show JSON schema

{
   "title": "EnableAndDisableQubitResponse",
   "description": "Enable and Disable Qubit Response.\n\nPydantic Model for Enable and Disable Qubit Response.",
   "type": "object",
   "properties": {
      "results": {
         "additionalProperties": true,
         "description": "Results",
         "title": "Results",
         "type": "object"
      }
   },
   "required": [
      "results"
   ]
}

Fields:

• results (dict)

field results: dict [Required]

Results

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:

• name (str)

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:

• alias_name (str | None)

• description (str)

• enable_circuit_aggregation (bool)

• max_qubits (int)

• name (str)

• results_fetch_mode (str)

• supported_basis_gates (list | None)

• supported_code_types (list)

• supported_transpilers (list)

• tech_type (str)

• transpiler (str | None)

• version (str)

field alias_name: str | None = None

Driver alias name

field description: str [Required]

Driver description

field enable_circuit_aggregation: bool [Required]

Enable circuit aggregation

field max_qubits: int [Required]

Maximum number of qubits

field name: str [Required]

Driver name

field results_fetch_mode: str [Required]

Results fetch mode

field supported_basis_gates: list | None = None

Supported basis gates

field supported_code_types: list [Required]

Supported code types

field supported_transpilers: list [Required]

Supported transpilers

field tech_type: str [Required]

Technology type

field transpiler: str | None = None

Transpiler

field version: str [Required]

Driver version

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:

• backend (str)

• callbacks (list | None)

• circuit_aggregation (str | None)

• code_type (str)

• creation_date (datetime.datetime | None)

• description (str | None)

• driver_options (dict | None)

• dry_run (bool)

• job_id (uuid.UUID | None)

• job_name (str | None)

• job_priority (int)

• job_type (str)

• profiling (list | None)

• shots (int)

• source_code (list)

• transpiler (str | None)

• transpiler_options (dict | None)

field backend: str = 'dummy'

Backend device name

field callbacks: list | None = None

Callbacks

field circuit_aggregation: str | None = None

Circuit aggregation: internal, multi

field code_type: str = 'qasm'

Code types: qasm, qasm2, qasm3, qubo

field creation_date: datetime | None = None

Creation date

field description: str | None = None

Job description

field driver_options: dict | None = None

Driver options

field dry_run: bool = False

Dry-run flag

field job_id: UUID | None = None

Job ID

field job_name: str | None = None

Job name

field job_priority: int = 5

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

field job_type: str = 'sampling'

Job type

field profiling: list | None = None

Profiling

field shots: int = 1

Shots

field source_code: list = []

Source code list

field transpiler: str | None = None

Transpiler

field transpiler_options: dict | None = None

Transpiler options

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:

• backend (str)

• callbacks (list | None)

• circuit_aggregation (str | None)

• code_type (str)

• creation_date (datetime.datetime)

• description (str | None)

• driver_options (dict | None)

• dry_run (bool)

• end_date (datetime.datetime | None)

• job_id (uuid.UUID)

• job_name (str | None)

• job_priority (int)

• job_status (str)

• job_type (str)

• profiling (list | None)

• shots (int)

• source_code (list)

• transpiler (str | None)

• transpiler_options (dict | None)

field backend: str [Required]

Backend device name

field callbacks: list | None = None

Callbacks

field circuit_aggregation: str | None = None

Circuit aggregation: internal, multi

field code_type: str [Required]

Code type

field creation_date: datetime [Required]

Creation date

field description: str | None = None

Description

field driver_options: dict | None = None

Driver options

field dry_run: bool [Required]

Dry-run flag

field end_date: datetime | None = None

End date

field job_id: UUID [Required]

Job ID

field job_name: str | None = None

Job name

field job_priority: int = 5

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

field job_status: str [Required]

Job status

field job_type: str [Required]

Job type

field profiling: list | None = None

Profiling

field shots: int [Required]

Shots

field source_code: list [Required]

Source code list

field transpiler: str | None = None

Transpiler

field transpiler_options: dict | None = None

Transpiler options

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:

• job_id (uuid.UUID)

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:

• backend (str)

• circuit_aggregation (str | None)

• creation_date (datetime.datetime)

• description (str | None)

• driver_options (dict | None)

• dry_run (bool)

• end_date (datetime.datetime | None)

• job_id (uuid.UUID)

• job_name (str | None)

• job_priority (int)

• job_status (str)

• progress (int | None)

• shots (int)

• transpiler (str | None)

• transpiler_options (dict | None)

field backend: str [Required]

Backend device name

field circuit_aggregation: str | None = None

Circuit aggregation: internal, multi

field creation_date: datetime [Required]

Creation date

field description: str | None = None

Description

field driver_options: dict | None = None

Driver options

field dry_run: bool [Required]

Dry-run flag

field end_date: datetime | None = None

End date

field job_id: UUID [Required]

Job ID

field job_name: str | None = None

Job name

field job_priority: int = 5

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

field job_status: str [Required]

Job status

field progress: int | None = -1

Progress

field shots: int [Required]

Shots

field transpiler: str | None = None

Transpiler

field transpiler_options: dict | None = None

Transpiler options

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:

• job_id (uuid.UUID)

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:

• backend (str)

• circuit_aggregation (str | None)

• code_type (str)

• creation_date (datetime.datetime)

• description (str | None)

• driver_options (dict | None)

• dry_run (bool)

• end_date (datetime.datetime | None)

• job_id (uuid.UUID)

• job_name (str | None)

• job_priority (int)

• job_status (str)

• progress (int | None)

• results (str | int | list | dict | None)

• shots (int)

• source_code (list)

• transpiler (str | None)

• transpiler_options (dict | None)

field backend: str [Required]

Backend device name

field circuit_aggregation: str | None = None

Circuit aggregation: internal, multi

field code_type: str [Required]

Code type

field creation_date: datetime [Required]

Creation date

field description: str | None = None

Description

field driver_options: dict | None = None

Driver options

field dry_run: bool [Required]

Dry-run flag

field end_date: datetime | None = None

End date

field job_id: UUID [Required]

Job ID

field job_name: str | None = None

Job name

field job_priority: int = 5

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

field job_status: str [Required]

Job status

field progress: int | None = -1

Progress

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

Results

field shots: int [Required]

Shots

field source_code: list [Required]

Source code list

field transpiler: str | None = None

Transpiler

field transpiler_options: dict | None = None

Transpiler options

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:

• job_ids (list[uuid.UUID])

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:

• job_id (uuid.UUID)

• job_status (str)

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:

• job_ids (list[uuid.UUID])

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:

• job_id (uuid.UUID)

• job_status (str)

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:

• errors (str | int | list | dict | None)

• job_id (uuid.UUID)

• results (list)

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

Errors

field job_id: UUID [Required]

Job ID

field results: list [Required]

Job results

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:

• backend (str)

• job_id (uuid.UUID)

• job_status (str)

field backend: str [Required]

Backend device name

field job_id: UUID [Required]

Job ID

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:

• job_id (uuid.UUID)

• job_priority (int | None)

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:

• backend (str)

• callbacks (list | None)

• circuit_aggregation (str | None)

• code_type (str)

• creation_date (datetime.datetime)

• description (str | None)

• driver_options (dict | None)

• dry_run (bool)

• end_date (datetime.datetime | None)

• job_id (uuid.UUID)

• job_name (str | None)

• job_priority (int)

• job_status (str)

• job_type (str)

• profiling (list | None)

• shots (int)

• source_code (list)

• transpiler (str | None)

• transpiler_options (dict | None)

field backend: str [Required]

Backend device name

field callbacks: list | None = None

Callbacks

field circuit_aggregation: str | None = None

Circuit aggregation: internal, multi

field code_type: str [Required]

Code type

field creation_date: datetime [Required]

Creation date

field description: str | None = None

Description

field driver_options: dict | None = None

Driver options

field dry_run: bool [Required]

Dry-run flag

field end_date: datetime | None = None

End date

field job_id: UUID [Required]

Job ID

field job_name: str | None = None

Job name

field job_priority: int = 5

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

field job_status: str [Required]

Job status

field job_type: str [Required]

Job type

field profiling: list | None = None

Profiling

field shots: int [Required]

Shots

field source_code: list [Required]

Source code list

field transpiler: str | None = None

Transpiler

field transpiler_options: dict | None = None

Transpiler options

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:

• message (str | None)

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:

• message (str | None)

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:

• total_jobs_count (int)

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:

• name (str)

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:

• alias_name (str | None)

• enable (bool)

• name (str)

• supported_code_types (list)

• transpiler_options (dict | None)

• transpiler_options_schema (dict | None)

• version (str | None)

field alias_name: str | None = None

transpiler alias name

field enable: bool = True

enable this transpiler or not

field name: str [Required]

transpiler name

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

field version: str | None = None

version

wy_qcos.api.schemas.user module

pydantic model wy_qcos.api.schemas.user.CreateUserRequest

基类：BaseModel

Create user request.

Show JSON schema

{
   "title": "CreateUserRequest",
   "description": "Create user request.",
   "type": "object",
   "properties": {
      "username": {
         "description": "Username",
         "maxLength": 50,
         "minLength": 3,
         "title": "Username",
         "type": "string"
      },
      "password": {
         "description": "Password",
         "minLength": 6,
         "title": "Password",
         "type": "string"
      }
   },
   "required": [
      "username",
      "password"
   ]
}

Fields:

• password (str)

• username (str)

field password: str [Required]

Password

Constraints:

• min_length = 6

field username: str [Required]

Username

Constraints:

• min_length = 3

• max_length = 50

pydantic model wy_qcos.api.schemas.user.UpdateUserRequest

基类：BaseModel

Update user request.

Show JSON schema

{
   "title": "UpdateUserRequest",
   "description": "Update user request.",
   "type": "object",
   "properties": {
      "username": {
         "description": "Username",
         "title": "Username",
         "type": "string"
      },
      "password": {
         "description": "Password",
         "minLength": 6,
         "title": "Password",
         "type": "string"
      }
   },
   "required": [
      "username",
      "password"
   ]
}

Fields:

• password (str)

• username (str)

field password: str [Required]

Password

Constraints:

• min_length = 6

field username: str [Required]

Username

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:

• api_version (str)

• capabilities (dict)

• platform_version (str)

• supported_api_versions (list[dict])

• version (str)

field api_version: str [Required]

api version

field capabilities: dict [Required]

capabilities

field platform_version: str [Required]

platform version

field supported_api_versions: list[dict] [Required]

supported api versions

field version: str [Required]

version

Module contents