Files
next-tjwater-server/contracts/peripheral-sample.openapi.json
T

4004 lines
100 KiB
JSON

{
"components": {
"schemas": {
"Alert": {
"additionalProperties": false,
"properties": {
"alert_id": {
"title": "Alert Id",
"type": "string"
},
"message": {
"title": "Message",
"type": "string"
},
"occurred_at": {
"format": "date-time",
"title": "Occurred At",
"type": "string"
},
"origin": {
"enum": [
"historical_replay",
"synthetic"
],
"title": "Origin",
"type": "string"
},
"point_id": {
"title": "Point Id",
"type": "string"
}
},
"required": [
"alert_id",
"point_id",
"occurred_at",
"message",
"origin"
],
"title": "Alert",
"type": "object"
},
"AlertPage": {
"additionalProperties": false,
"properties": {
"availability": {
"enum": [
"available",
"not_configured"
],
"title": "Availability",
"type": "string"
},
"items": {
"items": {
"$ref": "#/components/schemas/Alert"
},
"title": "Items",
"type": "array"
},
"origin": {
"enum": [
"historical_replay",
"synthetic"
],
"title": "Origin",
"type": "string"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason"
},
"source_id": {
"title": "Source Id",
"type": "string"
}
},
"required": [
"items",
"source_id",
"origin",
"availability",
"reason"
],
"title": "AlertPage",
"type": "object"
},
"Context": {
"additionalProperties": false,
"properties": {
"can_write": {
"title": "Can Write",
"type": "boolean"
},
"managed_resources": {
"$ref": "#/components/schemas/ManagedResourceCapabilities"
},
"origin": {
"const": "synthetic",
"title": "Origin",
"type": "string"
},
"project_id": {
"format": "uuid",
"title": "Project Id",
"type": "string"
},
"protocol_version": {
"const": "tjwater-peripheral-sample@1",
"title": "Protocol Version",
"type": "string"
},
"scenarios": {
"items": {
"enum": [
"normal",
"missing_data",
"unavailable",
"response_lost",
"duplicate_feedback",
"conflicting_feedback",
"late_state"
],
"type": "string"
},
"title": "Scenarios",
"type": "array"
},
"state_transitions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"title": "State Transitions",
"type": "object"
},
"user_id": {
"format": "uuid",
"title": "User Id",
"type": "string"
}
},
"required": [
"protocol_version",
"origin",
"project_id",
"user_id",
"can_write",
"scenarios",
"state_transitions",
"managed_resources"
],
"title": "Context",
"type": "object"
},
"CreateTestDataRecord": {
"additionalProperties": false,
"properties": {
"label": {
"maxLength": 200,
"minLength": 1,
"title": "Label",
"type": "string"
},
"notes": {
"default": "",
"maxLength": 4000,
"title": "Notes",
"type": "string"
},
"observed_at": {
"format": "date-time",
"title": "Observed At",
"type": "string"
},
"point_id": {
"maxLength": 128,
"minLength": 1,
"title": "Point Id",
"type": "string"
},
"quality": {
"default": "valid",
"enum": [
"valid",
"unknown",
"missing"
],
"title": "Quality",
"type": "string"
},
"request_id": {
"format": "uuid",
"title": "Request Id",
"type": "string"
},
"unit": {
"maxLength": 32,
"minLength": 1,
"title": "Unit",
"type": "string"
},
"value": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Value"
}
},
"required": [
"request_id",
"label",
"point_id",
"observed_at",
"value",
"unit"
],
"title": "CreateTestDataRecord",
"type": "object"
},
"CreateWorkOrder": {
"additionalProperties": false,
"properties": {
"assignee": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Assignee"
},
"location": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Location"
},
"priority": {
"default": "normal",
"enum": [
"low",
"normal",
"high",
"urgent"
],
"title": "Priority",
"type": "string"
},
"request_id": {
"format": "uuid",
"title": "Request Id",
"type": "string"
},
"scenario_code": {
"anyOf": [
{
"maxLength": 128,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Scenario Code"
},
"scheduled_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Scheduled At"
},
"status": {
"default": "draft",
"enum": [
"draft",
"open",
"in_progress",
"awaiting_reply",
"completed",
"cancelled"
],
"title": "Status",
"type": "string"
},
"subtasks": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkbenchRuntimeWorkOrderSubtask"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"title": "Subtasks"
},
"summary": {
"maxLength": 4000,
"minLength": 1,
"title": "Summary",
"type": "string"
},
"title": {
"maxLength": 200,
"minLength": 1,
"title": "Title",
"type": "string"
},
"work_order_type": {
"default": "general",
"enum": [
"general",
"water_quality_complaint",
"burst_report"
],
"title": "Work Order Type",
"type": "string"
}
},
"required": [
"request_id",
"title",
"summary"
],
"title": "CreateWorkOrder",
"type": "object"
},
"DeleteResource": {
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1.0,
"title": "Expected Revision",
"type": "integer"
},
"request_id": {
"format": "uuid",
"title": "Request Id",
"type": "string"
}
},
"required": [
"request_id",
"expected_revision"
],
"title": "DeleteResource",
"type": "object"
},
"DeletedResource": {
"additionalProperties": false,
"properties": {
"deleted": {
"const": true,
"title": "Deleted",
"type": "boolean"
},
"resource_id": {
"format": "uuid",
"title": "Resource Id",
"type": "string"
},
"resource_type": {
"enum": [
"work_order",
"test_data_record"
],
"title": "Resource Type",
"type": "string"
},
"revision": {
"minimum": 2.0,
"title": "Revision",
"type": "integer"
}
},
"required": [
"resource_type",
"resource_id",
"revision",
"deleted"
],
"title": "DeletedResource",
"type": "object"
},
"DemoAlert": {
"additionalProperties": false,
"properties": {
"alert_id": {
"format": "uuid",
"title": "Alert Id",
"type": "string"
},
"asset_id": {
"title": "Asset Id",
"type": "string"
},
"cleared_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Cleared At"
},
"code": {
"enum": [
"communication_lost",
"low_level"
],
"title": "Code",
"type": "string"
},
"message": {
"title": "Message",
"type": "string"
},
"occurred_at": {
"format": "date-time",
"title": "Occurred At",
"type": "string"
}
},
"required": [
"alert_id",
"asset_id",
"occurred_at",
"cleared_at",
"code",
"message"
],
"title": "DemoAlert",
"type": "object"
},
"DemoDataset": {
"additionalProperties": false,
"properties": {
"alerts": {
"items": {
"$ref": "#/components/schemas/DemoAlert"
},
"title": "Alerts",
"type": "array"
},
"device_states": {
"items": {
"$ref": "#/components/schemas/DemoDeviceState"
},
"title": "Device States",
"type": "array"
},
"generator_version": {
"const": "water-demo@2",
"title": "Generator Version",
"type": "string"
},
"observations": {
"items": {
"$ref": "#/components/schemas/Observation"
},
"title": "Observations",
"type": "array"
},
"operations": {
"items": {
"$ref": "#/components/schemas/DemoOperation"
},
"title": "Operations",
"type": "array"
},
"origin": {
"const": "synthetic",
"title": "Origin",
"type": "string"
},
"points": {
"items": {
"$ref": "#/components/schemas/Point"
},
"title": "Points",
"type": "array"
},
"project_id": {
"format": "uuid",
"title": "Project Id",
"type": "string"
},
"seed": {
"title": "Seed",
"type": "string"
},
"source_id": {
"title": "Source Id",
"type": "string"
},
"source_revision": {
"title": "Source Revision",
"type": "string"
},
"window": {
"$ref": "#/components/schemas/TimeRange"
}
},
"required": [
"generator_version",
"seed",
"origin",
"window",
"points",
"observations",
"device_states",
"alerts",
"operations",
"project_id",
"source_id",
"source_revision"
],
"title": "DemoDataset",
"type": "object"
},
"DemoDeviceState": {
"additionalProperties": false,
"properties": {
"asset_id": {
"title": "Asset Id",
"type": "string"
},
"asset_type": {
"enum": [
"pressure_sensor",
"pump",
"valve"
],
"title": "Asset Type",
"type": "string"
},
"observed_at": {
"format": "date-time",
"title": "Observed At",
"type": "string"
},
"record_id": {
"format": "uuid",
"title": "Record Id",
"type": "string"
},
"state": {
"enum": [
"online",
"offline",
"running",
"stopped",
"open",
"closed"
],
"title": "State",
"type": "string"
}
},
"required": [
"record_id",
"asset_id",
"asset_type",
"observed_at",
"state"
],
"title": "DemoDeviceState",
"type": "object"
},
"DemoOperation": {
"additionalProperties": false,
"properties": {
"actor": {
"const": "synthetic-generator",
"title": "Actor",
"type": "string"
},
"asset_id": {
"title": "Asset Id",
"type": "string"
},
"note": {
"title": "Note",
"type": "string"
},
"occurred_at": {
"format": "date-time",
"title": "Occurred At",
"type": "string"
},
"operation": {
"enum": [
"pump_start",
"pump_stop",
"valve_open",
"valve_close"
],
"title": "Operation",
"type": "string"
},
"record_id": {
"format": "uuid",
"title": "Record Id",
"type": "string"
}
},
"required": [
"record_id",
"asset_id",
"occurred_at",
"operation",
"actor",
"note"
],
"title": "DemoOperation",
"type": "object"
},
"Feedback": {
"additionalProperties": false,
"properties": {
"applicable_time": {
"$ref": "#/components/schemas/TimeRange"
},
"asset_ids": {
"items": {
"type": "string"
},
"title": "Asset Ids",
"type": "array"
},
"attachment_refs": {
"items": {
"type": "string"
},
"title": "Attachment Refs",
"type": "array"
},
"feedback_id": {
"format": "uuid",
"title": "Feedback Id",
"type": "string"
},
"finding": {
"enum": [
"instrument_fault",
"no_instrument_fault",
"uncertain"
],
"title": "Finding",
"type": "string"
},
"notes": {
"title": "Notes",
"type": "string"
},
"occurred_at": {
"format": "date-time",
"title": "Occurred At",
"type": "string"
},
"origin": {
"const": "synthetic",
"title": "Origin",
"type": "string"
},
"recorded_at": {
"format": "date-time",
"title": "Recorded At",
"type": "string"
},
"recorded_by": {
"title": "Recorded By",
"type": "string"
},
"task_id": {
"format": "uuid",
"title": "Task Id",
"type": "string"
}
},
"required": [
"feedback_id",
"task_id",
"recorded_by",
"recorded_at",
"occurred_at",
"applicable_time",
"asset_ids",
"finding",
"notes",
"attachment_refs",
"origin"
],
"title": "Feedback",
"type": "object"
},
"HistoryEntry": {
"additionalProperties": false,
"properties": {
"actor": {
"title": "Actor",
"type": "string"
},
"at": {
"format": "date-time",
"title": "At",
"type": "string"
},
"from_status": {
"anyOf": [
{
"enum": [
"pending",
"processing",
"pending_review",
"completed"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "From Status"
},
"reason": {
"title": "Reason",
"type": "string"
},
"sequence": {
"minimum": 1.0,
"title": "Sequence",
"type": "integer"
},
"to_status": {
"enum": [
"pending",
"processing",
"pending_review",
"completed"
],
"title": "To Status",
"type": "string"
}
},
"required": [
"sequence",
"from_status",
"to_status",
"actor",
"at",
"reason"
],
"title": "HistoryEntry",
"type": "object"
},
"ManagedResourceCapabilities": {
"additionalProperties": false,
"properties": {
"test_data": {
"enum": [
"available",
"not_configured"
],
"title": "Test Data",
"type": "string"
},
"work_orders": {
"enum": [
"available",
"not_configured"
],
"title": "Work Orders",
"type": "string"
}
},
"required": [
"work_orders",
"test_data"
],
"title": "ManagedResourceCapabilities",
"type": "object"
},
"ObjectRef": {
"additionalProperties": false,
"properties": {
"object_id": {
"format": "uuid",
"title": "Object Id",
"type": "string"
},
"object_type": {
"enum": [
"analysis_task",
"goal",
"state_snapshot",
"action_contract",
"validation",
"run",
"outcome",
"evidence",
"artifact",
"operation"
],
"title": "Object Type",
"type": "string"
},
"revision": {
"minimum": 1.0,
"title": "Revision",
"type": "integer"
}
},
"required": [
"object_type",
"object_id",
"revision"
],
"title": "ObjectRef",
"type": "object"
},
"Observation": {
"additionalProperties": false,
"properties": {
"observed_at": {
"format": "date-time",
"title": "Observed At",
"type": "string"
},
"point_id": {
"title": "Point Id",
"type": "string"
},
"quality": {
"enum": [
"valid",
"unknown",
"missing"
],
"title": "Quality",
"type": "string"
},
"record_id": {
"title": "Record Id",
"type": "string"
},
"unit": {
"title": "Unit",
"type": "string"
},
"value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Value"
}
},
"required": [
"record_id",
"point_id",
"observed_at",
"value",
"quality",
"unit"
],
"title": "Observation",
"type": "object"
},
"Observations": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Observation"
},
"title": "Items",
"type": "array"
},
"origin": {
"enum": [
"historical_replay",
"synthetic"
],
"title": "Origin",
"type": "string"
},
"source_id": {
"title": "Source Id",
"type": "string"
},
"source_revision": {
"title": "Source Revision",
"type": "string"
},
"truncated": {
"title": "Truncated",
"type": "boolean"
}
},
"required": [
"origin",
"source_id",
"source_revision",
"items",
"truncated"
],
"title": "Observations",
"type": "object"
},
"Point": {
"additionalProperties": false,
"properties": {
"label": {
"title": "Label",
"type": "string"
},
"origin": {
"enum": [
"historical_replay",
"synthetic"
],
"title": "Origin",
"type": "string"
},
"point_id": {
"title": "Point Id",
"type": "string"
},
"status": {
"title": "Status",
"type": "string"
},
"unit": {
"title": "Unit",
"type": "string"
}
},
"required": [
"point_id",
"label",
"unit",
"status",
"origin"
],
"title": "Point",
"type": "object"
},
"PointPage": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Point"
},
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
},
"origin": {
"enum": [
"historical_replay",
"synthetic"
],
"title": "Origin",
"type": "string"
},
"source_id": {
"title": "Source Id",
"type": "string"
}
},
"required": [
"items",
"source_id",
"origin",
"next_cursor"
],
"title": "PointPage",
"type": "object"
},
"Receipt": {
"additionalProperties": false,
"properties": {
"request_id": {
"format": "uuid",
"title": "Request Id",
"type": "string"
},
"result": {
"anyOf": [
{
"$ref": "#/components/schemas/Task"
},
{
"$ref": "#/components/schemas/ScenarioState"
},
{
"$ref": "#/components/schemas/WorkOrder"
},
{
"$ref": "#/components/schemas/TestDataRecord"
},
{
"$ref": "#/components/schemas/DeletedResource"
}
],
"title": "Result"
},
"task_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Id"
}
},
"required": [
"request_id",
"task_id",
"result"
],
"title": "Receipt",
"type": "object"
},
"SampleError": {
"additionalProperties": false,
"properties": {
"code": {
"title": "Code",
"type": "string"
},
"effect": {
"enum": [
"none",
"unknown"
],
"title": "Effect",
"type": "string"
},
"message": {
"title": "Message",
"type": "string"
},
"request_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Request Id"
}
},
"required": [
"code",
"message",
"request_id",
"effect"
],
"title": "SampleError",
"type": "object"
},
"ScenarioCommand": {
"additionalProperties": false,
"properties": {
"request_id": {
"format": "uuid",
"title": "Request Id",
"type": "string"
},
"scenario": {
"enum": [
"normal",
"missing_data",
"unavailable",
"response_lost",
"duplicate_feedback",
"conflicting_feedback",
"late_state"
],
"title": "Scenario",
"type": "string"
}
},
"required": [
"request_id",
"scenario"
],
"title": "ScenarioCommand",
"type": "object"
},
"ScenarioState": {
"additionalProperties": false,
"properties": {
"revision": {
"minimum": 1.0,
"title": "Revision",
"type": "integer"
},
"scenario": {
"enum": [
"normal",
"missing_data",
"unavailable",
"response_lost",
"duplicate_feedback",
"conflicting_feedback",
"late_state"
],
"title": "Scenario",
"type": "string"
}
},
"required": [
"scenario",
"revision"
],
"title": "ScenarioState",
"type": "object"
},
"SourceLink": {
"additionalProperties": false,
"properties": {
"object_id": {
"format": "uuid",
"title": "Object Id",
"type": "string"
},
"object_type": {
"enum": [
"validation",
"artifact"
],
"title": "Object Type",
"type": "string"
},
"revision": {
"minimum": 1.0,
"title": "Revision",
"type": "integer"
},
"system": {
"const": "next",
"title": "System",
"type": "string"
},
"task_id": {
"format": "uuid",
"title": "Task Id",
"type": "string"
}
},
"required": [
"system",
"task_id",
"object_type",
"object_id",
"revision"
],
"title": "SourceLink",
"type": "object"
},
"Task": {
"additionalProperties": false,
"properties": {
"analysis_window": {
"$ref": "#/components/schemas/TimeRange"
},
"asset_ids": {
"items": {
"type": "string"
},
"title": "Asset Ids",
"type": "array"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"created_by": {
"title": "Created By",
"type": "string"
},
"evidence_refs": {
"items": {
"$ref": "#/components/schemas/ObjectRef"
},
"title": "Evidence Refs",
"type": "array"
},
"feedback": {
"items": {
"$ref": "#/components/schemas/Feedback"
},
"title": "Feedback",
"type": "array"
},
"history": {
"items": {
"$ref": "#/components/schemas/HistoryEntry"
},
"title": "History",
"type": "array"
},
"origin": {
"const": "synthetic",
"title": "Origin",
"type": "string"
},
"project_id": {
"format": "uuid",
"title": "Project Id",
"type": "string"
},
"requested_check": {
"title": "Requested Check",
"type": "string"
},
"revision": {
"minimum": 1.0,
"title": "Revision",
"type": "integer"
},
"source": {
"$ref": "#/components/schemas/SourceLink"
},
"status": {
"enum": [
"pending",
"processing",
"pending_review",
"completed"
],
"title": "Status",
"type": "string"
},
"summary": {
"title": "Summary",
"type": "string"
},
"task_id": {
"format": "uuid",
"title": "Task Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"updated_at": {
"format": "date-time",
"title": "Updated At",
"type": "string"
}
},
"required": [
"task_id",
"project_id",
"revision",
"title",
"summary",
"source",
"asset_ids",
"analysis_window",
"evidence_refs",
"requested_check",
"status",
"origin",
"created_at",
"updated_at",
"created_by",
"history",
"feedback"
],
"title": "Task",
"type": "object"
},
"TestDataRecord": {
"additionalProperties": false,
"properties": {
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"created_by": {
"title": "Created By",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"notes": {
"title": "Notes",
"type": "string"
},
"observed_at": {
"format": "date-time",
"title": "Observed At",
"type": "string"
},
"origin": {
"const": "synthetic",
"title": "Origin",
"type": "string"
},
"point_id": {
"title": "Point Id",
"type": "string"
},
"project_id": {
"format": "uuid",
"title": "Project Id",
"type": "string"
},
"quality": {
"enum": [
"valid",
"unknown",
"missing"
],
"title": "Quality",
"type": "string"
},
"record_id": {
"format": "uuid",
"title": "Record Id",
"type": "string"
},
"revision": {
"minimum": 1.0,
"title": "Revision",
"type": "integer"
},
"unit": {
"title": "Unit",
"type": "string"
},
"updated_at": {
"format": "date-time",
"title": "Updated At",
"type": "string"
},
"updated_by": {
"title": "Updated By",
"type": "string"
},
"value": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Value"
}
},
"required": [
"record_id",
"project_id",
"revision",
"label",
"point_id",
"observed_at",
"value",
"unit",
"quality",
"notes",
"origin",
"created_at",
"updated_at",
"created_by",
"updated_by"
],
"title": "TestDataRecord",
"type": "object"
},
"TestDataRecordPage": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/TestDataRecord"
},
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
}
},
"required": [
"items",
"next_cursor"
],
"title": "TestDataRecordPage",
"type": "object"
},
"TimeRange": {
"additionalProperties": false,
"properties": {
"end": {
"format": "date-time",
"title": "End",
"type": "string"
},
"start": {
"format": "date-time",
"title": "Start",
"type": "string"
}
},
"required": [
"start",
"end"
],
"title": "TimeRange",
"type": "object"
},
"UpdateTestDataRecord": {
"additionalProperties": false,
"properties": {
"clear_value": {
"default": false,
"title": "Clear Value",
"type": "boolean"
},
"expected_revision": {
"minimum": 1.0,
"title": "Expected Revision",
"type": "integer"
},
"label": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Label"
},
"notes": {
"anyOf": [
{
"maxLength": 4000,
"type": "string"
},
{
"type": "null"
}
],
"title": "Notes"
},
"observed_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Observed At"
},
"point_id": {
"anyOf": [
{
"maxLength": 128,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Point Id"
},
"quality": {
"anyOf": [
{
"enum": [
"valid",
"unknown",
"missing"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Quality"
},
"request_id": {
"format": "uuid",
"title": "Request Id",
"type": "string"
},
"unit": {
"anyOf": [
{
"maxLength": 32,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Unit"
},
"value": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Value"
}
},
"required": [
"request_id",
"expected_revision"
],
"title": "UpdateTestDataRecord",
"type": "object"
},
"UpdateWorkOrder": {
"additionalProperties": false,
"properties": {
"assignee": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Assignee"
},
"clear_assignee": {
"default": false,
"title": "Clear Assignee",
"type": "boolean"
},
"clear_location": {
"default": false,
"title": "Clear Location",
"type": "boolean"
},
"clear_scenario_code": {
"default": false,
"title": "Clear Scenario Code",
"type": "boolean"
},
"clear_scheduled_at": {
"default": false,
"title": "Clear Scheduled At",
"type": "boolean"
},
"clear_subtasks": {
"default": false,
"title": "Clear Subtasks",
"type": "boolean"
},
"expected_revision": {
"minimum": 1.0,
"title": "Expected Revision",
"type": "integer"
},
"location": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Location"
},
"priority": {
"anyOf": [
{
"enum": [
"low",
"normal",
"high",
"urgent"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Priority"
},
"request_id": {
"format": "uuid",
"title": "Request Id",
"type": "string"
},
"scenario_code": {
"anyOf": [
{
"maxLength": 128,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Scenario Code"
},
"scheduled_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Scheduled At"
},
"status": {
"anyOf": [
{
"enum": [
"draft",
"open",
"in_progress",
"awaiting_reply",
"completed",
"cancelled"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
},
"subtasks": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkbenchRuntimeWorkOrderSubtask"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"title": "Subtasks"
},
"summary": {
"anyOf": [
{
"maxLength": 4000,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"title": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"required": [
"request_id",
"expected_revision"
],
"title": "UpdateWorkOrder",
"type": "object"
},
"WorkOrder": {
"additionalProperties": false,
"properties": {
"assignee": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Assignee"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"created_by": {
"title": "Created By",
"type": "string"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Location"
},
"origin": {
"const": "synthetic",
"title": "Origin",
"type": "string"
},
"priority": {
"enum": [
"low",
"normal",
"high",
"urgent"
],
"title": "Priority",
"type": "string"
},
"project_id": {
"format": "uuid",
"title": "Project Id",
"type": "string"
},
"revision": {
"minimum": 1.0,
"title": "Revision",
"type": "integer"
},
"scenario_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Scenario Code"
},
"scheduled_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Scheduled At"
},
"status": {
"enum": [
"draft",
"open",
"in_progress",
"awaiting_reply",
"completed",
"cancelled"
],
"title": "Status",
"type": "string"
},
"subtasks": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkbenchRuntimeWorkOrderSubtask"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"title": "Subtasks"
},
"summary": {
"title": "Summary",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"updated_at": {
"format": "date-time",
"title": "Updated At",
"type": "string"
},
"updated_by": {
"title": "Updated By",
"type": "string"
},
"work_order_id": {
"format": "uuid",
"title": "Work Order Id",
"type": "string"
},
"work_order_type": {
"default": "general",
"enum": [
"general",
"water_quality_complaint",
"burst_report"
],
"title": "Work Order Type",
"type": "string"
}
},
"required": [
"work_order_id",
"project_id",
"revision",
"title",
"summary",
"status",
"priority",
"assignee",
"scheduled_at",
"origin",
"created_at",
"updated_at",
"created_by",
"updated_by"
],
"title": "WorkOrder",
"type": "object"
},
"WorkOrderPage": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/WorkOrder"
},
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
}
},
"required": [
"items",
"next_cursor"
],
"title": "WorkOrderPage",
"type": "object"
},
"WorkbenchRuntimeWorkOrderStage": {
"additionalProperties": false,
"properties": {
"description": {
"minLength": 1,
"title": "Description",
"type": "string"
},
"id": {
"minLength": 1,
"title": "Id",
"type": "string"
},
"owner": {
"minLength": 1,
"title": "Owner",
"type": "string"
},
"sequence": {
"minimum": 1.0,
"title": "Sequence",
"type": "integer"
},
"status": {
"enum": [
"done",
"current",
"pending",
"blocked",
"skipped"
],
"title": "Status",
"type": "string"
},
"time_label": {
"minLength": 1,
"title": "Time Label",
"type": "string"
},
"title": {
"minLength": 1,
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"sequence",
"title",
"status",
"owner",
"time_label",
"description"
],
"title": "WorkbenchRuntimeWorkOrderStage",
"type": "object"
},
"WorkbenchRuntimeWorkOrderSubtask": {
"additionalProperties": false,
"properties": {
"assignee": {
"minLength": 1,
"title": "Assignee",
"type": "string"
},
"duration_minutes": {
"minimum": 1.0,
"title": "Duration Minutes",
"type": "integer"
},
"id": {
"minLength": 1,
"title": "Id",
"type": "string"
},
"location": {
"minLength": 1,
"title": "Location",
"type": "string"
},
"reply_requirements": {
"items": {
"minLength": 1,
"type": "string"
},
"title": "Reply Requirements",
"type": "array"
},
"reply_window_minutes": {
"minimum": 1.0,
"title": "Reply Window Minutes",
"type": "integer"
},
"scheduled_at": {
"format": "date-time",
"title": "Scheduled At",
"type": "string"
},
"stages": {
"items": {
"$ref": "#/components/schemas/WorkbenchRuntimeWorkOrderStage"
},
"title": "Stages",
"type": "array"
},
"status": {
"enum": [
"pending",
"running",
"blocked",
"completed",
"cancelled"
],
"title": "Status",
"type": "string"
},
"summary": {
"minLength": 1,
"title": "Summary",
"type": "string"
},
"title": {
"minLength": 1,
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"title",
"summary",
"status",
"scheduled_at",
"location",
"assignee",
"duration_minutes",
"reply_window_minutes",
"stages",
"reply_requirements"
],
"title": "WorkbenchRuntimeWorkOrderSubtask",
"type": "object"
}
}
},
"info": {
"description": "测试监测与核查反馈样板,不是正式工单平台或设备控制服务。",
"title": "TJWater 外围系统模拟接入",
"version": "1.0.0"
},
"openapi": "3.1.0",
"paths": {
"/api/sample/v1/context": {
"get": {
"operationId": "context_api_sample_v1_context_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Context"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Context"
}
},
"/api/sample/v1/demo-data": {
"get": {
"operationId": "demo_data_api_sample_v1_demo_data_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DemoDataset"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Demo Data"
}
},
"/api/sample/v1/monitoring/alerts": {
"get": {
"operationId": "alerts_api_sample_v1_monitoring_alerts_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertPage"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Alerts"
}
},
"/api/sample/v1/monitoring/observations": {
"get": {
"operationId": "observations_api_sample_v1_monitoring_observations_get",
"parameters": [
{
"in": "query",
"name": "point_id",
"required": true,
"schema": {
"title": "Point Id",
"type": "string"
}
},
{
"in": "query",
"name": "start",
"required": true,
"schema": {
"title": "Start",
"type": "string"
}
},
{
"in": "query",
"name": "end",
"required": true,
"schema": {
"title": "End",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Observations"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Observations"
}
},
"/api/sample/v1/monitoring/points": {
"get": {
"operationId": "points_api_sample_v1_monitoring_points_get",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 100,
"maximum": 500,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"anyOf": [
{
"maxLength": 128,
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PointPage"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Points"
}
},
"/api/sample/v1/requests/{request_id}": {
"get": {
"operationId": "receipt_api_sample_v1_requests__request_id__get",
"parameters": [
{
"in": "path",
"name": "request_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Request Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Receipt"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Receipt"
}
},
"/api/sample/v1/scenario": {
"get": {
"operationId": "scenario_api_sample_v1_scenario_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScenarioState"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Scenario"
},
"post": {
"operationId": "configure_scenario_api_sample_v1_scenario_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScenarioCommand"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScenarioState"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Configure Scenario"
}
},
"/api/sample/v1/test-data": {
"get": {
"operationId": "test_data_api_sample_v1_test_data_get",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestDataRecordPage"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Test Data"
},
"post": {
"operationId": "create_test_data_api_sample_v1_test_data_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTestDataRecord"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestDataRecord"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Create Test Data"
}
},
"/api/sample/v1/test-data/{record_id}": {
"delete": {
"operationId": "delete_test_data_api_sample_v1_test_data__record_id__delete",
"parameters": [
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Record Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteResource"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedResource"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Delete Test Data"
},
"get": {
"operationId": "test_data_record_api_sample_v1_test_data__record_id__get",
"parameters": [
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Record Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestDataRecord"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Test Data Record"
},
"patch": {
"operationId": "update_test_data_api_sample_v1_test_data__record_id__patch",
"parameters": [
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Record Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTestDataRecord"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestDataRecord"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Update Test Data"
}
},
"/api/sample/v1/work-orders": {
"get": {
"operationId": "work_orders_api_sample_v1_work_orders_get",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkOrderPage"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Work Orders"
},
"post": {
"operationId": "create_work_order_api_sample_v1_work_orders_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWorkOrder"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkOrder"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Create Work Order"
}
},
"/api/sample/v1/work-orders/{work_order_id}": {
"delete": {
"operationId": "delete_work_order_api_sample_v1_work_orders__work_order_id__delete",
"parameters": [
{
"in": "path",
"name": "work_order_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Work Order Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteResource"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedResource"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Delete Work Order"
},
"get": {
"operationId": "work_order_api_sample_v1_work_orders__work_order_id__get",
"parameters": [
{
"in": "path",
"name": "work_order_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Work Order Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkOrder"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Work Order"
},
"patch": {
"operationId": "update_work_order_api_sample_v1_work_orders__work_order_id__patch",
"parameters": [
{
"in": "path",
"name": "work_order_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Work Order Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWorkOrder"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkOrder"
}
}
},
"description": "Successful Response"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Unprocessable Entity"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Bad Gateway"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SampleError"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Update Work Order"
}
},
"/health": {
"get": {
"operationId": "health_health_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Health"
}
}
}
}