Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
This commit is contained in:
Phillip Wittrock
@@ -70,6 +70,8 @@ Appears In <a href="#replicationcontrollerlist-v1">ReplicationControllerList</a>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
spec <br /> *[ReplicationControllerSpec](#replicationcontrollerspec-v1)* | Spec defines the specification of the desired behavior of the replication controller. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
status <br /> *[ReplicationControllerStatus](#replicationcontrollerstatus-v1)* | Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
@@ -107,7 +109,9 @@ replicas <br /> *integer* | Replicas is the most recently oberved number of rep
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
items <br /> *[ReplicationController](#replicationcontroller-v1) array* | List of replication controllers. More info: http://kubernetes.io/docs/user-guide/replication-controller
|
||||
kind <br /> *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
||||
@@ -163,10 +167,15 @@ create a ReplicationController
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ReplicationController](#replicationcontroller-v1)* |
|
||||
@@ -225,10 +234,15 @@ Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ReplicationController
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ReplicationController](#replicationcontroller-v1)* |
|
||||
@@ -287,10 +301,15 @@ Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ReplicationController
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
@@ -349,16 +368,21 @@ Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ReplicationController
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
|
||||
orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Body Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
@@ -412,18 +436,19 @@ delete collection of ReplicationController
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
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.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
@@ -483,15 +508,16 @@ Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ReplicationController
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
@@ -545,18 +571,19 @@ list or watch objects of kind ReplicationController
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
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.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
@@ -605,7 +632,8 @@ list or watch objects of kind ReplicationController
|
||||
|
||||
`GET /api/v1/replicationcontrollers`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
@@ -669,10 +697,15 @@ watch changes to an object of kind ReplicationController
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the ReplicationController
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
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.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
@@ -727,7 +760,8 @@ watch individual changes to a list of ReplicationController
|
||||
|
||||
`GET /api/v1/watch/replicationcontrollers`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
|
||||
Reference in New Issue
Block a user