Skip to content

Commit bb815cb

Browse files
wbornwborn
authored
Update REST API docs (#76)
1 parent 5886b11 commit bb815cb

17 files changed

+434
-47
lines changed

‎api/openapi.yaml‎

Lines changed: 112 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2153,6 +2153,45 @@ paths:
21532153
description: default response
21542154
content:
21552155
application/json: {}
2156+
/map/deleteMap:
2157+
delete:
2158+
tags:
2159+
- Map
2160+
summary: Removes mbtiles file
2161+
operationId: deleteMap
2162+
parameters:
2163+
- name: Authorization
2164+
in: header
2165+
schema:
2166+
type: string
2167+
- name: X-Forwarded-Proto
2168+
in: header
2169+
schema:
2170+
type: string
2171+
- name: X-Forwarded-Host
2172+
in: header
2173+
schema:
2174+
type: string
2175+
responses:
2176+
default:
2177+
description: default response
2178+
content:
2179+
application/json:
2180+
schema:
2181+
$ref: "#/components/schemas/ObjectNode"
2182+
/map/getCustomMapInfo:
2183+
get:
2184+
tags:
2185+
- Map
2186+
summary: Retrieve if the map is custom and custom map limit
2187+
operationId: getCustomMapInfo
2188+
responses:
2189+
default:
2190+
description: default response
2191+
content:
2192+
application/json:
2193+
schema:
2194+
$ref: "#/components/schemas/ObjectNode"
21562195
/map:
21572196
get:
21582197
tags:
@@ -2201,16 +2240,14 @@ paths:
22012240
content:
22022241
application/json:
22032242
schema:
2204-
type: object
2205-
additionalProperties:
2206-
$ref: "#/components/schemas/MapRealmConfig"
2243+
$ref: "#/components/schemas/MapConfig"
22072244
responses:
22082245
default:
22092246
description: default response
22102247
content:
22112248
application/json:
22122249
schema:
2213-
type: object
2250+
$ref: "#/components/schemas/ObjectNode"
22142251
/map/js:
22152252
get:
22162253
tags:
@@ -2270,6 +2307,36 @@ paths:
22702307
schema:
22712308
type: string
22722309
format: byte
2310+
/map/upload:
2311+
post:
2312+
tags:
2313+
- Map
2314+
summary: Saves mbtiles file
2315+
operationId: uploadMap
2316+
parameters:
2317+
- name: Authorization
2318+
in: header
2319+
schema:
2320+
type: string
2321+
- name: X-Forwarded-Proto
2322+
in: header
2323+
schema:
2324+
type: string
2325+
- name: X-Forwarded-Host
2326+
in: header
2327+
schema:
2328+
type: string
2329+
- name: filename
2330+
in: query
2331+
schema:
2332+
type: string
2333+
responses:
2334+
default:
2335+
description: default response
2336+
content:
2337+
application/json:
2338+
schema:
2339+
$ref: "#/components/schemas/ObjectNode"
22732340
/notification:
22742341
get:
22752342
tags:
@@ -5682,13 +5749,7 @@ components:
56825749
format: int64
56835750
ownerId:
56845751
type: string
5685-
viewAccess:
5686-
type: string
5687-
enum:
5688-
- PUBLIC
5689-
- SHARED
5690-
- PRIVATE
5691-
editAccess:
5752+
access:
56925753
type: string
56935754
enum:
56945755
- PUBLIC
@@ -5838,25 +5899,14 @@ components:
58385899
DashboardConditions:
58395900
type: object
58405901
properties:
5841-
viewAccess:
5842-
type: array
5843-
items:
5844-
type: string
5845-
enum:
5846-
- PUBLIC
5847-
- SHARED
5848-
- PRIVATE
5849-
editAccess:
5902+
access:
58505903
type: array
58515904
items:
58525905
type: string
58535906
enum:
58545907
- PUBLIC
58555908
- SHARED
58565909
- PRIVATE
5857-
minWidgets:
5858-
type: integer
5859-
format: int32
58605910
DashboardQuery:
58615911
type: object
58625912
properties:
@@ -6072,6 +6122,17 @@ components:
60726122
type: array
60736123
items:
60746124
type: object
6125+
MapConfig:
6126+
type: object
6127+
properties:
6128+
options:
6129+
type: object
6130+
additionalProperties:
6131+
$ref: "#/components/schemas/MapRealmConfig"
6132+
sources:
6133+
type: object
6134+
additionalProperties:
6135+
$ref: "#/components/schemas/MapSourceConfig"
60756136
MapRealmConfig:
60766137
type: object
60776138
properties:
@@ -6100,6 +6161,34 @@ components:
61006161
type: string
61016162
geoJson:
61026163
$ref: "#/components/schemas/GeoJsonConfig"
6164+
MapSourceConfig:
6165+
type: object
6166+
properties:
6167+
type:
6168+
type: string
6169+
url:
6170+
type: string
6171+
tiles:
6172+
type: array
6173+
items:
6174+
type: string
6175+
bounds:
6176+
type: array
6177+
items:
6178+
type: number
6179+
format: float
6180+
scheme:
6181+
type: string
6182+
minzoom:
6183+
type: integer
6184+
format: int32
6185+
maxzoom:
6186+
type: integer
6187+
format: int32
6188+
attribution:
6189+
type: string
6190+
custom:
6191+
type: boolean
61036192
AbstractNotificationMessage:
61046193
type: object
61056194
properties:

‎docs/rest-api/create-dashboard.api.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Create a dashboard"
55
sidebar_label: "Create a dashboard"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: eJztWW1z4jYQ/iue/dTOGEy4S6/lUzlCLswlgRK4tM0wGcVeQBdb8kkCwjH8987K+AVw7kKunekH8iFjtC9arVb7PJZXYNhEQ+MOzpiePkimAhi5IGNUzHApOgE0wFfIDOYKLsRMsQgNKjJdgWARQgOaMzOVin+1luACF9CAKbIAFbig/SlGDBorMMuY1LVRXExgvXYzD39WzqVaMBVgUOkpaeQPe7mQ2hzgZOSCwi8z1Oa9DJak4UthUBh6ZHEcct+uzvuspaCx3BXZcYUBJdNgFIfMIOVyM4V8+Iw+hRIryq7hqMmKByVhuJuUB12xL3VhLFXEDDQgYAYrhkdIJgpZGJF6xJ4uUUzMFBr101MXIi7S3yfu/lRzVJrL4kRcGJzYRGUzcWF+eUvaciFQdcqDnnNcNH0ftS6LGsUsotz0hu8vOy1w4eai2W+fgQu9fudTc9CG0doFDLj5UR8B13HIlte2GlbfW3+2Vzt7qH2FKHoKNRr9+o2U4SwSehMHjyj+PIryTL+pk2XEnm5sCLc8oNgPdqBwrFBPO8KgmrPwW/nsnp+DC93r9v1V5xpcOO98Sh//GDb7g3Z/I77oDvs2x9vZyV0zpdiSDpzBSO+nlIVcTBKrV6f0sO19UMgeY8mTI3xgCrcD/kYCb/vN3v2ge3/Tuf5w2b5vdS+HV5S9j+127/6y+Vd3OAAX+u2zTr/dosf3l93Wx/uz9qdOKylahQFX6JuszZYeMqpXbkIayhRvClthNRY8mBywK8V8ujBRPOgYjCD1M1jG2An+rd3ak2fz5cLDJnj6budK9nL5Qr3FK+rkNccz4uLihSFFXNy+XLXHnzA8wLXVf6l/Ifuo+dfiXj5IGSITifRKzp+RhdJ/xKBMVlbUH9KyWO/UYVkJJAotKcZ8sl9Hpf5vrQmsS4WDFBJKpWRkD6yOpdBJbQY4ZrPQJI/aVzy2HKiRCpxUG9wjozgyiiOjODKKI6M4MoojozgyipRRUGVvUYeWRWyHOUHh5iVCM5V0KRMnFxsxozYFXlFHo5qnVzMzFdLNhzGxbnhegJGsyhiFwkgarHLpsZh7K4v0aw9cmDPF2UOImzO9IQAZvYGIaYOKAh7RRP5McbO0M5FbOlB3o6LohthM4i1VyLPJZmZap6II5cKq+CFHYVoKAxSGszDpOPIRxdCuwyMLz4alvSQUL6Z7Il+GXuK/4ksh0DeeNYMMtF7vQPsyTlYQKznmduvSJ9o1Vrz2asnAVuvW4OFzkyq4//Ol25ol2trPr8zaTyyKQ0y7a45rBf4J9Vr9baX2rlL/bXBy2jg9adR/rdbenfwNGefM7TIyWStQxYK4wBBzElfkfPnoFnDkLop0bSfmlGrV9slTrYQObVjPDpO523X7TBxFXlHbYwrPEoJSmM9a2agA3i8NpAig2wZPNrKl/b+w/5NMJMhTS3GltoUatS1MqBU7vlEzzHt88ivt6vRrr1Xnoex06PV6RNXIxVjanrFpsd0YRd/2OueKCTZB5fTbNwOn2evAbr8dTLl2uHbMFJ1A+rMIhbHH1xlLZUdLvF0MBr3MZdVxeiEyjY5GtBZ3W45GP2WNWPp6uxH/bGeJpEKHFlHdvCgy37JEjBgPLWqO5e9bdhYIuY/0btnIr+I/9C6dN9UauDsIsFgsqhMxq0o18TZm2mOTOKy8qdaqKKpTE4VbL3FAghoNEeRETBSmKYWoraxmzd7gk/HikHEL3Tao1Qa97iAofnyYErI17mC1emAahypcr2n4ywwVIc0oBykLNm56r0/1HXBNggAaYxZq3Asme/cGcMsje8TlMx8i5iyckT7Qp4b/YqLNt4qteRKtVuKtQsegoLF3fZBbUPeLzTd1RwU20eve0DvEw+ajR2RRDBRbUINhi2QZ0q4uYQbMktqQicmMTUg38Ul//wBej9zX
8+
api: eJztWW1z4jYQ/iue/dTOGExyl17Lp3KEXJhLAiXk0jbDZIS9gC625JPkEI7hv3dWxi+AcxfSdqadgQ+M8b5otVrt80gswbCphuYdnDI9G0umAhi5IGNUzHApugE0wVfIDBYKLsRMsQgNKjJdgmARQhNaiZlJxb9aS3CBC2jCDFmAClzQ/gwjBs0lmEVM6tooLqawWrm5h99rZ1LNmQowqPWVNPJvezmX2uzhZOSCwi8JavNeBgvS8KUwKAw9sjgOuW9n533WUtC7whXZcYUBJdNgFIfMIOVyPYQcf0afQokVZddw1GTFg4ow3HXKg57YlbowkSpiBpoQMIM1wyMkE4UsjEg9Yk8XKKZmBs3jkxMXIi6y30fu7lCPqDSX5YG4MDi1icpH4sL89Ja05Vyg6lYHzXwfta6KGEUSUV76N+8vum1w4fq8Neicggv9QfdTa9iB0cqFgOs4ZIsru4rL78Wd53gr99pXiKKvUKPRr18AGSaR0Os4eETxF1FUZ+jNMVlG7OnahnDLA4p9bwcKJwr1rCsMqkcWfiufvbMzcKF31bm/7F6BC2fdT9njbzetwbAzWIvPezcDm+PN7BSumVJsQRvFYKR3U8pCLqap1atTut/yjhWyh1jydOvtmcLNgL+RwNtBq38/7N1fd68+XHTu272Lm0vK3sdOp39/0fqjdzMEFwad0+6g06bH9xe99sf7086nbjstWoUBV+ibvD1Wbg6qV25CepUrXpeWwmrMeTDdY1XK+XRhqnjQNRhB5me4iLEb/FOrtSPPxyuE+w3w9N2Ok67l4oV681fUyWu2Z8TF+QtDiri4fblqnz9huIdrq/9S/0IOUPOv5bUcSxkiE6n0Uj4+Iwul/4BBlayqqD9kZbHaqsOqEkgV2lJM+HS3jir931oTWFUKhxkkVErJyG5YHUuh09oMcMKS0KSP2lc8ttylmQmcTBvcAxM4MIEDEzgwgQMTODCBAxP4/zMBquwNyG9bpHWYE5RuOiI0M0mXIHF6kRAzalPglXU0qsfsKiRRId00GBPrpucFGMm6jFEojKTBOpcei7m3tAi98sCFR6Y4G4e43tNr4M5pCURMG1QU8IgG8hPFzcKORG5pQ92NyqJrYiGpt0yhyCZLzOyYiiKUc6vihxyFaSsMUBjOwrTjyAcUN3YeHll4NiztpaF4Md3L+DL0Uv81XwqBvvGsGeSg9XoH2pdxOoNYyQm3S5c90aqx8jVTWwa2Wjde7j82qYL7H5+6rVmim4PiiqrzxKI4xKy7FrhW4o1w3Dh+W2u8qx3/Mjw6aZ4cNY9/rjfeHf0JOVcs7HIS2ChRvEKcMbuCwG3AQ6FYJmVbkWWEqrFLkRoVpGfNbbb4yt2222fiKLOHxg4feBb2K8E8b1ijEkS/NJAyTG4aPNnIFvZ7br/TTKT40sjQo7GBDY2Nzt8o93WjEiw6efor6930a6chF6Fs9eHVakQ1x8VE2s6wbqS9GMXAdjTnkgk2ReUMOtdDp9XvwnZXHc64drh2zAydQPpJhMLYTepMpLJvK7ydD4f93GXdcfohMo2ORrQWdxuORj/k7Vb6erPd/mhHiaRChyZRXx/jmG+5IEaMhxYbJ/LXDTsLd9xHOvk1iwvuD/0L5029Ae5Wn5/P5/WpSOpSTb21mfbYNA5rb+qNOor6zEThxhELSNCgVwQsEROlYSqBaCOreUs3+GS8OGTcArQNarnGqDsIylf6M8Kv5h0sl2Om8UaFqxW9/pKgIjwZFVBkIcXNbsupvgOuSRBAc8JCjTvB5CdjALc6sgdcPHO9/8jChPSBLvD/jYHW/wBsjJNqtVNvNdoGJY2dw31h0fJ9jM03dUclztDvXdNJYbz+KyGyWAWKzanBsHk6DWlnl+I/s9Q1ZGKasCnppj7p8xcI/ahf
99
sidebar_class_name: "post api-method"
1010
info_path: docs/rest-api/openremote-manager-rest-api
1111
custom_edit_url: null
@@ -54,15 +54,15 @@ Create a dashboard
5454

5555
<RequestSchema
5656
title={"Body"}
57-
body={{"content":{"application/json":{"schema":{"required":["template"],"type":"object","properties":{"id":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"realm":{"maxLength":255,"minLength":1,"type":"string"},"version":{"type":"integer","format":"int64"},"ownerId":{"type":"string"},"viewAccess":{"type":"string","enum":["PUBLIC","SHARED","PRIVATE"]},"editAccess":{"type":"string","enum":["PUBLIC","SHARED","PRIVATE"]},"displayName":{"minLength":1,"type":"string"},"template":{"required":["screenPresets"],"type":"object","properties":{"id":{"type":"string"},"columns":{"minimum":1,"type":"integer","format":"int32"},"maxScreenWidth":{"minimum":1,"type":"integer","format":"int32"},"refreshInterval":{"type":"string","enum":["OFF","ONE_MIN","FIVE_MIN","QUARTER","ONE_HOUR"]},"screenPresets":{"type":"array","items":{"required":["scalingPreset"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"minLength":1,"type":"string"},"breakpoint":{"minimum":1,"type":"integer","format":"int32"},"scalingPreset":{"type":"string","enum":["WRAP_TO_SINGLE_COLUMN","KEEP_LAYOUT","REDIRECT","BLOCK_DEVICE"]},"redirectDashboardId":{"type":"string"}},"title":"DashboardScreenPreset"}},"widgets":{"type":"array","items":{"required":["displayName","gridItem","widgetTypeId"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"gridItem":{"type":"object","properties":{"id":{"type":"string"},"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"},"w":{"minimum":1,"type":"integer","format":"int32"},"h":{"minimum":1,"type":"integer","format":"int32"},"minH":{"type":"integer","format":"int32"},"minW":{"type":"integer","format":"int32"},"minPixelH":{"type":"integer","format":"int32"},"minPixelW":{"type":"integer","format":"int32"},"noResize":{"type":"boolean"},"noMove":{"type":"boolean"},"locked":{"type":"boolean"}},"title":"DashboardGridItem"},"widgetTypeId":{"type":"string"},"widgetConfig":{"type":"object"}},"title":"DashboardWidget"}}},"title":"DashboardTemplate"}},"title":"Dashboard"}}}}}
57+
body={{"content":{"application/json":{"schema":{"required":["template"],"type":"object","properties":{"id":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"realm":{"maxLength":255,"minLength":1,"type":"string"},"version":{"type":"integer","format":"int64"},"ownerId":{"type":"string"},"access":{"type":"string","enum":["PUBLIC","SHARED","PRIVATE"]},"displayName":{"minLength":1,"type":"string"},"template":{"required":["screenPresets"],"type":"object","properties":{"id":{"type":"string"},"columns":{"minimum":1,"type":"integer","format":"int32"},"maxScreenWidth":{"minimum":1,"type":"integer","format":"int32"},"refreshInterval":{"type":"string","enum":["OFF","ONE_MIN","FIVE_MIN","QUARTER","ONE_HOUR"]},"screenPresets":{"type":"array","items":{"required":["scalingPreset"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"minLength":1,"type":"string"},"breakpoint":{"minimum":1,"type":"integer","format":"int32"},"scalingPreset":{"type":"string","enum":["WRAP_TO_SINGLE_COLUMN","KEEP_LAYOUT","REDIRECT","BLOCK_DEVICE"]},"redirectDashboardId":{"type":"string"}},"title":"DashboardScreenPreset"}},"widgets":{"type":"array","items":{"required":["displayName","gridItem","widgetTypeId"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"gridItem":{"type":"object","properties":{"id":{"type":"string"},"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"},"w":{"minimum":1,"type":"integer","format":"int32"},"h":{"minimum":1,"type":"integer","format":"int32"},"minH":{"type":"integer","format":"int32"},"minW":{"type":"integer","format":"int32"},"minPixelH":{"type":"integer","format":"int32"},"minPixelW":{"type":"integer","format":"int32"},"noResize":{"type":"boolean"},"noMove":{"type":"boolean"},"locked":{"type":"boolean"}},"title":"DashboardGridItem"},"widgetTypeId":{"type":"string"},"widgetConfig":{"type":"object"}},"title":"DashboardWidget"}}},"title":"DashboardTemplate"}},"title":"Dashboard"}}}}}
5858
>
5959

