Skip to content

Commit 67267b5

Browse files
authored
Merge pull request #51145 from ahardin-rh/51112-typo-fix
GitHub#51112: corrected incorrect string syntax
2 parents f2e7872 + d5a6938 commit 67267b5

File tree

1 file changed

+34
-32
lines changed

1 file changed

+34
-32
lines changed

modules/dynamic-plug-in-sdk-extensions.adoc

Lines changed: 34 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,12 @@ submenus.
5050
|`submenu` |`boolean` |yes |Whether this group should be displayed as
5151
submenu
5252

53-
|`insertBefore` |`string | string[]` |yes |Insert this item before the
53+
|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
5454
item referenced here.For arrays, the first one found in order is used.
5555

56-
|`insertAfter` |`string | string[]` |yes |Insert this item after the
56+
|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
5757
item referenced here.For arrays, the first one found in order is
58-
used.insertBefore takes precedence.
58+
used. The `insertBefore` value takes precedence.
5959
|===
6060

6161
'''''
@@ -119,7 +119,9 @@ which returns actions for the given resource model
119119
|===
120120
|Name |Value Type |Optional |Description
121121
|`alert` |`string` |no |
122+
122123
|`text` |`string` |no |
124+
123125
|`action` |`CodeRef<(alert: any) => void>` |no |
124126
|===
125127

@@ -137,13 +139,13 @@ which returns actions for the given resource model
137139
[cols=",,,",options="header",]
138140
|===
139141
|Name |Value Type |Optional |Description
140-
|`catalogId` |`string | string[]` |no |The unique identifier for the
142+
|`catalogId` |`string` \| `string[]` |no |The unique identifier for the
141143
catalog this provider contributes to.
142144

143145
|`type` |`string` |no |Type ID for the catalog item type.
144146

145147
|`filter` |`CodeRef<(item: CatalogItem) => boolean>` |no |Filters items
146-
of a specific type. Value is a function that takes CatalogItem[] and
148+
of a specific type. Value is a function that takes `CatalogItem[]` and
147149
returns a subset based on the filter criteria.
148150
|===
149151

@@ -161,7 +163,7 @@ returns a subset based on the filter criteria.
161163
[cols=",,,",options="header",]
162164
|===
163165
|Name |Value Type |Optional |Description
164-
|`catalogId` |`string | string[]` |no |The unique identifier for the
166+
|`catalogId` |`string` \| `string[]` |no |The unique identifier for the
165167
catalog this provider contributes to.
166168

167169
|`type` |`string` |no |Type ID for the catalog item type.
@@ -186,7 +188,7 @@ metadata to catalog items of a specific type.
186188
[cols=",,,",options="header",]
187189
|===
188190
|Name |Value Type |Optional |Description
189-
|`catalogId` |`string | string[]` |no |The unique identifier for the
191+
|`catalogId` |`string` \| `string[]` |no |The unique identifier for the
190192
catalog this provider contributes to.
191193

192194
|`type` |`string` |no |Type ID for the catalog item type.
@@ -221,7 +223,7 @@ providers.
221223

222224
|`title` |`string` |no |Title for the catalog item.
223225

224-
|`catalogDescription` |`string | CodeRef<React.ReactNode>` |yes
226+
|`catalogDescription` |`string` \| `CodeRef<React.ReactNode>` |yes
225227
|Description for the type specific catalog.
226228

227229
|`typeDescription` |`string` |yes |Description for the catalog item
@@ -370,7 +372,7 @@ Adds a new dashboard card.
370372
|`tab` |`string` |no |The id of the dashboard tab to which the card will
371373
be added.
372374

373-
|`position` |`'LEFT' | 'RIGHT' | 'MAIN'` |no |The grid position of the
375+
|`position` |`'LEFT' \| 'RIGHT' \| 'MAIN'` |no |The grid position of the
374376
card on the dashboard.
375377

376378
|`component` |`CodeRef<React.ComponentType<{}>>` |no |Dashboard card
@@ -448,7 +450,7 @@ the source of status is a K8s REST API.
448450
which will be fetched and passed to `healthHandler`.
449451

450452
|`getOperatorsWithStatuses` |`CodeRef<GetOperatorsWithStatuses<T>>` |yes
451-
|Resolves status for the operators.
453+
|Resolves status for the Operators.
452454

453455
|`operatorRowLoader`
454456
|`CodeRef<React.ComponentType<OperatorRowProps<T>>>` |yes |Loader for
@@ -601,7 +603,7 @@ Adds an inventory status group.
601603
|`id` |`string` |no |The id of the status group.
602604

603605
|`icon`
604-
|`CodeRef<React.ReactElement<any, string | React.JSXElementConstructor<any>>>`
606+
|`CodeRef<React.ReactElement<any, string` \| `React.JSXElementConstructor<any>>>`
605607
|no |React component representing the status group icon.
606608
|===
607609

@@ -695,7 +697,7 @@ Adds a new dashboard tab, placed after the Overview tab.
695697
|`id` |`string` |no |A unique tab identifier, used as tab link `href`
696698
and when adding cards to this tab.
697699

698-
|`navSection` |`'home' | 'storage'` |no |NavSection to which the tab
700+
|`navSection` |`'home' \| 'storage'` |no |NavSection to which the tab
699701
belongs to
700702

701703
|`title` |`string` |no |The title of the tab.
@@ -871,18 +873,18 @@ attributes to the DOM.
871873
|`startsWith` |`string[]` |yes |Mark this item as active when the URL
872874
starts with one of these paths.
873875

874-
|`insertBefore` |`string | string[]` |yes |Insert this item before the
876+
|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
875877
item referenced here. For arrays, the first one found in order is used.
876878

877-
|`insertAfter` |`string | string[]` |yes |Insert this item after the
879+
|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
878880
item referenced here. For arrays, the first one found in order is used.
879881
`insertBefore` takes precedence.
880882

881-
|`namespaced` |`boolean` |yes |if true, adds /ns/active-namespace to the
883+
|`namespaced` |`boolean` |yes |If true, adds `/ns/active-namespace` to the
882884
end
883885

884-
|`prefixNamespaced` |`boolean` |yes |if true, adds
885-
/k8s/ns/active-namespace to the begining
886+
|`prefixNamespaced` |`boolean` |yes |If true, adds
887+
`/k8s/ns/active-namespace` to the beginning
886888
|===
887889

888890
'''''
@@ -916,10 +918,10 @@ attributes to the DOM.
916918
|`startsWith` |`string[]` |yes |Mark this item as active when the URL
917919
starts with one of these paths.
918920

