Skip to content

Commit b2b3810

Browse files
mikewuuseambotrazor-xDebbieAtSeam
authored
fix: child properties incorrect bullet list nesting (#626)
* switch child prop to html <ul> * ci: Generate docs * Remove example value placeholders (#629) * Remove example value placeholders * ci: Generate docs --------- Co-authored-by: Seam Bot <seambot@getseam.com> * Update SUMMARY with generate_instant_key (#630) * GITBOOK-603: No subject * Add generation for connected accounts (#631) * Update reference.ts * Delete docs/api-clients/connected_accounts directory * Update paths.yaml * ci: Generate docs * Update SUMMARY.md * Update overview.md * Update filtering-devices-by-custom-metadata.md * Update .gitbook.yaml * Update filtering-connected-accounts-by-custom-metadata.md * Update attaching-custom-data-to-the-connect-webview.md * Update README.md * Update README.md * Update adding-custom-metadata-to-a-connected-account.md * Create connected-accounts.yaml * ci: Generate docs * Update SUMMARY.md --------- Co-authored-by: Seam Bot <seambot@getseam.com> * GITBOOK-602: Add SmartThings thermostats guides * Move SmartThings + devices in SUMMARY.md (#632) * GITBOOK-606: Add SmartThings links * Move SmartThings topic (#633) * GITBOOK-605: Change ACS quick starts to use user identities * GITBOOK-607: Delete duplicate bullet * remove ul wrap * ci: Generate docs * make it a list * ci: Generate docs * nest description * ci: Generate docs * only nest list * ci: Generate docs * revert nested * Revert "revert nested" This reverts commit 6a47172. * remove islist * ci: Generate docs * only nest list * ci: Generate docs * add islist prop * ci: Generate docs * add is list prop to api-resource * ci: Generate docs * remove extra code block * ci: Generate docs --------- Co-authored-by: Seam Bot <seambot@getseam.com> Co-authored-by: Evan Sosenko <evan@getseam.com> Co-authored-by: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Co-authored-by: Deborah Femia <debbie@getseam.com>
1 parent 061b90a commit b2b3810

12 files changed

Lines changed: 74 additions & 70 deletions

File tree

docs/api/acs/access_groups/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Warnings associated with the `acs_access_group`.
153153
<details>
154154
<summary>Enum values:</summary>
155155

156-
- <code>unknown_issue_with_acs_access_group`</code>
156+
- <code>unknown_issue_with_acs_access_group</code>
157157
</details>
158158
</details>
159159

docs/api/acs/credentials/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -277,12 +277,12 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
277277
- <strong><code>auto_join</code></strong> <i>Boolean</i>
278278

279279
- <strong><code>card_function_type</code></strong> <i>Enum</i>
280-
<details>
281-
<summary>Enum values:</summary>
282-
283-
- <code>guest`</code>
284-
- <code>staff`</code>
285-
</details>
280+
<details>
281+
<summary>Enum values:</summary>
282+
283+
- <code>guest</code>
284+
- <code>staff</code>
285+
</details>
286286

287287
- <strong><code>card_id</code></strong> <i>String</i>
288288

docs/api/acs/encoders/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
8282
<details>
8383
<summary>Enum values:</summary>
8484

85-
- <code>acs_encoder_removed`</code>
85+
- <code>acs_encoder_removed</code>
8686
</details>
8787

8888
<strong><code>message</code></strong> <i>String</i>

docs/api/acs/entrances/README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,14 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
4848
- <strong><code>door_number</code></strong> <i>Number</i>
4949

5050
- <strong><code>door_type</code></strong> <i>Enum</i>
51-
<details>
52-
<summary>Enum values:</summary>
53-
54-
- <code>CommonDoor`</code>
55-
- <code>EntranceDoor`</code>
56-
- <code>GuestDoor`</code>
57-
- <code>Elevator`</code>
58-
</details>
51+
<details>
52+
<summary>Enum values:</summary>
53+
54+
- <code>CommonDoor</code>
55+
- <code>EntranceDoor</code>
56+
- <code>GuestDoor</code>
57+
- <code>Elevator</code>
58+
</details>
5959

6060
- <strong><code>pms_id</code></strong> <i>String</i>
6161

@@ -197,15 +197,15 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
197197
<summary>Child Properties</summary>
198198

199199
- <strong><code>door_category</code></strong> <i>Enum</i>
200-
<details>
201-
<summary>Enum values:</summary>
202-
203-
- <code>entrance`</code>
204-
- <code>guest`</code>
205-
- <code>elevator reader`</code>
206-
- <code>common`</code>
207-
- <code>common (PMS)`</code>
208-
</details>
200+
<details>
201+
<summary>Enum values:</summary>
202+
203+
- <code>entrance</code>
204+
- <code>guest</code>
205+
- <code>elevator reader</code>
206+
- <code>common</code>
207+
- <code>common (PMS)</code>
208+
</details>
209209

210210
- <strong><code>door_name</code></strong> <i>String</i>
211211

@@ -218,9 +218,9 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
218218
<details>
219219
<summary>Enum values:</summary>
220220

221-
- <code>BLE`</code>
222-
- <code>commonDoor`</code>
223-
- <code>touch`</code>
221+
- <code>BLE</code>
222+
- <code>commonDoor</code>
223+
- <code>touch</code>
224224
</details>
225225

226226

docs/api/acs/systems/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -422,8 +422,8 @@ Indicates whether the `acs_system` is a credential manager.
422422
<summary>Child Properties</summary>
423423

424424
- <strong><code>time_zone</code></strong> <i>String</i>
425-
426-
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
425+
426+
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
427427

428428
</details>
429429

@@ -486,16 +486,16 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
486486
<summary>Child Properties</summary>
487487

488488
- <strong><code>lan_address</code></strong> <i>String</i>
489-
490-
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
489+
490+
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
491491

492492
- <strong><code>mobile_access_uuid</code></strong> <i>String</i>
493-
494-
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
493+
494+
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
495495

496496
- <strong><code>system_id</code></strong> <i>String</i>
497-
498-
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
497+
498+
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
499499

500500
</details>
501501

docs/api/acs/users/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ For details about how to configure `acs_user`s in your access control system, se
2828
<summary>Child Properties</summary>
2929

3030
- <strong><code>ends_at</code></strong> <i>Datetime</i>
31-
32-
Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
31+
32+
Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
3333

3434
- <strong><code>starts_at</code></strong> <i>Datetime</i>
35-
36-
Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
35+
36+
Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
3737

3838
</details>
3939

@@ -611,8 +611,8 @@ Seam is in the process of pushing an access group membership update to the integ
611611
Child Properties
612612

613613
- <strong><code>acs_access_group_id</code></strong> <i>UUID</i>
614-
615-
Old access group ID.
614+
615+
Old access group ID.
616616

617617

618618
---
@@ -643,8 +643,8 @@ Seam is in the process of pushing an access group membership update to the integ
643643
Child Properties
644644

645645
- <strong><code>acs_access_group_id</code></strong> <i>UUID</i>
646-
647-
New access group ID.
646+
647+
New access group ID.
648648

649649

650650
</details>

docs/api/connected_accounts/README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -279,8 +279,8 @@ Indicates that the maximum number of users allowed for the site has been reached
279279
Child Properties
280280

281281
- <strong><code>sites</code></strong> <i>List</i> <i>of Objects</i>
282-
283-
Salto sites associated with the connected account that has an error.
282+
283+
Salto sites associated with the connected account that has an error.
284284

285285
- <strong><code>site_id</code></strong> <i>String</i>
286286

@@ -317,24 +317,24 @@ User identifier associated with the connected account.
317317
<summary>Child Properties</summary>
318318

319319
- <strong><code>api_url</code></strong> <i>String</i>
320-
321-
API URL for the user identifier associated with the connected account.
320+
321+
API URL for the user identifier associated with the connected account.
322322

323323
- <strong><code>email</code></strong> <i>String</i>
324-
325-
Email address of the user identifier associated with the connected account.
324+
325+
Email address of the user identifier associated with the connected account.
326326

327327
- <strong><code>exclusive</code></strong> <i>Boolean</i>
328-
329-
Indicates whether the user identifier associated with the connected account is exclusive.
328+
329+
Indicates whether the user identifier associated with the connected account is exclusive.
330330

331331
- <strong><code>phone</code></strong> <i>String</i>
332-
333-
Phone number of the user identifier associated with the connected account.
332+
333+
Phone number of the user identifier associated with the connected account.
334334

335335
- <strong><code>username</code></strong> <i>String</i>
336-
337-
Username of the user identifier associated with the connected account.
336+
337+
Username of the user identifier associated with the connected account.
338338

339339
</details>
340340

@@ -443,8 +443,8 @@ Indicates that the Salto KS site has exceeded 80% of the maximum number of allow
443443
Child Properties
444444

445445
- <strong><code>sites</code></strong> <i>List</i> <i>of Objects</i>
446-
447-
Salto sites associated with the connected account that has a warning.
446+
447+
Salto sites associated with the connected account that has a warning.
448448

449449
- <strong><code>site_id</code></strong> <i>String</i>
450450

docs/api/thermostats/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad
9696
<details>
9797
<summary>Enum values:</summary>
9898

99-
- <code>auto`</code>
100-
- <code>on`</code>
101-
- <code>circulate`</code>
99+
- <code>auto</code>
100+
- <code>on</code>
101+
- <code>circulate</code>
102102
</details>
103103

104104
<strong><code>heating_set_point_celsius</code></strong> <i>Number</i>
@@ -115,10 +115,10 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad
115115
<details>
116116
<summary>Enum values:</summary>
117117

118-
- <code>off`</code>
119-
- <code>heat`</code>
120-
- <code>cool`</code>
121-
- <code>heat_cool`</code>
118+
- <code>off</code>
119+
- <code>heat</code>
120+
- <code>cool</code>
121+
- <code>heat_cool</code>
122122
</details>
123123

124124
<strong><code>method</code></strong> <i>Enum</i>
@@ -127,8 +127,8 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad
127127
<details>
128128
<summary>Enum values:</summary>
129129

130-
- <code>seam`</code>
131-
- <code>external`</code>
130+
- <code>seam</code>
131+
- <code>external</code>
132132
</details>
133133

134134
<strong><code>occurred_at</code></strong> <i>Datetime</i>

src/layouts/partials/api-resource.hbs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ This object has no properties.
6868
<summary>Child Properties</summary>
6969
7070
{{#each objectProperties}}
71-
- {{> property-nested this}}
71+
- {{> property-nested this isList=true}}
7272
{{/each}}
7373
</details>
7474
{{/if}}

src/layouts/partials/property-content.hbs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ This object has no properties.
3232
Child Properties
3333

3434
{{#each objectProperties}}
35-
- {{> property-nested this}}
35+
- {{> property-nested this isList=true }}
3636
{{/each}}
3737
{{/if}}
3838
{{/unless}}

0 commit comments

Comments
 (0)