@@ -2,13 +2,13 @@ export const v1SummaryOverrides = {
2
2
'post-users-login' : 'Login' ,
3
3
'get-users-id-getMqttCredentials' : 'MQTT Credentials' ,
4
4
// points
5
- 'get-devices-id-points-{fk} ' : 'Get device point by id' ,
5
+ 'get-devices-id-points-fk ' : 'Get device point by id' ,
6
6
'get-devices-id-points' : 'Get device points' ,
7
- 'delete-devices-id-points-{fk} ' : 'Delete device point by id' ,
7
+ 'delete-devices-id-points-fk ' : 'Delete device point by id' ,
8
8
// readings
9
- 'get-devices-id-readings-{fk} ' : 'Get device reading by id' ,
9
+ 'get-devices-id-readings-fk ' : 'Get device reading by id' ,
10
10
'get-devices-id-readings' : 'Get device readings' ,
11
- 'put-devices-id-gatewayReadings-{fk} ' : 'Update device reading by id' ,
11
+ 'put-devices-id-gatewayReadings-fk ' : 'Update device reading by id' ,
12
12
// device
13
13
'get-devices-id' : 'Get device' ,
14
14
'get-users-id-getDeviceSummary' : 'Summary of devices' ,
@@ -17,24 +17,24 @@ export const v1SummaryOverrides = {
17
17
'get-devices-id-setupSqsForwarding' : 'Configure SQS Notifications for a device' ,
18
18
'get-devices-id-setMetaItem' : 'Set meta item for a device' ,
19
19
'get-devices-id-flightMode' : 'Set flight mode for a device' ,
20
- 'get-devices-id-gatewayReadings-{fk} ' : 'Get device gateway reading by id' ,
21
- 'delete-devices-id-gatewayReadings-{fk} ' : 'Delete device gateway reading by id' ,
20
+ 'get-devices-id-gatewayReadings-fk ' : 'Get device gateway reading by id' ,
21
+ 'delete-devices-id-gatewayReadings-fk ' : 'Delete device gateway reading by id' ,
22
22
'post-devices-id-messages' : 'Send a new message to the device' ,
23
23
'delete-devices-id-messages' : 'Delete all messages for a device' ,
24
24
'get-users-id-getDevicesInZone' : 'Devices in zone' ,
25
25
'get-users-id-getDevicesByTag' : 'Devices with tag' ,
26
26
// TODO notification triggers should probably render in swagger with better names
27
27
'get-devices-id-notificationTriggers' : 'Get device triggers' ,
28
- 'get-devices-id-notificationTriggers-{fk} ' : 'Get device trigger by id' ,
29
- 'put-devices-id-notificationTriggers-{fk} ' : 'Update device trigger by id' ,
30
- 'delete-devices-id-notificationTriggers-{fk} ' : 'Delete device trigger by id' ,
28
+ 'get-devices-id-notificationTriggers-fk ' : 'Get device trigger by id' ,
29
+ 'put-devices-id-notificationTriggers-fk ' : 'Update device trigger by id' ,
30
+ 'delete-devices-id-notificationTriggers-fk ' : 'Delete device trigger by id' ,
31
31
'post-devices-id-notificationTriggers' : 'Create device trigger' ,
32
32
'delete-devices-id-notificationTriggers' : 'Delete all device triggers' ,
33
33
// TODO geofences should have better default summaries
34
- 'get-users-id-geofences-{fk} ' : 'Get user geofence by id' ,
34
+ 'get-users-id-geofences-fk ' : 'Get user geofence by id' ,
35
35
'get-users-id-geofences' : 'Get user geofences' ,
36
- 'put-users-id-geofences-{fk} ' : 'Update user geofence by id' ,
37
- 'delete-users-id-geofences-{fk} ' : 'Delete user geofence by id' ,
36
+ 'put-users-id-geofences-fk ' : 'Update user geofence by id' ,
37
+ 'delete-users-id-geofences-fk ' : 'Delete user geofence by id' ,
38
38
'post-users-id-geofences' : 'Create user geofence' ,
39
39
'delete-users-id-geofences' : 'Delete all user geofences' ,
40
40
'get-devices-id-deactivate' : 'Deactivate device' ,
@@ -46,7 +46,7 @@ export const v1SummaryOverrides = {
46
46
47
47
export const v1DescriptionOverrides = {
48
48
'get-devices-id-points' : `Gets one or more points for a device, based on filtering.` ,
49
- 'get-devices-id-points-{fk} ' : `Get a specific point for device when you already know the device ID and point ID.` ,
49
+ 'get-devices-id-points-fk ' : `Get a specific point for device when you already know the device ID and point ID.` ,
50
50
'get-users-id-getMqttCredentials' : `Retrieves a users MQTT Credentials if set, for legacy use in connecting to MQTT.` ,
51
51
'get-users-id-getDeviceSummary' : `Lists all devices for a user, with a summary of state, including most resent points.` ,
52
52
'get-devices-id-deactivate' : `Deactivates a device.` ,
@@ -67,18 +67,18 @@ There is a [full guide](/guides/notifications-setup-sqs) written for this endpoi
67
67
} ;
68
68
69
69
export const v1Deprecated = [
70
- 'get-devices-id-transients-{fk} ' ,
70
+ 'get-devices-id-transients-fk ' ,
71
71
] ;
72
72
73
73
export const v1ReTag = {
74
74
'post-users-login' : 'authentication' ,
75
75
'get-users-id-getMqttCredentials' : 'mqtt' ,
76
- 'put-users-id-geofences-{fk} ' : 'geofences' ,
77
- 'delete-users-id-geofences-{fk} ' : 'geofences' ,
76
+ 'put-users-id-geofences-fk ' : 'geofences' ,
77
+ 'delete-users-id-geofences-fk ' : 'geofences' ,
78
78
'post-users-id-geofences' : 'geofences' ,
79
79
'delete-users-id-geofences' : 'geofences' ,
80
- 'get-devices-id-gatewayReadings-{fk} ' : 'readings-gateway' ,
81
- 'delete-devices-id-gatewayReadings-{fk} ' : 'readings-gateway' ,
80
+ 'get-devices-id-gatewayReadings-fk ' : 'readings-gateway' ,
81
+ 'delete-devices-id-gatewayReadings-fk ' : 'readings-gateway' ,
82
82
'get-devices-id-config' : 'device-config' ,
83
83
'put-devices-id-config' : 'device-config' ,
84
84
'post-devices-id-setSafeZone' : 'device-config' ,
@@ -92,7 +92,7 @@ export const v1ReTag = {
92
92
'post-devices-id-messages' : 'device-misc' ,
93
93
'delete-devices-id-messages' : 'device-misc' ,
94
94
'get-devices-id-transients' : 'device-misc' ,
95
- 'get-devices-id-transients-{fk} ' : 'device-misc' ,
95
+ 'get-devices-id-transients-fk ' : 'device-misc' ,
96
96
'get-devices-id-nearbyDevices' : 'device-misc' ,
97
97
'get-devices-id-nearbyDeviceData' : 'device-misc' ,
98
98
'get-devices-id-getRtkStatus' : 'rtk' ,
@@ -110,29 +110,30 @@ export const v1ReTag = {
110
110
'get-users-id-getDeviceSummary' : 'device' ,
111
111
'get-users-id-getDevicesInZone' : 'device' ,
112
112
'get-users-id-getDevicesByTag' : 'device' ,
113
- 'get-devices-id-points-{fk} ' : 'points' ,
113
+ 'get-devices-id-points-fk ' : 'points' ,
114
114
'get-devices-id-points' : 'points' ,
115
- 'delete-devices-id-points-{fk} ' : 'points' ,
116
- 'get-devices-id-readings-{fk} ' : 'readings' ,
115
+ 'delete-devices-id-points-fk ' : 'points' ,
116
+ 'get-devices-id-readings-fk ' : 'readings' ,
117
117
'get-devices-id-readings' : 'readings' ,
118
- 'put-devices-id-gatewayReadings-{fk} ' : 'readings' ,
119
- 'get-devices-id-notificationTriggers-{fk} ' : 'notifications' ,
120
- 'delete-devices-id-notificationTriggers-{fk} ' : 'notifications' ,
121
- 'put-devices-id-notificationTriggers-{fk} ' : 'notifications' ,
118
+ 'put-devices-id-gatewayReadings-fk ' : 'readings' ,
119
+ 'get-devices-id-notificationTriggers-fk ' : 'notifications' ,
120
+ 'delete-devices-id-notificationTriggers-fk ' : 'notifications' ,
121
+ 'put-devices-id-notificationTriggers-fk ' : 'notifications' ,
122
122
'get-devices-id-notificationTriggers' : 'notifications' ,
123
123
'post-devices-id-notificationTriggers' : 'notifications' ,
124
124
'delete-devices-id-notificationTriggers' : 'notifications' ,
125
125
'get-users-id-geofences' : 'geofences' ,
126
- 'get-users-id-geofences-{fk} ' : 'geofences' ,
126
+ 'get-users-id-geofences-fk ' : 'geofences' ,
127
127
'post-reports-activity' : 'reports' ,
128
128
'post-reports-vehicle-summary' : 'reports' ,
129
129
} ;
130
130
131
131
export const v1Removed = [
132
- 'delete-devices-id-gatewayReadings-{fk}' ,
133
- 'delete-devices-id-transients-{fk}' ,
134
- 'put-devices-id-transients-{fk}' ,
135
- 'get-devices-id-transients-{fk}' ,
132
+ 'delete-devices-id-gatewayReadings-fk' ,
133
+ 'delete-devices-id-transients-fk' ,
134
+ 'put-devices-id-transients-fk' ,
135
+ 'get-devices-id-transients-fk' ,
136
+ 'get-devices-id-transients' ,
136
137
] ;
137
138
138
139
export const V1ParamExamples = {
0 commit comments