919-
|`insertBefore` |`string | string[]` |yes |Insert this item before the
921+
|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
920922
item referenced here. For arrays, the first one found in order is used.
921923

922-
|`insertAfter` |`string | string[]` |yes |Insert this item after the
924+
|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
923925
item referenced here. For arrays, the first one found in order is used.
924926
`insertBefore` takes precedence.
925927

@@ -958,10 +960,10 @@ attributes to the DOM.
958960
|`startsWith` |`string[]` |yes |Mark this item as active when the URL
959961
starts with one of these paths.
960962

961-
|`insertBefore` |`string | string[]` |yes |Insert this item before the
963+
|`insertBefore` |`string \| string[]` |yes |Insert this item before the
962964
item referenced here. For arrays, the first one found in order is used.
963965

964-
|`insertAfter` |`string | string[]` |yes |Insert this item after the
966+
|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
965967
item referenced here. For arrays, the first one found in order is used.
966968
`insertBefore` takes precedence.
967969

@@ -991,10 +993,10 @@ belongs to. If not specified, contributes to the default perspective.
991993
|`dataAttributes` |`{ [key: string]: string; }` |yes |Adds data
992994
attributes to the DOM.
993995

994-
|`insertBefore` |`string | string[]` |yes |Insert this item before the
996+
|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
995997
item referenced here. For arrays, the first one found in order is used.
996998

997-
|`insertAfter` |`string | string[]` |yes |Insert this item after the
999+
|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
9981000
item referenced here. For arrays, the first one found in order is used.
9991001
`insertBefore` takes precedence.
10001002

@@ -1027,10 +1029,10 @@ to. If not specified, render this item as a top level link.
10271029
|`dataAttributes` |`{ [key: string]: string; }` |yes |Adds data
10281030
attributes to the DOM.
10291031

1030-
|`insertBefore` |`string | string[]` |yes |Insert this item before the
1032+
|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
10311033
item referenced here. For arrays, the first one found in order is used.
10321034

1033-
|`insertAfter` |`string | string[]` |yes |Insert this item after the
1035+
|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
10341036
item referenced here. For arrays, the first one found in order is used.
10351037
`insertBefore` takes precedence.
10361038
|===
@@ -1098,7 +1100,7 @@ https://v5.reactrouter.com/
10981100
|`CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>`
10991101
|no |The component to be rendered when the route matches.
11001102

1101-
|`path` |`string | string[]` |no |Valid URL path or array of paths that
1103+
|`path` |`string` \| `string[]` |no |Valid URL path or array of paths that
11021104
`path-to-regexp@^1.7.0` understands.
11031105

11041106
|`perspective` |`string` |yes |The perspective to which this page
@@ -1128,7 +1130,7 @@ https://v5.reactrouter.com/
11281130
|`CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>`
11291131
|no |The component to be rendered when the route matches.
11301132

1131-
|`path` |`string | string[]` |no |Valid URL path or array of paths that
1133+
|`path` |`string` \| `string[]` |no |Valid URL path or array of paths that
11321134
`path-to-regexp@^1.7.0` understands.
11331135

11341136
|`exact` |`boolean` |yes |When true, will only match if the path matches
@@ -1635,10 +1637,10 @@ DetailsTab contributes a tab for the topology details panel.
16351637

16361638
|`label` |`string` |no |The tab label to display in the UI.
16371639

1638-
|`insertBefore` |`string | string[]` |yes |Insert this item before the
1640+
|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
16391641
item referenced here.For arrays, the first one found in order is used.
16401642

1641-
|`insertAfter` |`string | string[]` |yes |Insert this item after the
1643+
|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
16421644
item referenced here.For arrays, the first one found in order is
16431645
used.insertBefore takes precedence.
16441646
|===
@@ -1672,12 +1674,12 @@ topology sidebar.SDK component: <Section title=\{}>... padded area
16721674
|no |@deprecated Fallback if no provider is defined. renderNull is a
16731675
no-op already.
16741676

1675-
|`insertBefore` |`string | string[]` |yes |Insert this item before the
1677+
|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
16761678
item referenced here.For arrays, the first one found in order is used.
16771679

1678-
|`insertAfter` |`string | string[]` |yes |Insert this item after the
1680+
|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
16791681
item referenced here.For arrays, the first one found in order is
1680-
used.insertBefore takes precedence.
1682+
used. The `insertBefore` value takes precedence.
16811683
|===
16821684

16831685
'''''

0 commit comments

Comments
 (0)