Skip to content

Commit b8e6e18

Browse files
committed
Update REST API documentation
1 parent 1d4646d commit b8e6e18

4 files changed

Lines changed: 30 additions & 39 deletions

File tree

api/openapi.yaml

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -753,36 +753,18 @@ paths:
753753
get:
754754
tags:
755755
- Asset Model
756-
summary: Retrieve the valueDescriptor JSON Schema.
756+
summary: Retrieve the JSON Schema of the specified value descriptor
757757
operationId: getValueDescriptorSchema
758758
parameters:
759-
- name: Authorization
760-
in: header
761-
schema:
762-
type: string
763-
- name: X-Forwarded-Proto
764-
in: header
765-
schema:
766-
type: string
767-
- name: X-Forwarded-Host
768-
in: header
769-
schema:
770-
type: string
771759
- name: name
772760
in: query
773761
schema:
774762
type: string
775-
- name: hash
776-
in: query
777-
schema:
778-
type: string
779763
responses:
780764
"200":
781765
description: default response
782766
content:
783-
application/json:
784-
schema:
785-
$ref: "#/components/schemas/JsonNode"
767+
application/json: {}
786768
/model/valueDescriptors:
787769
get:
788770
tags:
@@ -1747,6 +1729,15 @@ paths:
17471729
schema:
17481730
type: integer
17491731
format: int64
1732+
- name: format
1733+
in: query
1734+
schema:
1735+
type: string
1736+
default: CSV
1737+
enum:
1738+
- CSV
1739+
- CSV_CROSSTAB
1740+
- CSV_CROSSTAB_MINUTE
17501741
responses:
17511742
"200":
17521743
description: default response
@@ -5722,8 +5713,6 @@ components:
57225713
type: array
57235714
items:
57245715
type: string
5725-
JsonNode:
5726-
type: object
57275716
UserAssetLink:
57285717
type: object
57295718
properties:
@@ -6853,6 +6842,8 @@ components:
68536842
format: date-time
68546843
acknowledgement:
68556844
type: string
6845+
JsonNode:
6846+
type: object
68566847
Notification:
68576848
type: object
68586849
properties:

