Skip to content

Commit 50577e6

Browse files
deads2kdeads2k
committed
generated
1 parent 054edce commit 50577e6

File tree

91 files changed

+9539
-23518
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+9539
-23518
lines changed

‎api/docs/api/v1.Binding.adoc

-72
Original file line numberDiff line numberDiff line change
@@ -103,78 +103,6 @@ Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-gu
103103

104104
== Operations
105105

106-
[[Post-api-v1-bindings]]
107-
=== Create a Binding
108-
Create a Binding
109-
110-
==== HTTP request
111-
----
112-
POST /api/v1/bindings HTTP/1.1
113-
Authorization: Bearer $TOKEN
114-
Accept: application/json
115-
Connection: close
116-
Content-Type: application/json'
117-
118-
{
119-
"kind": "Binding",
120-
"apiVersion": "v1",
121-
...
122-
}
123-
124-
----
125-
126-
==== Curl request
127-
----
128-
$ curl -k \
129-
-X POST \
130-
-d @- \
131-
-H "Authorization: Bearer $TOKEN" \
132-
-H 'Accept: application/json' \
133-
-H 'Content-Type: application/json' \
134-
https://$ENDPOINT/api/v1/bindings <<'EOF'
135-
{
136-
"kind": "Binding",
137-
"apiVersion": "v1",
138-
...
139-
}
140-
EOF
141-
----
142-
143-
==== HTTP body
144-
[cols="1,5", options="header"]
145-
|===
146-
|Parameter|Schema
147-
|body|v1.Binding
148-
|===
149-
150-
==== Query parameters
151-
[cols="1,5", options="header"]
152-
|===
153-
|Parameter|Description
154-
|pretty|If 'true', then the output is pretty printed.
155-
|===
156-
157-
==== Responses
158-
[cols="1,5", options="header"]
159-
|===
160-
|HTTP Code|Schema
161-
|200 OK|v1.Binding
162-
|201 Created|v1.Binding
163-
|202 Accepted|v1.Binding
164-
|401 Unauthorized|
165-
|===
166-
167-
==== Consumes
168-
169-
* \*/*
170-
171-
==== Produces
172-
173-
* application/json
174-
* application/yaml
175-
* application/vnd.kubernetes.protobuf
176-
177-
178106
[[Post-api-v1-namespaces-namespace-bindings]]
179107
=== Create a Binding in a namespace
180108
Create a Binding

‎api/docs/api/v1.ConfigMap.adoc

+1-73
Original file line numberDiff line numberDiff line change
@@ -99,78 +99,6 @@ Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-gu
9999

100100
== Operations
101101

102-
[[Post-api-v1-configmaps]]
103-
=== Create a ConfigMap
104-
Create a ConfigMap
105-
106-
==== HTTP request
107-
----
108-
POST /api/v1/configmaps HTTP/1.1
109-
Authorization: Bearer $TOKEN
110-
Accept: application/json
111-
Connection: close
112-
Content-Type: application/json'
113-
114-
{
115-
"kind": "ConfigMap",
116-
"apiVersion": "v1",
117-
...
118-
}
119-
120-
----
121-
122-
==== Curl request
123-
----
124-
$ curl -k \
125-
-X POST \
126-
-d @- \
127-
-H "Authorization: Bearer $TOKEN" \
128-
-H 'Accept: application/json' \
129-
-H 'Content-Type: application/json' \
130-
https://$ENDPOINT/api/v1/configmaps <<'EOF'
131-
{
132-
"kind": "ConfigMap",
133-
"apiVersion": "v1",
134-
...
135-
}
136-
EOF
137-
----
138-
139-
==== HTTP body
140-
[cols="1,5", options="header"]
141-
|===
142-
|Parameter|Schema
143-
|body|v1.ConfigMap
144-
|===
145-
146-
==== Query parameters
147-
[cols="1,5", options="header"]
148-
|===
149-
|Parameter|Description
150-
|pretty|If 'true', then the output is pretty printed.
151-
|===
152-
153-
==== Responses
154-
[cols="1,5", options="header"]
155-
|===
156-
|HTTP Code|Schema
157-
|200 OK|v1.ConfigMap
158-
|201 Created|v1.ConfigMap
159-
|202 Accepted|v1.ConfigMap
160-
|401 Unauthorized|
161-
|===
162-
163-
==== Consumes
164-
165-
* \*/*
166-
167-
==== Produces
168-
169-
* application/json
170-
* application/yaml
171-
* application/vnd.kubernetes.protobuf
172-
173-
174102
[[Post-api-v1-namespaces-namespace-configmaps]]
175103
=== Create a ConfigMap in a namespace
176104
Create a ConfigMap
@@ -330,14 +258,14 @@ $ curl -k \
330258
[cols="1,5", options="header"]
331259
|===
332260
|Parameter|Description
333-
|pretty|If 'true', then the output is pretty printed.
334261
|continue|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 indicating the client must restart their list without the continue field. 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.
335262
|fieldSelector|A selector to restrict the list of returned objects by their fields. Defaults to everything.
336263
|includeUninitialized|If true, partially initialized resources are included in the response.
337264
|labelSelector|A selector to restrict the list of returned objects by their labels. Defaults to everything.
338265
|limit|limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
339266

340267
The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
268+
|pretty|If 'true', then the output is pretty printed.
341269
|resourceVersion|When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
342270
|timeoutSeconds|Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
343271
|watch|Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

‎api/docs/api/v1.Endpoints.adoc

+1-73
Original file line numberDiff line numberDiff line change
@@ -135,78 +135,6 @@ Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-gu
135135

136136
== Operations
137137

