@@ -15,15 +15,19 @@ class Deployment(BaseModel):
1515 activity_status : Literal ["drifted" , "staged" , "queued" , "deployed" , "archived" ]
1616 """Last known activity state of the deployment.
1717
18- - Drifted: device's configurations have drifted since this deployment was
19- staged, and the deployment needs to be reviewed before it can be deployed
20- - Staged: is ready to be deployed
21- - Queued: the deployment's config instances are waiting to be received by the
22- device; will be deployed as soon as the device is online
23- - Deployed: the deployment's config instances are currently available for
24- consumption on the device
25- - Archived: the deployment is available for historical reference but cannot be
26- deployed and is not active on the device
18+ `drifted` means the device's configurations have drifted since this deployment
19+ was staged, and the deployment needs to be reviewed before it can be deployed.
20+
21+ `staged` means the deployment is ready to be deployed.
22+
23+ `queued` means the deployment's config instances are waiting to be received by
24+ the device and will be deployed as soon as the device is online.
25+
26+ `deployed` means the deployment's config instances are currently available for
27+ consumption on the device.
28+
29+ `archived` means the deployment is available for historical reference but cannot
30+ be deployed and is not active on the device.
2731 """
2832
2933 created_at : datetime
@@ -38,11 +42,13 @@ class Deployment(BaseModel):
3842 error_status : Literal ["none" , "failed" , "retrying" ]
3943 """Last known error state of the deployment.
4044
41- - None: no errors
42- - Retrying: an error has been encountered and the agent is retrying to reach the
43- target status
44- - Failed: a fatal error has been encountered; the deployment is archived and (if
45- deployed) removed from the device
45+ `none` means there are no errors.
46+
47+ `retrying` means an error has been encountered and the agent is retrying to
48+ reach the target status.
49+
50+ `failed` means a fatal error has been encountered; the deployment is archived
51+ and, if deployed, removed from the device.
4652 """
4753
4854 object : Literal ["deployment" ]
@@ -63,12 +69,11 @@ class Deployment(BaseModel):
6369 target_status : Literal ["staged" , "deployed" , "archived" ]
6470 """Desired state of the deployment.
6571
66- - Staged: is ready to be deployed
67- - Deployed: all config instances part of the deployment are available for
68- consumption on the device
69- - Archived: the deployment is available for historical reference but cannot be
70- deployed and is not active on the device
71- """
72+ `staged` means the deployment is ready to be deployed.
7273
73- updated_at : datetime
74- """Timestamp of when the device release was last updated."""
74+ `deployed` means all config instances in the deployment are available for
75+ consumption on the device.
76+
77+ `archived` means the deployment is available for historical reference but cannot
78+ be deployed and is not active on the device.
79+ """
0 commit comments