[collection] remove module defaults where API defaults are the same (#13037)

Providing defaults for API parameters where the API already provides
defaults leads to some confusing scenarios, because we end up always
sending those collection-defaulted fields in the request even if the
field isn't provided by the user.

For example, we previously set the `scm_type` default to 'manual' and
someone using the collection to update a project who does not explicitly
include the `scm_type` every time they call the module, would
inadvertently change the `scm_type` of the project back to 'manual'
which is surprising behavior.

This change removes the collection defaults for API parameters, unless
they differed from the API default. We let the API handle the defaults
or otherwise ignore fields not given by the user so that the user does
not end up changing unexpected fields when they use a module.

Signed-off-by: Rick Elrod <rick@elrod.me>
This commit is contained in:
Rick Elrod
2023-02-01 15:37:08 -06:00
committed by GitHub
parent 93d84fe2c9
commit 0815f935ca
17 changed files with 53 additions and 74 deletions

View File

@@ -20,7 +20,7 @@ DOCUMENTATION = """
---
module: workflow_node_wait
author: "Sean Sullivan (@sean-m-sullivan)"
short_description: Approve an approval node in a workflow job.
short_description: Wait for a workflow node to finish.
description:
- Approve an approval node in a workflow job. See
U(https://www.ansible.com/tower) for an overview.
@@ -43,7 +43,7 @@ options:
type: float
timeout:
description:
- Maximum time in seconds to wait for a workflow job to to reach approval node.
- Maximum time in seconds to wait for a workflow job to reach approval node.
default: 10
type: int
extends_documentation_fragment: awx.awx.auth