Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some documentation errors in the cloudwatchlogs_log_group_metric_filter and ecs_service modules #79

Closed
abadger opened this issue May 20, 2020 · 0 comments · Fixed by #80

Comments

@abadger
Copy link

abadger commented May 20, 2020

SUMMARY

I've written a schema for DOCUMENTATION, RETURN, etc. There are a few problems in the structure of the return docs on a pair of modules:

E   module -> community.aws.cloudwatchlogs_log_group_metric_filter -> return -> metric_filters -> contains -> creation_time
E     none is not an allowed value (type=type_error.none.not_allowed)
E   module -> community.aws.cloudwatchlogs_log_group_metric_filter -> return -> metric_filters -> contains -> filter_name
E     none is not an allowed value (type=type_error.none.not_allowed)
E   module -> community.aws.cloudwatchlogs_log_group_metric_filter -> return -> metric_filters -> contains -> filter_pattern
E     none is not an allowed value (type=type_error.none.not_allowed)
E   module -> community.aws.cloudwatchlogs_log_group_metric_filter -> return -> metric_filters -> contains -> log_group_name
E     none is not an allowed value (type=type_error.none.not_allowed)
E   module -> community.aws.cloudwatchlogs_log_group_metric_filter -> return -> metric_filters -> contains -> metric_filter_count
E     none is not an allowed value (type=type_error.none.not_allowed)
E   module -> community.aws.ecs_service -> doc -> options -> placement_constraints -> suboptions
E     none is not an allowed value (type=type_error.none.not_allowed)

Since this schema is new, it is possible that None should be allowed in one or all of the locations listed. If so, let me know and we can discuss whether/how to update the schema to allow that.

ISSUE TYPE
  • Documentation Report
COMPONENT NAME
  • cloudwatchlogs_log_group_metric_filter.py
  • ecs_service.py
ANSIBLE VERSION

jillr added a commit to jillr/community.aws that referenced this issue May 20, 2020
ecs_service is missing suboptions data for placement_constraints
Return docs for cloudwatchlogs_log_group_metric_filter are missing suboption
descriptions and are just plain wrong. Correct type and values.

Fixes ansible-collections#79
@jillr jillr closed this as completed in #80 May 21, 2020
jillr added a commit that referenced this issue May 21, 2020

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
* Fix module documentation schema errors

ecs_service is missing suboptions data for placement_constraints
Return docs for cloudwatchlogs_log_group_metric_filter are missing suboption
descriptions and are just plain wrong. Correct type and values.

Fixes #79

* Also update arg_spec for ecs_service
jillr added a commit that referenced this issue Jun 1, 2020

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
* Fix module documentation schema errors

ecs_service is missing suboptions data for placement_constraints
Return docs for cloudwatchlogs_log_group_metric_filter are missing suboption
descriptions and are just plain wrong. Correct type and values.

Fixes #79

* Fix trailing comma in return docs

* Draft README

* Add requirements.yml example without a version specified

* Add module docs rst files

* Rerun latest rev of add_docs, with PR 8 fixes for rst template
alinabuzachis pushed a commit to alinabuzachis/community.aws that referenced this issue Jul 19, 2021
* Fix module documentation schema errors

ecs_service is missing suboptions data for placement_constraints
Return docs for cloudwatchlogs_log_group_metric_filter are missing suboption
descriptions and are just plain wrong. Correct type and values.

Fixes ansible-collections#79

* Also update arg_spec for ecs_service
alinabuzachis pushed a commit to alinabuzachis/community.aws that referenced this issue Jul 19, 2021
* Fix module documentation schema errors

ecs_service is missing suboptions data for placement_constraints
Return docs for cloudwatchlogs_log_group_metric_filter are missing suboption
descriptions and are just plain wrong. Correct type and values.

Fixes ansible-collections#79

* Fix trailing comma in return docs

* Draft README

* Add requirements.yml example without a version specified

* Add module docs rst files

* Rerun latest rev of add_docs, with PR 8 fixes for rst template
alinabuzachis pushed a commit to alinabuzachis/community.aws that referenced this issue Jul 19, 2021
* Fix module documentation schema errors

ecs_service is missing suboptions data for placement_constraints
Return docs for cloudwatchlogs_log_group_metric_filter are missing suboption
descriptions and are just plain wrong. Correct type and values.

Fixes ansible-collections#79

* Also update arg_spec for ecs_service
alinabuzachis pushed a commit to alinabuzachis/community.aws that referenced this issue Jul 19, 2021
* Fix module documentation schema errors

ecs_service is missing suboptions data for placement_constraints
Return docs for cloudwatchlogs_log_group_metric_filter are missing suboption
descriptions and are just plain wrong. Correct type and values.

Fixes ansible-collections#79

* Fix trailing comma in return docs

* Draft README

* Add requirements.yml example without a version specified

* Add module docs rst files

* Rerun latest rev of add_docs, with PR 8 fixes for rst template
alinabuzachis pushed a commit to alinabuzachis/community.aws that referenced this issue May 25, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Until 2.9.10 is released with  #70078
abikouo pushed a commit to abikouo/community.aws that referenced this issue Oct 24, 2023
* Fix module documentation schema errors

ecs_service is missing suboptions data for placement_constraints
Return docs for cloudwatchlogs_log_group_metric_filter are missing suboption
descriptions and are just plain wrong. Correct type and values.

Fixes ansible-collections#79

* Also update arg_spec for ecs_service

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@f26ad49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant