Skip to content

Commit 6a41621

Browse files
ShaunaDiazopenshift-cherrypick-robot
authored andcommitted
OSDOCS-15507-ms: removes discrete headings API docs MicroShift
1 parent 862a5e1 commit 6a41621

File tree

3 files changed

+20
-31
lines changed

3 files changed

+20
-31
lines changed

microshift_rest_api/api_extensions_apis/api-extensions-apis-index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
:_mod-docs-content-type: ASSEMBLY
33
[id="api-extensions-apis"]
44
= API Extensions APIs
5+
//adding a line space here breaks the TOC
56
:toc: macro
67
:toc-title:
78

microshift_rest_api/api_extensions_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
:_mod-docs-content-type: ASSEMBLY
33
[id="customresourcedefinition-apiextensions-k8s-io-v1"]
44
= CustomResourceDefinition [apiextensions.k8s.io/v1]
5+
//adding a line space here breaks the TOC
56
:toc: macro
67
:toc-title:
78

@@ -11,7 +12,7 @@ toc::[]
1112
Description::
1213
+
1314
--
14-
CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.
15+
CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.
1516
--
1617

1718
Type::
@@ -48,6 +49,7 @@ Required::
4849
| CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition
4950

5051
|===
52+
//all API docs have L3s for .spec
5153
=== .spec
5254
Description::
5355
+
@@ -772,10 +774,10 @@ Description::
772774
| Parameter | Type | Description
773775
| `allowWatchBookmarks`
774776
| `boolean`
775-
| allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#x27;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.
777+
| allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks might ignore this flag and bookmarks are sent at the server&#x27;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.
776778
| `continue`
777779
| `string`
778-
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;.
780+
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients might only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;.
779781

780782
This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
781783
| `fieldSelector`

microshift_rest_api/objects/index.adoc

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ Type::
2323
Required::
2424
- `items`
2525

26-
[discrete]
27-
=== Schema
26+
Schema::
2827

2928
[cols="1,1,1",options="header"]
3029
|===
@@ -64,8 +63,7 @@ Type::
6463
Required::
6564
- `items`
6665

67-
[discrete]
68-
=== Schema
66+
Schema::
6967

7068
[cols="1,1,1",options="header"]
7169
|===
@@ -105,8 +103,7 @@ Type::
105103
Required::
106104
- `items`
107105

108-
[discrete]
109-
=== Schema
106+
Schema::
110107

111108
[cols="1,1,1",options="header"]
112109
|===
@@ -146,8 +143,7 @@ Type::
146143
Required::
147144
- `items`
148145

149-
[discrete]
150-
=== Schema
146+
Schema::
151147

152148
[cols="1,1,1",options="header"]
153149
|===
@@ -187,8 +183,7 @@ Type::
187183
Required::
188184
- `items`
189185

190-
[discrete]
191-
=== Schema
186+
Schema::
192187

193188
[cols="1,1,1",options="header"]
194189
|===
@@ -228,8 +223,7 @@ Type::
228223
Required::
229224
- `items`
230225

231-
[discrete]
232-
=== Schema
226+
Schema::
233227

234228
[cols="1,1,1",options="header"]
235229
|===
@@ -269,8 +263,7 @@ Type::
269263
Required::
270264
- `items`
271265

272-
[discrete]
273-
=== Schema
266+
Schema::
274267

275268
[cols="1,1,1",options="header"]
276269
|===
@@ -310,8 +303,7 @@ Type::
310303
Required::
311304
- `items`
312305

313-
[discrete]
314-
=== Schema
306+
Schema::
315307

316308
[cols="1,1,1",options="header"]
317309
|===
@@ -351,8 +343,7 @@ Type::
351343
Required::
352344
- `items`
353345

354-
[discrete]
355-
=== Schema
346+
Schema::
356347

357348
[cols="1,1,1",options="header"]
358349
|===
@@ -392,8 +383,7 @@ Type::
392383
Required::
393384
- `items`
394385

395-
[discrete]
396-
=== Schema
386+
Schema::
397387

398388
[cols="1,1,1",options="header"]
399389
|===
@@ -433,8 +423,7 @@ Type::
433423
Required::
434424
- `items`
435425

436-
[discrete]
437-
=== Schema
426+
Schema::
438427

439428
[cols="1,1,1",options="header"]
440429
|===
@@ -474,8 +463,7 @@ Type::
474463
Required::
475464
- `items`
476465

477-
[discrete]
478-
=== Schema
466+
Schema::
479467

480468
[cols="1,1,1",options="header"]
481469
|===
@@ -513,8 +501,7 @@ Type::
513501
`object`
514502

515503

516-
[discrete]
517-
=== Schema
504+
Schema::
518505

519506
[cols="1,1,1",options="header"]
520507
|===
@@ -552,8 +539,7 @@ Type::
552539
Required::
553540
- `volumeID`
554541

555-
[discrete]
556-
=== Schema
542+
Schema::
557543

558544
[cols="1,1,1",options="header"]
559545
|===

0 commit comments

Comments
 (0)