Skip to content

Commit 104c71c

Browse files
authored
docs: Add note on the body requirement (#3941)
* Add note on the body requirement * Remove obsolete example
1 parent d19f6d3 commit 104c71c

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

docs/extensibility/30-details-summary.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@ Extra parameters might be available for specific widgets.
2323

2424
#### Status Body
2525

26-
The **data.details.status.body** is an array of objects. By default listed values are displayed in two columns. Adding parameter **fullWidth: true** will display values in one column. The **data.details.status.body** accepts one widget (for example [ConditionList](./50-list-and-details-widgets.md#conditionList))
26+
The **data.details.status.body** is an array of objects. By default, listed values are displayed in two columns. Adding parameter **fullWidth: true** displays values in one column. The **data.details.status.body** accepts one widget (for example, [ConditionList](./50-list-and-details-widgets.md#conditionList)).
27+
28+
> [!NOTE]
29+
> The **data.details.status.body** field is required for the **data.details.status** to render properly.
2730
2831
See the following examples:
2932

@@ -48,19 +51,6 @@ details:
4851
source: status.conditions
4952
```
5053
51-
```yaml
52-
details:
53-
status:
54-
- name: Replicas
55-
source: status.replicas
56-
- name: Containers
57-
source: status.containers
58-
fullWidth: true
59-
- name: Condition details
60-
widget: ConditionList
61-
source: status.conditions
62-
```
63-
6454
#### Status Header
6555
6656
The **data.details.status.header** accepts one widget (for example [Badge](./50-list-and-details-widgets.md#badge)), displayed on the right side of the **Status** section header. This widget is used to summarize the status of the resource.

0 commit comments

Comments
 (0)