Skip to content

Commit

Permalink
ansible-doc: export has_action when --json is used (ansible#72359)
Browse files Browse the repository at this point in the history
* ansible-doc: export has_action when --json is used.
* Remove docuri and now_data, which were not used resp. ignored in format_plugin_doc and the functions it calls anyway.
* Add function _combine_plugin_doc.

(cherry picked from commit 4fb336c)
  • Loading branch information
felixfontein committed Oct 30, 2020
1 parent dea0bbc commit 5e47aa2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
2 changes: 2 additions & 0 deletions changelogs/fragments/ansible-doc-has_action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
minor_changes:
- "ansible-doc - provide ``has_action`` field in JSON output for modules. That information is currently only available in the text view (https://github.com/ansible/ansible/pull/72359)."
28 changes: 14 additions & 14 deletions lib/ansible/cli/doc.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,7 @@ def run(self):
# The doc section existed but was empty
continue

plugin_docs[plugin] = {'doc': doc, 'examples': plainexamples,
'return': returndocs, 'metadata': metadata}
plugin_docs[plugin] = DocCLI._combine_plugin_doc(plugin, plugin_type, doc, plainexamples, returndocs, metadata)

if do_json:
# Some changes to how json docs are formatted
Expand Down Expand Up @@ -323,23 +322,24 @@ def _get_plugin_doc(plugin, loader, search_paths):
return doc, plainexamples, returndocs, metadata

@staticmethod
def format_plugin_doc(plugin, plugin_type, doc, plainexamples, returndocs, metadata):
# assign from other sections
doc['plainexamples'] = plainexamples
doc['returndocs'] = returndocs
doc['metadata'] = metadata

def _combine_plugin_doc(plugin, plugin_type, doc, plainexamples, returndocs, metadata):
# generate extra data
if plugin_type == 'module':
# is there corresponding action plugin?
if plugin in action_loader:
doc['action'] = True
doc['has_action'] = True
else:
doc['action'] = False
doc['has_action'] = False

# return everything as one dictionary
return {'doc': doc, 'examples': plainexamples, 'return': returndocs, 'metadata': metadata}

doc['now_date'] = datetime.date.today().strftime('%Y-%m-%d')
if 'docuri' in doc:
doc['docuri'] = doc[plugin_type].replace('_', '-')
@staticmethod
def format_plugin_doc(plugin, plugin_type, doc, plainexamples, returndocs, metadata):
# assign from other sections
doc['plainexamples'] = plainexamples
doc['returndocs'] = returndocs
doc['metadata'] = metadata

if context.CLIARGS['show_snippet'] and plugin_type == 'module':
text = DocCLI.get_snippet_text(doc)
Expand Down Expand Up @@ -631,7 +631,7 @@ def get_man_text(doc, plugin_type=None):
except Exception:
pass # FIXME: not suported by plugins

if doc.pop('action', False):
if doc.pop('has_action', False):
text.append(" * note: %s\n" % "This module has a corresponding action plugin.")

if 'options' in doc and doc['options']:
Expand Down

0 comments on commit 5e47aa2

Please sign in to comment.