Skip to content

AAP-43136: ansible.platform.token module has examples that don't match the expected parameters - #7

Merged
NilashishC merged 1 commit into
develfrom
AAP-43136-token-doc
Apr 29, 2025
Merged

AAP-43136: ansible.platform.token module has examples that don't match the expected parameters#7
NilashishC merged 1 commit into
develfrom
AAP-43136-token-doc

Conversation

@kaushiki069

@kaushiki069 kaushiki069 commented Apr 28, 2025

Copy link
Copy Markdown
Contributor

Description: The ansible.platform.token module examples contain parameters (aap_gateway, aap_username, aap_password) that do not match the supported parameters (gateway_hostname, gateway_username, gateway_password). This inconsistency leads to a failure when attempting to create a new token using the provided examples. To resolve this issue, the parameters in the examples need to be updated to match the supported parameters. This change will ensure the examples align with the module's expected parameters, preventing errors during task execution.
Work Item: https://issues.redhat.com/browse/AAP-43136
Additional changes:
1- Updated the module name in doc as well.

@kaushiki069
kaushiki069 marked this pull request as draft April 28, 2025 09:57
@kaushiki069 kaushiki069 added the safe to test PR is safe to run integration tests label Apr 28, 2025
NilashishC
NilashishC requested changes Apr 28, 2025
View reviewed changes
Comment thread plugins/modules/token.py Outdated
@NilashishC NilashishC removed the safe to test PR is safe to run integration tests label Apr 29, 2025
@kaushiki069
kaushiki069 marked this pull request as ready for review April 29, 2025 11:21
@kaushiki069
kaushiki069 force-pushed the AAP-43136-token-doc branch from dda59c9 to 9ed1098 Compare April 29, 2025 12:20
@github-actions

github-actions Bot commented Apr 29, 2025

Copy link
Copy Markdown

DVCS PR Check Results:

PR appears valid (JIRA key(s) found)

