Skip to content

Commit 048e4d4

Browse files
siveloraNod
andauthored
Add documentation for module option context (#1057)
* Add documentation for module option context * suggestion Co-authored-by: Don Naro <[email protected]> * Expand docs to indicate context is not used by core --------- Co-authored-by: Don Naro <[email protected]>
1 parent 0e6d9c6 commit 048e4d4

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -766,6 +766,23 @@ This section will discuss the behavioral attributes for arguments:
766766

767767
If ``options`` is specified, ``required_by`` refers to the sub-options described in ``options`` and behaves as in :ref:`argument_spec_dependencies`.
768768

769+
:context:
770+
771+
.. versionadded:: 2.17
772+
773+
You can set the value of the ``context`` key to a dict of custom content. This allows you to provide additional context in the argument spec. The content provided is not validated or utilized by the core engine.
774+
775+
Example:
776+
777+
.. code-block:: python
778+
779+
option = {
780+
'type': 'str',
781+
'context': {
782+
'disposition': '/properties/apiType',
783+
},
784+
'choices': ['http', 'soap'],
785+
}
769786
770787
.. _argument_spec_dependencies:
771788

0 commit comments

Comments
 (0)