docs/rest-api/get-datapoint-export.api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Retrieve a datapoint export of an asset attribute"
55
sidebar_label: "Retrieve a datapoint export of an asset attribute"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: eJzNVU2P3DYM/SsCTy2gWIOk6MGnLtIgDZCii+3ktJgD16bHQiRRkejdbAb+74XkGWdnkH4kyKEnGxTfE8UnPh1AcJ+hvYWrnEnUrygY2QaBnQaOlFAshzc9tLAnWVdffYycBDRETOhJKBWOAwT0BC2gSLJ3k9ANDRk02AAtfJgoPYKG3I3kEdoDyGMs2VmSDXuYZ70SDIn91nrKgj7+K4ENQntKoGHg5FGW0M8/nVEKfxfCnYZEOXLIlAvi+WZTPj3lLtlYmgUt9DTg5ESdMkFDx0EoSMnFGJ3tamPNJxuhPczzPOsLjhuSZOmeFKr+1HZFte+KB4VBYVVs7TVo8CQjH7Wq4sgILZiaaFYWQyf1MqX7k3RTctDCKBJza0xPnhuOFBJ5FmosG4zWHBKh87MBDfeYLN65pQs1vPShnhxa8JiFEsy1ZZm6KVl5rDsVWttDe7t7uvRnEWFhOyWsejBOMj4vcjh+qCmdsxTkZaKeglh0NSj8nsK7eg5TEKaWlc1SiomJhTt2ZuF/1nEI1ImpMCi6Dony+O0EueO4nCAmHqwrpZ/+isCFkpP9VKV/yT3V2/A0+PV7l1TQ//Oj1+ttw8BVJSt1+Y9I4abeLvU7BtxTUr9tt9fq6voNXA7DdrRZ2axkJNVzN3kKUhumBk41+g9sjVLXjjCTykQ1+faMY/fDeuu5y+e3/se6gedEqtTfHCcZuzrJ5NG6ag4D/3KGg1mDsx2V4W9XD7p6ff1WvWg2oC/G7eHhodmHqeG0N0dYNriP7tmLZtNQaEbxrnCWcV1aUhY2JRQ5i8fwZJtvsY6zfq+DJ/RRTHRoQ9mp1nw42sotVJICXd8MDUdr2WkYOUvJOhzuMNO75Oa5hBfPLTbQ21z8o4d2QJdJw3t6/MLbcY9uKqVA8fK/wVw+F/8Fc/4efEbsPltbtSgNI2FPqda8QK+6jqI8QV06eiFZvfj1qy3M819ropg+
8+
api: eJzNVVFvGzcM/isCnzZAPRntsId7mucFXYB1DWKnL4FRKHc8n1BJ1CRe0tS4/15IZ19jY+2yYg97so8iP1Lkx097YL1LUN/CMiVk8ZtmHch4hq0EChg1G/KXLdSwQ55PLz4GigwSgo7aIWPMGHvw2iHUoJmjuRsYr7FLIMF4qOGvAeMjSEhNj05DvQd+DNk7cTR+B+MoZ4AuktsYh4m1C/8IYDzjDiNI6Cg6zZPp559OIJn+Y8DD0TNvJ6HFTg82Y63W70AC+sHlxk9fq/W796vrt+v1Zvnr2ef7N5d/3mwuYDuOWwkRUyCfMOUcLxeL/NNiaqIJeVRQHxOJoydIaMgzes6+OgRrmjJW9ckEqPfjOI7yDOMaORq8R6FFexy6wDJ1QZ3QXujCl3nSIMEh93RgSqEG91CDKo5qRlF45E7CeH8kzhAt1NAzh1Qr1aKjigL6iI4YK0NKB6P2EbV1owIJ9zoafWenLhTz1Idji51OjBHG0rKEzRANP5ZMGda0UN9unx6t89gmtKPDPEHSA/cvMxksPRSXxhr0vIrYomejbTEyfUB/U+6hcoQqZSU1laJCJKaGrJrwXzTkPTasShjkuXYRU//9AKmhMN0gROqMzaUf/+UBZ0iK5lMZ/YpaLGx4avz3ubMryP/51Qu9je+oTMlwOX4b0F8Xdok32usdRvH7ZnMllleXcL4Mm94kYZLgHkVLzeDQc2mY6CgW6zfQKiGuLOqEIiEW59sTjO0PM+upSaes/7EkcBRR5PqrwybrpmwyOm1skaaOfjmJg1GCNQ3m5a9nwVq+vvpDvKoWIM/W7eHhodr5oaK4U4ewpPQu2BevqkWFvurZ2YyZ13VqST5YZFOgxE77J2m+RzpO+j0vHuNHVsFq43OmUvP+ICu3UEBy6PxiSThIy1ZCT4mz135/pxPeRDuO2TypdJaB1qSsHy3UnbYJJXzAx795ue61HXIpkIX/KzHnj9VzYk5fo2dlOT43X5y3X3Sw6JmEHnWLsVxwilo2DYanUefyn0Fm4X59sYFx/AyG+82W
99
sidebar_class_name: "get api-method"
1010
info_path: docs/rest-api/openremote-manager-http-api
1111
custom_edit_url: null
@@ -47,7 +47,7 @@ Retrieve a datapoint export of an asset attribute
4747
</Heading>
4848

