acknowledgement.py 1.13 KB
Newer Older
1 2 3 4
"""
    schemas: Acknowledgement status sent by the surface platform to report
    receipt of message.
"""
5
acknowledgement_schema = {
6
    "type": "object",
7
    "properties": {
8 9 10 11 12
        "message_type": {
            "type": "string",
            "description": "Type of message",
            "example": "acknowledgement",
        },
13
        "acknowledged_message_ID": {
14 15
            "type": "string",
            "description": "Identifier of message received and executed with "
16
            + "success for mission plans sent by the Autonomy Engine.",
17
            "example": "02125022255-7bc8-11ed-a1eb-0242ac999999",
18 19 20
        },
        "status": {
            "type": "string",
21
            "enum": ["c2_received", "operator_approved_and_sent", "executed"],
22
            "description": "Highest level of acknowledgement. I.e."
23 24 25
            + " `c2_received`: Received by C2, `operator_approved_and_sent`"
            + " : Approved by operator and sent from C2->Platform,"
            + " `executed`: Executed by platform",
26 27
            "example": "executed by platform",
        },
28
    },
29
    "required": ["message_type", "acknowledged_message_ID", "status"],
30
}