6060
</RequestSchema>
6161

6262
<StatusCodes
6363
id={undefined}
6464
label={undefined}
65-
responses={{"default":{"description":"default response","content":{"application/json":{"schema":{"required":["template"],"type":"object","properties":{"id":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"realm":{"maxLength":255,"minLength":1,"type":"string"},"version":{"type":"integer","format":"int64"},"ownerId":{"type":"string"},"viewAccess":{"type":"string","enum":["PUBLIC","SHARED","PRIVATE"]},"editAccess":{"type":"string","enum":["PUBLIC","SHARED","PRIVATE"]},"displayName":{"minLength":1,"type":"string"},"template":{"required":["screenPresets"],"type":"object","properties":{"id":{"type":"string"},"columns":{"minimum":1,"type":"integer","format":"int32"},"maxScreenWidth":{"minimum":1,"type":"integer","format":"int32"},"refreshInterval":{"type":"string","enum":["OFF","ONE_MIN","FIVE_MIN","QUARTER","ONE_HOUR"]},"screenPresets":{"type":"array","items":{"required":["scalingPreset"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"minLength":1,"type":"string"},"breakpoint":{"minimum":1,"type":"integer","format":"int32"},"scalingPreset":{"type":"string","enum":["WRAP_TO_SINGLE_COLUMN","KEEP_LAYOUT","REDIRECT","BLOCK_DEVICE"]},"redirectDashboardId":{"type":"string"}},"title":"DashboardScreenPreset"}},"widgets":{"type":"array","items":{"required":["displayName","gridItem","widgetTypeId"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"gridItem":{"type":"object","properties":{"id":{"type":"string"},"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"},"w":{"minimum":1,"type":"integer","format":"int32"},"h":{"minimum":1,"type":"integer","format":"int32"},"minH":{"type":"integer","format":"int32"},"minW":{"type":"integer","format":"int32"},"minPixelH":{"type":"integer","format":"int32"},"minPixelW":{"type":"integer","format":"int32"},"noResize":{"type":"boolean"},"noMove":{"type":"boolean"},"locked":{"type":"boolean"}},"title":"DashboardGridItem"},"widgetTypeId":{"type":"string"},"widgetConfig":{"type":"object"}},"title":"DashboardWidget"}}},"title":"DashboardTemplate"}},"title":"Dashboard"}}}}}}
65+
responses={{"default":{"description":"default response","content":{"application/json":{"schema":{"required":["template"],"type":"object","properties":{"id":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"realm":{"maxLength":255,"minLength":1,"type":"string"},"version":{"type":"integer","format":"int64"},"ownerId":{"type":"string"},"access":{"type":"string","enum":["PUBLIC","SHARED","PRIVATE"]},"displayName":{"minLength":1,"type":"string"},"template":{"required":["screenPresets"],"type":"object","properties":{"id":{"type":"string"},"columns":{"minimum":1,"type":"integer","format":"int32"},"maxScreenWidth":{"minimum":1,"type":"integer","format":"int32"},"refreshInterval":{"type":"string","enum":["OFF","ONE_MIN","FIVE_MIN","QUARTER","ONE_HOUR"]},"screenPresets":{"type":"array","items":{"required":["scalingPreset"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"minLength":1,"type":"string"},"breakpoint":{"minimum":1,"type":"integer","format":"int32"},"scalingPreset":{"type":"string","enum":["WRAP_TO_SINGLE_COLUMN","KEEP_LAYOUT","REDIRECT","BLOCK_DEVICE"]},"redirectDashboardId":{"type":"string"}},"title":"DashboardScreenPreset"}},"widgets":{"type":"array","items":{"required":["displayName","gridItem","widgetTypeId"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"gridItem":{"type":"object","properties":{"id":{"type":"string"},"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"},"w":{"minimum":1,"type":"integer","format":"int32"},"h":{"minimum":1,"type":"integer","format":"int32"},"minH":{"type":"integer","format":"int32"},"minW":{"type":"integer","format":"int32"},"minPixelH":{"type":"integer","format":"int32"},"minPixelW":{"type":"integer","format":"int32"},"noResize":{"type":"boolean"},"noMove":{"type":"boolean"},"locked":{"type":"boolean"}},"title":"DashboardGridItem"},"widgetTypeId":{"type":"string"},"widgetConfig":{"type":"object"}},"title":"DashboardWidget"}}},"title":"DashboardTemplate"}},"title":"Dashboard"}}}}}}
6666
>
6767