4949
<ParamsDetails
50-
parameters={[{"name":"attributeRefs","in":"query","schema":{"type":"string"}},{"name":"fromTimestamp","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"toTimestamp","in":"query","schema":{"type":"integer","format":"int64"}}]}
50+
parameters={[{"name":"attributeRefs","in":"query","schema":{"type":"string"}},{"name":"fromTimestamp","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"toTimestamp","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"format","in":"query","schema":{"type":"string","default":"CSV","enum":["CSV","CSV_CROSSTAB","CSV_CROSSTAB_MINUTE"]}}]}
5151
>
5252

5353
</ParamsDetails>

docs/rest-api/get-value-descriptor-schema.api.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
id: get-value-descriptor-schema
3-
title: "Retrieve the valueDescriptor JSON Schema."
4-
description: "Retrieve the valueDescriptor JSON Schema."
5-
sidebar_label: "Retrieve the valueDescriptor JSON Schema."
3+
title: "Retrieve the JSON Schema of the specified value descriptor"
4+
description: "Retrieve the JSON Schema of the specified value descriptor"
5+
sidebar_label: "Retrieve the JSON Schema of the specified value descriptor"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: eJzNVUtv1DAQ/ivRnEBy4xXccqLi0RbxWEFBSKs9uM7sxuDYxp50Kav8dzRO9lXaqhQO7CWr8bz8+Ztv1kBqmaCawXFKSMVbX6OFuQAfMCoy3p3VUMES6bOyHb7ApKMJ5ONH3WCrQEBQUbVIGDnLGpxqESo47qjx0fzMKUCAcVBBg6rGCALSEFytga4CuyeKxi2h78U2w5ejVz6uVKyxPppGT/6vs5z6RA9Kkj9j4PcO49U94xqVmvvHzQVETMG7hInPn0wm/KlHyBnHCmpcqM5SsfEEAdo7Qkfsq0KwRmfM5dfEAevfC/qLr6gZCDJk2fA6effO1wg9/8S1ih+QosFLLKjB4vKQBMXrj+/fFQMVShDQIjV+5EumBjVQgWyZVPIODiWMlxsCddEydEQhVVLW2PrSB3QRW09YGi9VMHIdUdm2lyDgUkWjLuyAWTYPqGWcoIJWJcLId5tzId1FQ1e5Eqc1NVSz+f5RbmrItnHYQac6ap6AgIX1q+yirUFHzyPW6Mgom43kv6H7lO8hOULmtpIcWpGB2ay9lUP+I+2dQ00yhwGzYBExNQ9PkLQPww1C9AuTH3nzjx9Y7Q/nc3555s6+8c9rsytz6r++eqa3cQufX2mk//uA7kNmV/FWObXEWJyen0+L4+kZXB+G88akwqQ8C7XXXYuOMmDFwsdsvSNbWRRTiyphkXAYp9lBjvmjLeu9Toesf5wLtD5iwf2X49wrneceW2UYMT56dhAHvQBrNLJUVDt1Ppm+KZ6WExDXxm21WpVL15U+LuUYlqRaBnv0tJyU6MqGWss5eVwHSPhgwqbgE7XK7ZX5E+k4wHk7cIQ/SAarjOMKudf1KCszyLIC4vblNBfQsOZXM1ivL1TCT9H2PZsHNWYRqE1i9aihWiibUMA3vNpJfm4aKgBW9VtcR5Xfuc53opTFRWy2zY31rl18q+bA03QTCkPVm9bj3d3+g0LjBj2oM3gda41h/+y3VcSwbPfDyctz6PtfXFfx2g==
8+
api: eJzNVE1vEzEQ/SvWnEBy11F72xNRQaWI0qhNuUQ5uN7ZrKnXNvZsQljtf0f2JiEpohJw4bSr+Xgz8zzzeiC5ilAuYBojErtxFRpYcnAegyTt7HUFJayQPkvT4VuMKmhPLtyrBlsJHLwMskXCkFB6sLJFKMcPB22hhK8dhi1wiGNK2QNtfQqKFLRdwTAsOQSM3tmIMfnPJ5P0qXbVtEswFdayM8T2kcBBOUtoKcVK741WuWPxJaaEfhiGgT8DuUMKGtfIqEH24f72ExsHYa7OpuhR6VpjxdZpXlYdBgYOLVLjdnTkyamBEkSbOBMvUBQxrPf8dMFACQ2Rj6UQFbaucB5twNYRFtoJ6bXoA0rTDgI4rGXQ8tGMvGTzyEzmAkpoZSQMMGQSI6ouaNrmSglWV1Aulseu3NSItg84vIeTHTXnwKE2bpNDlNFo6TJghZa0NNlI7gntQ55DpAyR24pibEX44MgpZ8SIf6actahI5DRIL10HjM3fA0Tl/DiBD67WJrW+/0svniBd0N/zMly6CvN+HBv/vHYKBf6fj573Xdva5VfSlN23Hu1d3i52I61cYWDv5/MZm86u4fl1zBsdmY75EiqnuhYtZcJY7UK2voBWMDYzKCOyiON9LU4wlq8OW+9UPN3617lA6wKy1H+xu22p8m1jK3ViLLnenOTBwMFohUkOyoP4TK9mH9lFMQH+7Nw2m02xsl3hwkrs0qKQK2/OLopJgbZoqDUJM53rSElyTJLJu0ittEdl/klLTog/XCDhNxLeSG1Tydx8v9OZBWSdAf57MV5yaFykFNv3jzLiQzDDkMyjBCdVqHRMclJBWUsTkcMTbn/qdW4USoAkGXvpyRLCoUFZYcggY85UKfR0lPWLBieUg2hevZvDMPwAFc1Ejw==
99
sidebar_class_name: "get api-method"
1010
info_path: docs/rest-api/openremote-manager-http-api
1111
custom_edit_url: null
@@ -22,7 +22,7 @@ import Heading from "@theme/Heading";
2222
<Heading
2323
as={"h1"}
2424
className={"openapi__heading"}
25-
children={"Retrieve the valueDescriptor JSON Schema."}
25+
children={"Retrieve the JSON Schema of the specified value descriptor"}
2626
>
2727
</Heading>
2828

@@ -36,7 +36,7 @@ import Heading from "@theme/Heading";
3636

3737

3838

39-
Retrieve the valueDescriptor JSON Schema.
39+
Retrieve the JSON Schema of the specified value descriptor
4040

4141
<Heading
4242
id={"request"}
@@ -47,7 +47,7 @@ Retrieve the valueDescriptor JSON Schema.
4747
</Heading>
4848

4949
<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"}},{"name":"name","in":"query","schema":{"type":"string"}},{"name":"hash","in":"query","schema":{"type":"string"}}]}
50+
parameters={[{"name":"name","in":"query","schema":{"type":"string"}}]}
5151
>
5252

5353
</ParamsDetails>
@@ -62,7 +62,7 @@ Retrieve the valueDescriptor JSON Schema.
6262
<StatusCodes
6363
id={undefined}
6464
label={undefined}
65-
responses={{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"object","title":"JsonNode"}}}}}}
65+
responses={{"200":{"description":"default response","content":{"application/json":{}}}}}
6666
>
6767