@NilashishC
NilashishC merged commit 9abb412 into devel Apr 29, 2025
@NilashishC
NilashishC deleted the AAP-43136-token-doc branch April 29, 2025 12:52
NilashishC pushed a commit that referenced this pull request Jun 19, 2025
@kaushiki069 @NilashishC
AAP-43136 changes to token module (#7)
007eac0
sean-m-sullivan added a commit that referenced this pull request Jul 22, 2025
@djdanielsson @NilashishC
@kaushiki069 @PyContriver @tanwigeetika1618 @shvenkat-rh @sean-m-sullivan
standardizing how host gets validated (#33)
5b50c86 
* Add GHA workflows (#1)

* Add GHA workflows

Signed-off-by: NilashishC <nchakrab@redhat.com>

---------

Signed-off-by: NilashishC <nchakrab@redhat.com>

* Add integration test job (#2)

Signed-off-by: NilashishC <nchakrab@redhat.com>

* Add more collection-test-* jobs (#3)

* Add collection-test-integration-check

* Add collection-test-completeness
---------

Signed-off-by: NilashishC <nchakrab@redhat.com>

* Pull ansible/aap-gateway (#5)

Signed-off-by: NilashishC <nchakrab@redhat.com>

* Add build-import and DVCS check workflows (#8)

* Add build-import and DVCS check workflows

* remove redundant dependencies

* Change to pull_request_target

---------

Signed-off-by: NilashishC <nchakrab@redhat.com>

* explicity use PR head when checking out (#10)

* explicity use PR head when checking out

---------

Signed-off-by: NilashishC <nchakrab@redhat.com>

* Update collection.yml

* updates (#11)

Signed-off-by: NilashishC <nchakrab@redhat.com>

* Revert collection.yml workflow to use on: pull_request (#13)

Signed-off-by: NilashishC <nchakrab@redhat.com>

* Update collection.yml

* Assorted updates to workflows and issues templates (#16)

* [AAP-43077] Assorted updates to workflows and issues templates

---------

Signed-off-by: NilashishC <nchakrab@redhat.com>

* AAP-43136 changes to token module (#7)

* AAP-43113 adding changes to fix documentation for token module (#15)

* fix branch name

Signed-off-by: NilashishC <nchakrab@redhat.com>

* AAP-32818: Adds an authentication related section in README

* Adds a new section in README that describes how to use authentication variables in playbooks for connecting to AAP.

* AAP-43078: addition of object_ids param to enable processing of a list of object_ids/names

* Update ansible.platform settings module documentation examples (#32)

Resolve ansible-lint errors

Resolve few naming errors

Replace <true_or_false> with true/false for better readability

* [AAP-32819] Adds missing examples in authenticator and authenticator_map modules (#25)

Co-authored-by: Shashank Venkat <shvenkat>

* updating aap_module.py to match the other collections using startswith vs re.match

* [AAP-43077] Fix intermittent SSLError when running test_completeness (#35)

* [AAP-43077] Fix intermittent SSLError when running test_completeness

---------

Signed-off-by: NilashishC <nchakrab@redhat.com>

* [AAP-43077] Allow PRs originating from forks to run integration tests (#36)

Signed-off-by: NilashishC <nchakrab@redhat.com>

* Update main.yml

* Update role_user_assignment.py

* trying to fix CI

* Update test_completeness.py

* Update test_completeness.py

* Update test_completeness.py

---------

Signed-off-by: NilashishC <nchakrab@redhat.com>
Co-authored-by: Nilashish Chakraborty <nchakrab@redhat.com>
Co-authored-by: Kaushiki Singh <kausingh@redhat.com>
Co-authored-by: Siddarth Sharma <149260801+PyContriver@users.noreply.github.com>
Co-authored-by: tanwigeetika1618 <84617407+tanwigeetika1618@users.noreply.github.com>
Co-authored-by: Shashank Venkat <shvenkat@redhat.com>
Co-authored-by: Sean Sullivan <ssulliva@redhat.com>
@cidrblock cidrblock mentioned this pull request Aug 27, 2026
Open
26 tasks
jessicamack added a commit to jessicamack/ansible.platform that referenced this pull request Aug 27, 2026
@jessicamack @claude
Address cidrblock review: DirectHTTPClient wait, Controller lookups, …
7ff236e 
…check_mode, wait-timeout id loss

- ansible#7: DirectHTTPClient._find_resource no longer requires a list op before
  attempting GET-by-id, matching PlatformService. Add optional list op to
  the ad_hoc_command mixin.
- ansible#10: inventory/credential/execution_environment name lookups now hit
  /api/controller/v2/... instead of Gateway; DirectHTTPClient.lookup_resource_id
  honors full /api/-prefixed paths instead of always Gateway-prefixing.
- ansible#9: check_mode short-circuits before manager.execute() instead of launching
  a real ad hoc command.
- ansible#2: introduce WaitTimeoutError(ValueError) carrying the last poll result so
  a wait-timeout no longer drops the launched command's id/status.
- ansible#8: mock server keeps ad hoc commands pending for 2 polls before resolving
  (with __fail__/__hang__ markers) instead of resolving instantly on create,
  so wait/poll logic is actually exercised in CI.
- ansible#5: add unit tests for poll-to-completion, timeout, default-timeout,
  wait-flag popping, check_mode, and DirectHTTPClient-without-list-op.
- ansible#3: document the 3600s default wait-timeout ceiling in DOCUMENTATION.
- ansible#12: from_api now round-trips extra_vars (dict or JSON string) instead of
  always returning None.
- Document terminal statuses in RETURN per the review's fallback guidance.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
jessicamack added a commit to jessicamack/ansible.platform that referenced this pull request Sep 3, 2026
@jessicamack @claude
Address cidrblock review: DirectHTTPClient wait, Controller lookups, …
b7f996c 
…check_mode, wait-timeout id loss

- ansible#7: DirectHTTPClient._find_resource no longer requires a list op before
  attempting GET-by-id, matching PlatformService. Add optional list op to
  the ad_hoc_command mixin.
- ansible#10: inventory/credential/execution_environment name lookups now hit
  /api/controller/v2/... instead of Gateway; DirectHTTPClient.lookup_resource_id
  honors full /api/-prefixed paths instead of always Gateway-prefixing.
- ansible#9: check_mode short-circuits before manager.execute() instead of launching
  a real ad hoc command.
- ansible#2: introduce WaitTimeoutError(ValueError) carrying the last poll result so
  a wait-timeout no longer drops the launched command's id/status.
- ansible#8: mock server keeps ad hoc commands pending for 2 polls before resolving
  (with __fail__/__hang__ markers) instead of resolving instantly on create,
  so wait/poll logic is actually exercised in CI.
- ansible#5: add unit tests for poll-to-completion, timeout, default-timeout,
  wait-flag popping, check_mode, and DirectHTTPClient-without-list-op.
- ansible#3: document the 3600s default wait-timeout ceiling in DOCUMENTATION.
- ansible#12: from_api now round-trips extra_vars (dict or JSON string) instead of
  always returning None.
- Document terminal statuses in RETURN per the review's fallback guidance.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
jessicamack added a commit to jessicamack/ansible.platform that referenced this pull request Sep 3, 2026
@jessicamack @claude
Address cidrblock review: DirectHTTPClient wait, Controller lookups, …
afa5fe2 
…check_mode, wait-timeout id loss

- ansible#7: DirectHTTPClient._find_resource no longer requires a list op before
  attempting GET-by-id, matching PlatformService. Add optional list op to
  the ad_hoc_command mixin.
- ansible#10: inventory/credential/execution_environment name lookups now hit
  /api/controller/v2/... instead of Gateway; DirectHTTPClient.lookup_resource_id
  honors full /api/-prefixed paths instead of always Gateway-prefixing.
- ansible#9: check_mode short-circuits before manager.execute() instead of launching
  a real ad hoc command.
- ansible#2: introduce WaitTimeoutError(ValueError) carrying the last poll result so
  a wait-timeout no longer drops the launched command's id/status.
- ansible#8: mock server keeps ad hoc commands pending for 2 polls before resolving
  (with __fail__/__hang__ markers) instead of resolving instantly on create,
  so wait/poll logic is actually exercised in CI.
- ansible#5: add unit tests for poll-to-completion, timeout, default-timeout,
  wait-flag popping, check_mode, and DirectHTTPClient-without-list-op.
- ansible#3: document the 3600s default wait-timeout ceiling in DOCUMENTATION.
- ansible#12: from_api now round-trips extra_vars (dict or JSON string) instead of
  always returning None.
- Document terminal statuses in RETURN per the review's fallback guidance.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
jessicamack added a commit to jessicamack/ansible.platform that referenced this pull request Sep 15, 2026
@jessicamack @claude
Address cidrblock review: DirectHTTPClient wait, Controller lookups, …
b3b9a06 
…check_mode, wait-timeout id loss

- ansible#7: DirectHTTPClient._find_resource no longer requires a list op before
  attempting GET-by-id, matching PlatformService. Add optional list op to
  the ad_hoc_command mixin.
- ansible#10: inventory/credential/execution_environment name lookups now hit
  /api/controller/v2/... instead of Gateway; DirectHTTPClient.lookup_resource_id
  honors full /api/-prefixed paths instead of always Gateway-prefixing.
- ansible#9: check_mode short-circuits before manager.execute() instead of launching
  a real ad hoc command.
- ansible#2: introduce WaitTimeoutError(ValueError) carrying the last poll result so
  a wait-timeout no longer drops the launched command's id/status.
- ansible#8: mock server keeps ad hoc commands pending for 2 polls before resolving
  (with __fail__/__hang__ markers) instead of resolving instantly on create,
  so wait/poll logic is actually exercised in CI.
- ansible#5: add unit tests for poll-to-completion, timeout, default-timeout,
  wait-flag popping, check_mode, and DirectHTTPClient-without-list-op.
- ansible#3: document the 3600s default wait-timeout ceiling in DOCUMENTATION.
- ansible#12: from_api now round-trips extra_vars (dict or JSON string) instead of
  always returning None.
- Document terminal statuses in RETURN per the review's fallback guidance.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@NilashishC NilashishC NilashishC approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@kaushiki069 @NilashishC