Skip to content

Commit d3c70df

Browse files
committed
V1 web api: Fix adjustments, and thus menu layout
1 parent 887eaf0 commit d3c70df

File tree

1 file changed

+32
-31
lines changed

1 file changed

+32
-31
lines changed

swagger/v1-overrides.ts

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ export const v1SummaryOverrides = {
22
'post-users-login': 'Login',
33
'get-users-id-getMqttCredentials': 'MQTT Credentials',
44
// points
5-
'get-devices-id-points-{fk}': 'Get device point by id',
5+
'get-devices-id-points-fk': 'Get device point by id',
66
'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',
88
// readings
9-
'get-devices-id-readings-{fk}': 'Get device reading by id',
9+
'get-devices-id-readings-fk': 'Get device reading by id',
1010
'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',
1212
// device
1313
'get-devices-id': 'Get device',
1414
'get-users-id-getDeviceSummary': 'Summary of devices',
@@ -17,24 +17,24 @@ export const v1SummaryOverrides = {
1717
'get-devices-id-setupSqsForwarding': 'Configure SQS Notifications for a device',
1818
'get-devices-id-setMetaItem': 'Set meta item for a device',
1919
'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',
2222
'post-devices-id-messages': 'Send a new message to the device',
2323
'delete-devices-id-messages': 'Delete all messages for a device',
2424
'get-users-id-getDevicesInZone': 'Devices in zone',
2525
'get-users-id-getDevicesByTag': 'Devices with tag',
2626
// TODO notification triggers should probably render in swagger with better names
2727
'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',
3131
'post-devices-id-notificationTriggers': 'Create device trigger',
3232
'delete-devices-id-notificationTriggers': 'Delete all device triggers',
3333
// 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',
3535
'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',
3838
'post-users-id-geofences': 'Create user geofence',
3939
'delete-users-id-geofences': 'Delete all user geofences',
4040
'get-devices-id-deactivate': 'Deactivate device',
@@ -46,7 +46,7 @@ export const v1SummaryOverrides = {
4646

4747
export const v1DescriptionOverrides = {
4848
'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.`,
5050
'get-users-id-getMqttCredentials': `Retrieves a users MQTT Credentials if set, for legacy use in connecting to MQTT.`,
5151
'get-users-id-getDeviceSummary': `Lists all devices for a user, with a summary of state, including most resent points.`,
5252
'get-devices-id-deactivate': `Deactivates a device.`,
@@ -67,18 +67,18 @@ There is a [full guide](/guides/notifications-setup-sqs) written for this endpoi
6767
};
6868

6969
export const v1Deprecated = [
70-
'get-devices-id-transients-{fk}',
70+
'get-devices-id-transients-fk',
7171
];
7272

7373
export const v1ReTag = {
7474
'post-users-login': 'authentication',
7575
'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',
7878
'post-users-id-geofences': 'geofences',
7979
'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',
8282
'get-devices-id-config': 'device-config',
8383
'put-devices-id-config': 'device-config',
8484
'post-devices-id-setSafeZone': 'device-config',
@@ -92,7 +92,7 @@ export const v1ReTag = {
9292
'post-devices-id-messages': 'device-misc',
9393
'delete-devices-id-messages': 'device-misc',
9494
'get-devices-id-transients': 'device-misc',
95-
'get-devices-id-transients-{fk}': 'device-misc',
95+
'get-devices-id-transients-fk': 'device-misc',
9696
'get-devices-id-nearbyDevices': 'device-misc',
9797
'get-devices-id-nearbyDeviceData': 'device-misc',
9898
'get-devices-id-getRtkStatus': 'rtk',
@@ -110,29 +110,30 @@ export const v1ReTag = {
110110
'get-users-id-getDeviceSummary': 'device',
111111
'get-users-id-getDevicesInZone': 'device',
112112
'get-users-id-getDevicesByTag': 'device',
113-
'get-devices-id-points-{fk}': 'points',
113+
'get-devices-id-points-fk': 'points',
114114
'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',
117117
'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',
122122
'get-devices-id-notificationTriggers': 'notifications',
123123
'post-devices-id-notificationTriggers': 'notifications',
124124
'delete-devices-id-notificationTriggers': 'notifications',
125125
'get-users-id-geofences': 'geofences',
126-
'get-users-id-geofences-{fk}': 'geofences',
126+
'get-users-id-geofences-fk': 'geofences',
127127
'post-reports-activity': 'reports',
128128
'post-reports-vehicle-summary': 'reports',
129129
};
130130

131131
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',
136137
];
137138

138139
export const V1ParamExamples = {

0 commit comments

Comments
 (0)