6868
</StatusCodes>

docs/rest-api/sidebar.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ const sidebar: SidebarsConfig = {
189189
{
190190
type: "doc",
191191
id: "rest-api/get-value-descriptor-schema",
192-
label: "Retrieve the valueDescriptor JSON Schema.",
192+
label: "Retrieve the JSON Schema of the specified value descriptor",
193193
className: "api-method get",
194194
},
195195
{
@@ -1330,12 +1330,6 @@ const sidebar: SidebarsConfig = {
13301330
label: "MetaItemDescriptorObject",
13311331
className: "schema",
13321332
},
1333-
{
1334-
type: "doc",
1335-
id: "rest-api/schemas/jsonnode",
1336-
label: "JsonNode",
1337-
className: "schema",
1338-
},
13391333
{
13401334
type: "doc",
13411335
id: "rest-api/schemas/userassetlink",
@@ -1720,6 +1714,12 @@ const sidebar: SidebarsConfig = {
17201714
label: "SentNotification",
17211715
className: "schema",
17221716
},
1717+
{
1718+
type: "doc",
1719+
id: "rest-api/schemas/jsonnode",
1720+
label: "JsonNode",
1721+
className: "schema",
1722+
},
17231723
{
17241724
type: "doc",
17251725
id: "rest-api/schemas/notification",

0 commit comments

Comments
 (0)