6868
</StatusCodes>

‎docs/rest-api/delete-map.api.mdx‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
id: delete-map
3+
title: "Removes mbtiles file"
4+
description: "Removes mbtiles file"
5+
sidebar_label: "Removes mbtiles file"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJzNVUtr20AQ/itiTi3I2tDcdGpI0yaQtCZxoGB82KzG1ib76u7Ibmr038us33kc0lKoTmIe37y/XQLJWYJ6DFcywKQEHzBK0t5dNFBDgwYJWVVCkFFaJIxsvgQnLUINJx21Pupf2QdK0A5qaFE2GKGEpFq0Euol0GNg80RRuxn0fblF+D747ONCxgabwTB68n+Ncu4TvQFkUkLEFLxLmFjf4FR2hla/SUUdcm31RlFsrKEE5R2hy7YyBKNV7oO4T+ywfB7U392j4uRIk2HBtyz46huEnr/yScxrtH6OqbB3pA2mYqoNx7VIrd9NKI+HWqhBWBnE/tgSxvlmZl003BKikGohGrS+8gFdROsJK+2FDFosI0pjewElzGXU8s6s2pLFB/0BKxNh5MQnHEh1UdNjjsSwuoF6PNlX3XA7Vmgbg11nZEftByhhavwimyij0dFpxAYdaWmykPwDuttch2APkdNKYpWKCLxAyhuxwh8o7xwqEtkNeNDTiKn9c4CkfFhVEKLPw6i3fzw9uX8PpzxWXo194dtjsymvzH9det5d7aY+T2mz3QHddd6u4ko6OcNYXJ/djIqT4QU83fRRq1OhU0EtFo1XnUVHuWHF1McsfQHtfDQabiGrohgalAmLhJg9xgdAk3fb1fcqHa7++xzF+ogFF1Gtb1uqfNtopea2serjgR/0JRitkOmg3rHil+FlcVwdQfnk5haLRTVzXeXjTKzdkpCzYAbH1VGFrmrJGsbkm131hRVHLAo+kZVuL8wr5HDQ1+2BEf4kEYzUjsFyWss1a4zBZq7Y8cakhJZZtB7DcnknE95G0/cs/tFh5Buf7Oghn3m5oVo+/0YnVjRQT6VJ+CylLW0C7/VL+T3g4ytvw1yaju2B2f9fBFo/HwdxVlYnSmHY1z3jfGa7LTd/Ors8G51B3/8GWxaSvQ==
9+
sidebar_class_name: "delete api-method"
10+
info_path: docs/rest-api/openremote-manager-rest-api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"Removes mbtiles file"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"delete"}
31+
path={"/map/deleteMap"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
Removes mbtiles file
40+
41+
<Heading
42+
id={"request"}
43+
as={"h2"}
44+
className={"openapi-tabs__heading"}
45+
children={"Request"}
46+
>
47+
</Heading>
48+
49+
<ParamsDetails
50+
parameters={[{"name":"Authorization","in":"header","schema":{"type":"string"}},{"name":"X-Forwarded-Proto","in":"header","schema":{"type":"string"}},{"name":"X-Forwarded-Host","in":"header","schema":{"type":"string"}}]}
51+
>
52+
53+
</ParamsDetails>
54+
55+
<RequestSchema
56+
title={"Body"}
57+
body={undefined}
58+
>
59+
60+
</RequestSchema>
61+
62+
<StatusCodes
63+
id={undefined}
64+
label={undefined}
65+
responses={{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","title":"ObjectNode"}}}}}}
66+
>
67+
68+
</StatusCodes>
69+
70+

0 commit comments

Comments
 (0)