Skip to content

Commit 7d76fd9

Browse files
committed
update partials/api-resource.hbs
1 parent c32ad25 commit 7d76fd9

1 file changed

Lines changed: 53 additions & 26 deletions

File tree

src/layouts/partials/api-resource.hbs

Lines changed: 53 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
{{#if headingOffset}}
2-
### `{{name}}`
2+
### The {{name}} Object
33
{{else}}
4-
## `{{name}}`
4+
## The {{name}} Object
55
{{/if}}
6+
7+
- [Properties](./#properties)
8+
- [Errors](./#errors)
9+
- [Warnings](./#warnings)
10+
- [Events](./#events)
11+
- [Endpoints](./#endpoints)
12+
613
{{#if description}}
714

815
{{description}}
@@ -20,30 +27,49 @@
2027
{% endtabs %}
2128
{{/if}}
2229

30+
{% tabs %}
31+
{% tab title="JSON" %}
32+
```json
33+
{
2334
{{#each properties}}
24-
{{#if ../headingOffset}}
25-
#### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}}
35+
{{#if @last}}
36+
{{name}}: [example value]
2637
{{else}}
27-
### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}}
38+
{{name}}: [example value],
2839
{{/if}}
29-
{{#if isDeprecated}}
40+
{{/each}}
41+
}
42+
```
43+
{% endtab %}
44+
{% endtabs %}
3045

31-
{{> deprecated-warning}}
46+
---
47+
{{#if headingOffset}}
48+
### Properties
49+
{{else}}
50+
## Properties
3251
{{/if}}
3352
34-
Format: `{{format}}`
35-
{{#if listItemFormat}}
53+
{{#each properties}}
54+
{{#if linkTarget}}[**`{{name}}`**]({{linkTarget}}){{else}}**`{{name}}`**{{/if}} *{{format}}*{{#if listItemFormat}} *of {{listItemFormat}}s*{{/if}}
3655
37-
Item format: `{{listItemFormat}}`
38-
{{/if}}
3956
{{#if description}}
40-
4157
{{description}}
4258
{{/if}}
43-
{{#if enumValues}}
4459
45-
{{> enum-values}}
60+
{{#if isDeprecated}}
61+
{{> deprecated-warning}}
62+
{{/if}}
63+
64+
{{#if enumValues}}
65+
<details>
66+
<summary>Enum values</summary>
67+
{{#each enumValues}}
68+
- `{{this}}`
69+
{{/each}}
70+
</details>
4671
{{/if}}
72+
4773
{{#if value}}
4874
4975
Value: `{{value}}`
@@ -53,11 +79,12 @@ Value: `{{value}}`
5379
5480
This object has no properties.
5581
{{else}}
56-
{{#each objectProperties}}
57-
58-
{{> property-collapsible this}}
59-
60-
{{/each}}
82+
<details>
83+
<summary>Child Properties</summary>
84+
{{#each objectProperties}}
85+
- {{> property-nested this}}
86+
{{/each}}
87+
</details>
6188
{{/if}}
6289
{{/unless}}
6390
{{#if discriminatorVariants}}
@@ -74,8 +101,7 @@ Variants:
74101
{{/if}}
75102
{{#if this.properties.length}}
76103
{{#each this.properties}}
77-
78-
{{> property-non-collapsible this isLast=@last}}
104+
{{> property-non-collapsible this isLast=@last}}
79105
{{/each}}
80106
{{else}}
81107
@@ -85,11 +111,12 @@ This variant has no additional specific properties.
85111
{{/each}}
86112
{{/if}}
87113
{{#if listProperties}}
88-
{{#each listProperties}}
89-
90-
{{> property-collapsible this}}
91-
92-
{{/each}}
114+
<details>
115+
<summary>Child Object Properties</summary>
116+
{{#each listProperties}}
117+
{{> property-nested this}}
118+
{{/each}}
119+
</details>
93120
{{/if}}
94121
95122
---

0 commit comments

Comments
 (0)