mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 21:46:22 +01:00
OSDOCS-15507-ms: removes discrete headings API docs MicroShift
This commit is contained in:
committed by
openshift-cherrypick-robot
parent
f61f111a3e
commit
d37090501e
@@ -2,6 +2,7 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="api-extensions-apis"]
|
||||
= API Extensions APIs
|
||||
//adding a line space here breaks the TOC
|
||||
:toc: macro
|
||||
:toc-title:
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="customresourcedefinition-apiextensions-k8s-io-v1"]
|
||||
= CustomResourceDefinition [apiextensions.k8s.io/v1]
|
||||
//adding a line space here breaks the TOC
|
||||
:toc: macro
|
||||
:toc-title:
|
||||
|
||||
@@ -11,7 +12,7 @@ toc::[]
|
||||
Description::
|
||||
+
|
||||
--
|
||||
CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.
|
||||
CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.
|
||||
--
|
||||
|
||||
Type::
|
||||
@@ -48,6 +49,7 @@ Required::
|
||||
| CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition
|
||||
|
||||
|===
|
||||
//all API docs have L3s for .spec
|
||||
=== .spec
|
||||
Description::
|
||||
+
|
||||
@@ -772,10 +774,10 @@ Description::
|
||||
| Parameter | Type | Description
|
||||
| `allowWatchBookmarks`
|
||||
| `boolean`
|
||||
| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server'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.
|
||||
| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks might ignore this flag and bookmarks are sent at the server'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.
|
||||
| `continue`
|
||||
| `string`
|
||||
| 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 "next key".
|
||||
| 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 "next key".
|
||||
|
||||
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.
|
||||
| `fieldSelector`
|
||||
|
||||
@@ -23,8 +23,7 @@ Type::
|
||||
Required::
|
||||
- `items`
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
@@ -64,8 +63,7 @@ Type::
|
||||
Required::
|
||||
- `items`
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
@@ -105,8 +103,7 @@ Type::
|
||||
Required::
|
||||
- `items`
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
@@ -146,8 +143,7 @@ Type::
|
||||
Required::
|
||||
- `items`
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
@@ -187,8 +183,7 @@ Type::
|
||||
Required::
|
||||
- `items`
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
@@ -228,8 +223,7 @@ Type::
|
||||
Required::
|
||||
- `items`
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
@@ -269,8 +263,7 @@ Type::
|
||||
Required::
|
||||
- `items`
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
@@ -310,8 +303,7 @@ Type::
|
||||
Required::
|
||||
- `items`
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
@@ -351,8 +343,7 @@ Type::
|
||||
Required::
|
||||
- `items`
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
@@ -392,8 +383,7 @@ Type::
|
||||
Required::
|
||||
- `items`
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
@@ -433,8 +423,7 @@ Type::
|
||||
Required::
|
||||
- `items`
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
@@ -474,8 +463,7 @@ Type::
|
||||
Required::
|
||||
- `items`
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
@@ -513,8 +501,7 @@ Type::
|
||||
`object`
|
||||
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
@@ -552,8 +539,7 @@ Type::
|
||||
Required::
|
||||
- `volumeID`
|
||||
|
||||
[discrete]
|
||||
=== Schema
|
||||
Schema::
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
|
||||
Reference in New Issue
Block a user