Issue #2: Get the rest of the documentation errors fixed.

This commit is contained in:
Jeff Geerling
2020-01-30 16:35:24 -06:00
parent 4ac8e2e8bc
commit 21770a4fe2
5 changed files with 12 additions and 1 deletions

View File

@@ -17,6 +17,7 @@ options:
description: description:
- The desired number of replicas. - The desired number of replicas.
type: int type: int
required: True
current_replicas: current_replicas:
description: description:
- For Deployment, ReplicaSet, Replication Controller, only scale, if the number of existing replicas - For Deployment, ReplicaSet, Replication Controller, only scale, if the number of existing replicas

View File

@@ -125,7 +125,6 @@ options:
suboptions: suboptions:
fail_on_error: fail_on_error:
description: whether to fail on validation errors. description: whether to fail on validation errors.
required: yes
type: bool type: bool
version: version:
description: version of Kubernetes to validate against. defaults to Kubernetes server version description: version of Kubernetes to validate against. defaults to Kubernetes server version
@@ -258,14 +257,17 @@ result:
description: Standard object metadata. Includes name, namespace, annotations, labels, etc. description: Standard object metadata. Includes name, namespace, annotations, labels, etc.
returned: success returned: success
type: complex type: complex
contains: Object metadata
spec: spec:
description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind). description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind).
returned: success returned: success
type: complex type: complex
contains: Specific object attributes
status: status:
description: Current status details for the object. description: Current status details for the object.
returned: success returned: success
type: complex type: complex
contains: Status details
items: items:
description: Returned only when multiple yaml documents are passed to src or resource_definition description: Returned only when multiple yaml documents are passed to src or resource_definition
returned: when resource_definition or src contains list of objects returned: when resource_definition or src contains list of objects

View File

@@ -108,14 +108,17 @@ result:
description: Standard object metadata. Includes name, namespace, annotations, labels, etc. description: Standard object metadata. Includes name, namespace, annotations, labels, etc.
returned: success returned: success
type: complex type: complex
contains: Object metadata
spec: spec:
description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind). description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind).
returned: success returned: success
type: complex type: complex
contains: Specific object attributes
status: status:
description: Current status details for the object. description: Current status details for the object.
returned: success returned: success
type: complex type: complex
contains: Status details
''' '''
from ansible_collections.community.kubernetes.plugins.module_utils.scale import KubernetesAnsibleScaleModule from ansible_collections.community.kubernetes.plugins.module_utils.scale import KubernetesAnsibleScaleModule

View File

@@ -154,14 +154,17 @@ result:
description: Standard object metadata. Includes name, namespace, annotations, labels, etc. description: Standard object metadata. Includes name, namespace, annotations, labels, etc.
returned: success returned: success
type: complex type: complex
contains: Object metadata
spec: spec:
description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind). description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind).
returned: success returned: success
type: complex type: complex
contains: Specific object attributes
status: status:
description: Current status details for the object. description: Current status details for the object.
returned: success returned: success
type: complex type: complex
contains: Status details
''' '''
import copy import copy

View File

@@ -0,0 +1,2 @@
plugins/modules/k8s.py validate-modules:parameter-type-not-in-doc
plugins/modules/k8s_scale.py validate-modules:parameter-type-not-in-doc