Skip to content

Commit 510e81b

Browse files
addshoreaddshore
committed
geofencelist tweaks & delete fence endpoint
SW-841
1 parent 6eca9f5 commit 510e81b

File tree

2 files changed

+181
-72
lines changed

2 files changed

+181
-72
lines changed

‎.vitepress/config.mts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -395,6 +395,12 @@ export default withMermaid(defineConfig({
395395
linkPrefix: '/apis/v2/',
396396
addedOperations: new Set(),
397397
})),
398+
collapse(sidebarSpec2.generateSidebarGroup({
399+
tag: ["geofencelists"],
400+
text: "Geofence Lists",
401+
linkPrefix: '/apis/v2/',
402+
addedOperations: new Set(),
403+
})),
398404
],
399405
},
400406
{

‎public/swagger/v2.json

Lines changed: 175 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1136,33 +1136,24 @@
11361136
}
11371137
},
11381138
{
1139-
"description": "Filter by ID (comma separated for multiple values)",
1140-
"in": "query",
1141-
"name": "id",
1142-
"schema": {
1143-
"description": "Filter by ID (comma separated for multiple values)",
1144-
"form": "id",
1145-
"type": "string"
1146-
}
1147-
},
1148-
{
1149-
"description": "Filter by type (comma separated for multiple values)",
1139+
"description": "Filter by serial (prefix search enabled by appending * to the end of the string) (comma separated for multiple values)",
11501140
"in": "query",
1151-
"name": "type",
1141+
"name": "serial",
11521142
"schema": {
1153-
"description": "Filter by type (comma separated for multiple values)",
1154-
"example": "ZeroN",
1155-
"form": "type",
1143+
"description": "Filter by serial (prefix search enabled by appending * to the end of the string) (comma separated for multiple values)",
1144+
"example": "12001234",
1145+
"form": "serial",
11561146
"type": "string"
11571147
}
11581148
},
11591149
{
1160-
"description": "Filter by IMEI (exact match) (comma separated for multiple values)",
1150+
"description": "Tag to search for in fully qualified key:value format. Example device_type:truck. Partial searches with wildcards may be used, eg. device_type:* or device_type:veh_*",
11611151
"in": "query",
1162-
"name": "imei",
1152+
"name": "tag",
11631153
"schema": {
1164-
"description": "Filter by IMEI (exact match) (comma separated for multiple values)",
1165-
"form": "imei",
1154+
"description": "Tag to search for in fully qualified key:value format. Example device_type:truck. Partial searches with wildcards may be used, eg. device_type:* or device_type:veh_*",
1155+
"example": "device_type:truck",
1156+
"form": "tag",
11661157
"type": "string"
11671158
}
11681159
},
@@ -1178,48 +1169,44 @@
11781169
}
11791170
},
11801171
{
1181-
"description": "Only show devices connected since this date (super secret)",
1172+
"description": "Filter by reseller name (exact match)",
11821173
"in": "query",
1183-
"name": "_connectedSince",
1174+
"name": "reseller",
11841175
"schema": {
1185-
"description": "Only show devices connected since this date (super secret)",
1186-
"form": "_connectedSince",
1176+
"description": "Filter by reseller name (exact match)",
1177+
"example": "Name*",
1178+
"form": "reseller",
11871179
"type": "string"
11881180
}
11891181
},
11901182
{
1191-
"description": "Include additional data. Enums: config,users,knownDevices,subscription,subscription.plan,reseller,resellerPlan",
1183+
"description": "Only show devices connected since this date (super secret)",
11921184
"in": "query",
1193-
"name": "_include",
1185+
"name": "_connectedSince",
11941186
"schema": {
1195-
"description": "Include additional data. Enums: config,users,knownDevices,subscription,subscription.plan,reseller,resellerPlan",
1196-
"form": "_include",
1197-
"items": {
1198-
"type": "string"
1199-
},
1200-
"type": "array",
1201-
"uniqueItems": false
1187+
"description": "Only show devices connected since this date (super secret)",
1188+
"form": "_connectedSince",
1189+
"type": "string"
12021190
}
12031191
},
12041192
{
1205-
"description": "Filter by active status",
1193+
"description": "Filter by ID (comma separated for multiple values)",
12061194
"in": "query",
1207-
"name": "active",
1195+
"name": "id",
12081196
"schema": {
1209-
"description": "Filter by active status",
1210-
"example": true,
1211-
"form": "active",
1212-
"type": "boolean"
1197+
"description": "Filter by ID (comma separated for multiple values)",
1198+
"form": "id",
1199+
"type": "string"
12131200
}
12141201
},
12151202
{
1216-
"description": "Filter by serial (prefix search enabled by appending * to the end of the string) (comma separated for multiple values)",
1203+
"description": "Filter by type (comma separated for multiple values)",
12171204
"in": "query",
1218-
"name": "serial",
1205+
"name": "type",
12191206
"schema": {
1220-
"description": "Filter by serial (prefix search enabled by appending * to the end of the string) (comma separated for multiple values)",
1221-
"example": "12001234",
1222-
"form": "serial",
1207+
"description": "Filter by type (comma separated for multiple values)",
1208+
"example": "ZeroN",
1209+
"form": "type",
12231210
"type": "string"
12241211
}
12251212
},
@@ -1245,34 +1232,47 @@
12451232
}
12461233
},
12471234
{
1248-
"description": "Tag to search for in fully qualified key:value format. Example device_type:truck. Partial searches with wildcards may be used, eg. device_type:* or device_type:veh_*",
1235+
"description": "Filter by current firmware version",
12491236
"in": "query",
1250-
"name": "tag",
1237+
"name": "config.currentFW",
12511238
"schema": {
1252-
"description": "Tag to search for in fully qualified key:value format. Example device_type:truck. Partial searches with wildcards may be used, eg. device_type:* or device_type:veh_*",
1253-
"example": "device_type:truck",
1254-
"form": "tag",
1239+
"description": "Filter by current firmware version",
1240+
"form": "config.currentFW",
12551241
"type": "string"
12561242
}
12571243
},
12581244
{
1259-
"description": "Filter by reseller name (exact match)",
1245+
"description": "Include additional data. Enums: config,users,knownDevices,subscription,subscription.plan,reseller,resellerPlan",
12601246
"in": "query",
1261-
"name": "reseller",
1247+
"name": "_include",
12621248
"schema": {
1263-
"description": "Filter by reseller name (exact match)",
1264-
"example": "Name*",
1265-
"form": "reseller",
1266-
"type": "string"
1249+
"description": "Include additional data. Enums: config,users,knownDevices,subscription,subscription.plan,reseller,resellerPlan",
1250+
"form": "_include",
1251+
"items": {
1252+
"type": "string"
1253+
},
1254+
"type": "array",
1255+
"uniqueItems": false
12671256
}
12681257
},
12691258
{
1270-
"description": "Filter by current firmware version",
1259+
"description": "Filter by active status",
12711260
"in": "query",
1272-
"name": "config.currentFW",
1261+
"name": "active",
12731262
"schema": {
1274-
"description": "Filter by current firmware version",
1275-
"form": "config.currentFW",
1263+
"description": "Filter by active status",
1264+
"example": true,
1265+
"form": "active",
1266+
"type": "boolean"
1267+
}
1268+
},
1269+
{
1270+
"description": "Filter by IMEI (exact match) (comma separated for multiple values)",
1271+
"in": "query",
1272+
"name": "imei",
1273+
"schema": {
1274+
"description": "Filter by IMEI (exact match) (comma separated for multiple values)",
1275+
"form": "imei",
12761276
"type": "string"
12771277
}
12781278
},
@@ -3138,9 +3138,9 @@
31383138
"ApiKeyAuth": []
31393139
}
31403140
],
3141-
"summary": "Gets a list of geofence lists",
3141+
"summary": "Gets geofence lists",
31423142
"tags": [
3143-
"geofences"
3143+
"geofencelists"
31443144
]
31453145
},
31463146
"put": {
@@ -3213,9 +3213,9 @@
32133213
"ApiKeyAuth": []
32143214
}
32153215
],
3216-
"summary": "Creates a new geofence list",
3216+
"summary": "Creates a geofence list",
32173217
"tags": [
3218-
"geofences"
3218+
"geofencelists"
32193219
]
32203220
}
32213221
},
@@ -3318,7 +3318,7 @@
33183318
],
33193319
"summary": "Deletes a geofence list",
33203320
"tags": [
3321-
"geofences"
3321+
"geofencelists"
33223322
]
33233323
},
33243324
"get": {
@@ -3419,7 +3419,7 @@
34193419
],
34203420
"summary": "Gets a geofence list",
34213421
"tags": [
3422-
"geofences"
3422+
"geofencelists"
34233423
]
34243424
}
34253425
},
@@ -3531,9 +3531,9 @@
35313531
"ApiKeyAuth": []
35323532
}
35333533
],
3534-
"summary": "Shares a geofence list with a user",
3534+
"summary": "Shares a geofence list",
35353535
"tags": [
3536-
"geofences"
3536+
"geofencelists"
35373537
]
35383538
}
35393539
},
@@ -3643,9 +3643,9 @@
36433643
"ApiKeyAuth": []
36443644
}
36453645
],
3646-
"summary": "Deletes a user from a geofence list",
3646+
"summary": "Removes a user from a geofence list",
36473647
"tags": [
3648-
"geofences"
3648+
"geofencelists"
36493649
]
36503650
},
36513651
"put": {
@@ -3755,7 +3755,7 @@
37553755
],
37563756
"summary": "Adds a user to a geofence list",
37573757
"tags": [
3758-
"geofences"
3758+
"geofencelists"
37593759
]
37603760
}
37613761
},
@@ -3971,6 +3971,109 @@
39713971
}
39723972
},
39733973
"/users/{userid}/geofences/{fenceid}": {
3974+
"delete": {
3975+
"parameters": [
3976+
{
3977+
"description": "User ID",
3978+
"in": "path",
3979+
"name": "userid",
3980+
"required": true,
3981+
"schema": {
3982+
"type": "integer"
3983+
}
3984+
},
3985+
{
3986+
"description": "Geofence ID",
3987+
"in": "path",
3988+
"name": "fenceid",
3989+
"required": true,
3990+
"schema": {
3991+
"type": "integer"
3992+
}
3993+
}
3994+
],
3995+
"responses": {
3996+
"204": {
3997+
"description": "No Content"
3998+
},
3999+
"400": {
4000+
"content": {
4001+
"application/json": {
4002+
"schema": {
4003+
"$ref": "#/components/schemas/httputil.HTTPError"
4004+
}
4005+
}
4006+
},
4007+
"description": "Bad Request"
4008+
},
4009+
"401": {
4010+
"content": {
4011+
"application/json": {
4012+
"schema": {
4013+
"$ref": "#/components/schemas/httputil.HTTPError"
4014+
}
4015+
}
4016+
},
4017+
"description": "Unauthorized"
4018+
},
4019+
"403": {
4020+
"content": {
4021+
"application/json": {
4022+
"schema": {
4023+
"$ref": "#/components/schemas/httputil.HTTPError"
4024+
}
4025+
}
4026+
},
4027+
"description": "Forbidden"
4028+
},
4029+
"404": {
4030+
"content": {
4031+
"application/json": {
4032+
"schema": {
4033+
"$ref": "#/components/schemas/httputil.HTTPError"
4034+
}
4035+
}
4036+
},
4037+
"description": "Not Found"
4038+
},
4039+
"429": {
4040+
"content": {
4041+
"application/json": {
4042+
"schema": {
4043+
"type": "string"
4044+
}
4045+
}
4046+
},
4047+
"description": "Limit exceeded",
4048+
"headers": {
4049+
"X-Ratelimit-Limit": {
4050+
"schema": {
4051+
"type": "integer"
4052+
}
4053+
},
4054+
"X-Ratelimit-Remaining": {
4055+
"schema": {
4056+
"type": "integer"
4057+
}
4058+
},
4059+
"X-Ratelimit-Reset": {
4060+
"schema": {
4061+
"type": "integer"
4062+
}
4063+
}
4064+
}
4065+
}
4066+
},
4067+
"security": [
4068+
{
4069+
"ApiKeyAuth": []
4070+
}
4071+
],
4072+
"summary": "Deletes a single geofence",
4073+
"tags": [
4074+
"geofences"
4075+
]
4076+
},
39744077
"get": {
39754078
"parameters": [
39764079
{
@@ -4182,9 +4285,9 @@
41824285
"ApiKeyAuth": []
41834286
}
41844287
],
4185-
"summary": "Deletes a geofence from the associated list",
4288+
"summary": "Deletes a geofence from a list",
41864289
"tags": [
4187-
"geofences"
4290+
"geofencelists"
41884291
]
41894292
}
41904293
},
@@ -4295,7 +4398,7 @@
42954398
],
42964399
"summary": "Puts a geofence on a list",
42974400
"tags": [
4298-
"geofences"
4401+
"geofencelists"
42994402
]
43004403
}
43014404
},

0 commit comments

Comments
 (0)