Skip to content

Commit 817c289

Browse files
polarweaselpolarweasel
authored
fix(docs): correct entity output in asyncapi doc script (#64)
1 parent 24cc2cb commit 817c289

31 files changed

Lines changed: 680 additions & 680 deletions

‎docs/schema-bms-ahu-metadata.mdx‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ the parent `oneOf`.
4444
|------|------|----------|-------------|
4545
| `objectName` | string | Yes | Human-readable equipment name. |
4646
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
47-
| `servesId` | array\<string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
47+
| `servesId` | array<string> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
4848

4949
### Associate Mode
5050

@@ -90,7 +90,7 @@ Measurement fields for LiquidDifferentialPressure. Typical engUnit: kPa. The ide
9090

9191
| Name | Type | Required | Description |
9292
|------|------|----------|-------------|
93-
| `stateText` | array\<map\<string, any\>\> | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
93+
| `stateText` | array<map<string, any>> | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
9494

9595
<Accordion title="Example payload">
9696

@@ -120,7 +120,7 @@ Measurement fields for LiquidFlow. Typical engUnit: LPM. The identifier (named-o
120120

121121
| Name | Type | Required | Description |
122122
|------|------|----------|-------------|
123-
| `stateText` | array\&lt;map\&lt;string, any\>\> | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
123+
| `stateText` | array&lt;map&lt;string, any&gt;&gt; | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
124124

125125
<Accordion title="Example payload">
126126

@@ -150,7 +150,7 @@ Measurement fields for LiquidPressure. Typical engUnit: kPa. The identifier (nam
150150

151151
| Name | Type | Required | Description |
152152
|------|------|----------|-------------|
153-
| `stateText` | array\&lt;map\&lt;string, any\>\> | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
153+
| `stateText` | array&lt;map&lt;string, any&gt;&gt; | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
154154

155155
<Accordion title="Example payload">
156156

@@ -183,7 +183,7 @@ the parent `oneOf`.
183183
|------|------|----------|-------------|
184184
| `objectName` | string | Yes | Human-readable equipment name. |
185185
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
186-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
186+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
187187

188188
### Associate Mode
189189

@@ -232,7 +232,7 @@ the parent `oneOf`.
232232
|------|------|----------|-------------|
233233
| `objectName` | string | Yes | Human-readable equipment name. |
234234
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
235-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
235+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
236236

237237
### Associate Mode
238238

@@ -278,7 +278,7 @@ Measurement fields for ValvePosition. Typical engUnit: %. The identifier (named-
278278

279279
| Name | Type | Required | Description |
280280
|------|------|----------|-------------|
281-
| `stateText` | array\&lt;map\&lt;string, any\>\> | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
281+
| `stateText` | array&lt;map&lt;string, any&gt;&gt; | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
282282

283283
<Accordion title="Example payload">
284284

@@ -308,7 +308,7 @@ Measurement fields for PumpSpeed. Typical engUnit: RPM. The identifier (named-ob
308308

309309
| Name | Type | Required | Description |
310310
|------|------|----------|-------------|
311-
| `stateText` | array\&lt;map\&lt;string, any\>\> | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
311+
| `stateText` | array&lt;map&lt;string, any&gt;&gt; | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
312312

313313
<Accordion title="Example payload">
314314

@@ -338,7 +338,7 @@ Measurement fields for FanSpeed. Typical engUnit: RPM. The identifier (named-obj
338338

339339
| Name | Type | Required | Description |
340340
|------|------|----------|-------------|
341-
| `stateText` | array\&lt;map\&lt;string, any\>\> | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
341+
| `stateText` | array&lt;map&lt;string, any&gt;&gt; | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
342342

343343
<Accordion title="Example payload">
344344

@@ -368,7 +368,7 @@ Measurement fields for DamperPosition. Typical engUnit: %. The identifier (named
368368

369369
| Name | Type | Required | Description |
370370
|------|------|----------|-------------|
371-
| `stateText` | array\&lt;map\&lt;string, any\>\> | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
371+
| `stateText` | array&lt;map&lt;string, any&gt;&gt; | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
372372

373373
<Accordion title="Example payload">
374374

@@ -401,7 +401,7 @@ the parent `oneOf`.
401401
|------|------|----------|-------------|
402402
| `objectName` | string | Yes | Human-readable equipment name. |
403403
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
404-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
404+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
405405

406406
### Associate Mode
407407

@@ -447,7 +447,7 @@ Measurement fields for AirDifferentialPressure. Typical engUnit: Pa. The identif
447447

448448
| Name | Type | Required | Description |
449449
|------|------|----------|-------------|
450-
| `stateText` | array\&lt;map\&lt;string, any\>\> | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
450+
| `stateText` | array&lt;map&lt;string, any&gt;&gt; | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
451451

452452
<Accordion title="Example payload">
453453

@@ -477,7 +477,7 @@ Measurement fields for AirRelativeHumidity. Typical engUnit: %RH. The identifier
477477

478478
| Name | Type | Required | Description |
479479
|------|------|----------|-------------|
480-
| `stateText` | array\&lt;map\&lt;string, any\>\> | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
480+
| `stateText` | array&lt;map&lt;string, any&gt;&gt; | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
481481

482482
<Accordion title="Example payload">
483483

@@ -507,7 +507,7 @@ Measurement fields for AirFlow. Typical engUnit: CFM. The identifier (named-obje
507507

508508
| Name | Type | Required | Description |
509509
|------|------|----------|-------------|
510-
| `stateText` | array\&lt;map\&lt;string, any\>\> | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
510+
| `stateText` | array&lt;map&lt;string, any&gt;&gt; | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
511511

512512
<Accordion title="Example payload">
513513

@@ -537,7 +537,7 @@ Measurement fields for AirPressure. Typical engUnit: Pa. The identifier (named-o
537537

538538
| Name | Type | Required | Description |
539539
|------|------|----------|-------------|
540-
| `stateText` | array\&lt;map\&lt;string, any\>\> | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
540+
| `stateText` | array&lt;map&lt;string, any&gt;&gt; | Yes | State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`). |
541541

542542
<Accordion title="Example payload">
543543

@@ -570,7 +570,7 @@ the parent `oneOf`.
570570
|------|------|----------|-------------|
571571
| `objectName` | string | Yes | Human-readable equipment name. |
572572
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
573-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
573+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
574574

575575
### Associate Mode
576576

@@ -621,7 +621,7 @@ the parent `oneOf`.
621621
|------|------|----------|-------------|
622622
| `objectName` | string | Yes | Human-readable equipment name. |
623623
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
624-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
624+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
625625

626626
### Associate Mode
627627

‎docs/schema-bms-ats-metadata.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ the parent `oneOf`.
4444
|------|------|----------|-------------|
4545
| `objectName` | string | Yes | Human-readable equipment name. |
4646
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
47-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
47+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
4848

4949
### Associate Mode
5050

@@ -93,7 +93,7 @@ the parent `oneOf`.
9393
|------|------|----------|-------------|
9494
| `objectName` | string | Yes | Human-readable equipment name. |
9595
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
96-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
96+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
9797

9898
### Associate Mode
9999

@@ -144,7 +144,7 @@ the parent `oneOf`.
144144
|------|------|----------|-------------|
145145
| `objectName` | string | Yes | Human-readable equipment name. |
146146
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
147-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
147+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
148148

149149
### Associate Mode
150150

‎docs/schema-bms-bess-metadata.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ the parent `oneOf`.
4444
|------|------|----------|-------------|
4545
| `objectName` | string | Yes | Human-readable equipment name. |
4646
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
47-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
47+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
4848

4949
### Associate Mode
5050

@@ -93,7 +93,7 @@ the parent `oneOf`.
9393
|------|------|----------|-------------|
9494
| `objectName` | string | Yes | Human-readable equipment name. |
9595
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
96-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
96+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
9797

9898
### Associate Mode
9999

@@ -144,7 +144,7 @@ the parent `oneOf`.
144144
|------|------|----------|-------------|
145145
| `objectName` | string | Yes | Human-readable equipment name. |
146146
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
147-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
147+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
148148

149149
### Associate Mode
150150

‎docs/schema-bms-breaker-metadata.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ the parent `oneOf`.
4444
|------|------|----------|-------------|
4545
| `objectName` | string | Yes | Human-readable equipment name. |
4646
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
47-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
47+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
4848

4949
### Associate Mode
5050

@@ -93,7 +93,7 @@ the parent `oneOf`.
9393
|------|------|----------|-------------|
9494
| `objectName` | string | Yes | Human-readable equipment name. |
9595
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
96-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
96+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
9797

9898
### Associate Mode
9999

@@ -144,7 +144,7 @@ the parent `oneOf`.
144144
|------|------|----------|-------------|
145145
| `objectName` | string | Yes | Human-readable equipment name. |
146146
| `objectId` | string | Yes | Stable unique identifier for the equipment. |
147-
| `servesId` | array\&lt;string\> | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
147+
| `servesId` | array&lt;string&gt; | No | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |
148148

149149
### Associate Mode
150150

0 commit comments

Comments
 (0)