138-
[[Post-api-v1-endpoints]]
139-
=== Create a Endpoints
140-
Create Endpoints
141-
142-
==== HTTP request
143-
----
144-
POST /api/v1/endpoints HTTP/1.1
145-
Authorization: Bearer $TOKEN
146-
Accept: application/json
147-
Connection: close
148-
Content-Type: application/json'
149-
150-
{
151-
"kind": "Endpoints",
152-
"apiVersion": "v1",
153-
...
154-
}
155-
156-
----
157-
158-
==== Curl request
159-
----
160-
$ curl -k \
161-
-X POST \
162-
-d @- \
163-
-H "Authorization: Bearer $TOKEN" \
164-
-H 'Accept: application/json' \
165-
-H 'Content-Type: application/json' \
166-
https://$ENDPOINT/api/v1/endpoints <<'EOF'
167-
{
168-
"kind": "Endpoints",
169-
"apiVersion": "v1",
170-
...
171-
}
172-
EOF
173-
----
174-
175-
==== HTTP body
176-
[cols="1,5", options="header"]
177-
|===
178-
|Parameter|Schema
179-
|body|v1.Endpoints
180-
|===
181-
182-
==== Query parameters
183-
[cols="1,5", options="header"]
184-
|===
185-
|Parameter|Description
186-
|pretty|If 'true', then the output is pretty printed.
187-
|===
188-
189-
==== Responses
190-
[cols="1,5", options="header"]
191-
|===
192-
|HTTP Code|Schema
193-
|200 OK|v1.Endpoints
194-
|201 Created|v1.Endpoints
195-
|202 Accepted|v1.Endpoints
196-
|401 Unauthorized|
197-
|===
198-
199-
==== Consumes
200-
201-
* \*/*
202-
203-
==== Produces
204-
205-
* application/json
206-
* application/yaml
207-
* application/vnd.kubernetes.protobuf
208-
209-
210138
[[Post-api-v1-namespaces-namespace-endpoints]]
211139
=== Create a Endpoints in a namespace
212140
Create Endpoints
@@ -366,14 +294,14 @@ $ curl -k \
366294
[cols="1,5", options="header"]
367295
|===
368296
|Parameter|Description
369-
|pretty|If 'true', then the output is pretty printed.
370297
|continue|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 indicating the client must restart their list without the continue field. 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.
371298
|fieldSelector|A selector to restrict the list of returned objects by their fields. Defaults to everything.
372299
|includeUninitialized|If true, partially initialized resources are included in the response.
373300
|labelSelector|A selector to restrict the list of returned objects by their labels. Defaults to everything.
374301
|limit|limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
375302

376303
The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
304+
|pretty|If 'true', then the output is pretty printed.
377305
|resourceVersion|When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
378306
|timeoutSeconds|Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
379307
|watch|Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

‎api/docs/api/v1.Event.adoc

+1-73
Original file line numberDiff line numberDiff line change
@@ -128,78 +128,6 @@ Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-gu
128128

129129
== Operations
130130

131-
[[Post-api-v1-events]]
132-
=== Create a Event
133-
Create an Event
134-
135-
==== HTTP request
136-
----
137-
POST /api/v1/events HTTP/1.1
138-
Authorization: Bearer $TOKEN
139-
Accept: application/json
140-
Connection: close
141-
Content-Type: application/json'
142-
143-
{
144-
"kind": "Event",
145-
"apiVersion": "v1",
146-
...
147-
}
148-
149-
----
150-
151-
==== Curl request
152-
----
153-
$ curl -k \
154-
-X POST \
155-
-d @- \
156-
-H "Authorization: Bearer $TOKEN" \
157-
-H 'Accept: application/json' \
158-
-H 'Content-Type: application/json' \
159-
https://$ENDPOINT/api/v1/events <<'EOF'
160-
{
161-
"kind": "Event",
162-
"apiVersion": "v1",
163-
...
164-
}
165-
EOF
166-
----
167-
168-
==== HTTP body
169-
[cols="1,5", options="header"]
170-
|===
171-
|Parameter|Schema
172-
|body|v1.Event
173-
|===
174-
175-
==== Query parameters
176-
[cols="1,5", options="header"]
177-
|===
178-
|Parameter|Description
179-
|pretty|If 'true', then the output is pretty printed.
180-
|===
181-
182-
==== Responses
183-
[cols="1,5", options="header"]
184-
|===
185-
|HTTP Code|Schema
186-
|200 OK|v1.Event
187-
|201 Created|v1.Event
188-
|202 Accepted|v1.Event
189-
|401 Unauthorized|
190-
|===
191-
192-
==== Consumes
193-
194-
* \*/*
195-
196-
==== Produces
197-
198-
* application/json
199-
* application/yaml
200-
* application/vnd.kubernetes.protobuf
201-
202-
203131
[[Post-api-v1-namespaces-namespace-events]]
204132
=== Create a Event in a namespace
205133
Create an Event
@@ -359,14 +287,14 @@ $ curl -k \
359287
[cols="1,5", options="header"]
360288
|===
361289
|Parameter|Description
362-
|pretty|If 'true', then the output is pretty printed.
363290
|continue|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 indicating the client must restart their list without the continue field. 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.
364291
|fieldSelector|A selector to restrict the list of returned objects by their fields. Defaults to everything.
365292
|includeUninitialized|If true, partially initialized resources are included in the response.
366293
|labelSelector|A selector to restrict the list of returned objects by their labels. Defaults to everything.
367294
|limit|limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
368295

369296
The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
297+
|pretty|If 'true', then the output is pretty printed.
370298
|resourceVersion|When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
371299
|timeoutSeconds|Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
372300
|watch|Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

0 commit comments

Comments
 (0)