test/integration/targets/ansible-doc/randommodule.output


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

{
    "testns.testcol.randommodule": {
        "doc": {
            "author": [
                "Ansible Core Team"
            ],
            "collection": "testns.testcol",
            "deprecated": {
                "alternative": "Use some other module",
                "removed_from_collection": "testns.testcol",
                "removed_in": "3.0.0",
                "why": "Test deprecation"
            },
            "description": [
                "A random module."
            ],
            "filename": "./collections/ansible_collections/testns/testcol/plugins/modules/randommodule.py",
            "has_action": false,
            "module": "randommodule",
            "options": {
                "sub": {
                    "description": "Suboptions.",
                    "env": [
                        {
                            "deprecated": {
                                "alternative": "none",
                                "removed_in": "2.0.0",
                                "version": "2.0.0",
                                "why": "Test deprecation"
                            },
                            "name": "TEST_ENV",
                            "version_added": "1.0.0"
                        }
                    ],
                    "options": {
                        "subtest2": {
                            "description": "Another suboption.",
                            "type": "float",
                            "version_added": "1.1.0"
                        }
                    },
                    "suboptions": {
                        "subtest": {
                            "description": "A suboption.",
                            "type": "int",
                            "version_added": "1.1.0",
                            "version_added_collection": "testns.testcol"
                        }
                    },
                    "type": "dict"
                },
                "test": {
                    "description": "Some text.",
                    "type": "str",
                    "version_added": "1.2.0",
                    "version_added_collection": "testns.testcol"
                },
                "testcol2option": {
                    "description": [
                        "An option taken from testcol2"
                    ],
                    "type": "str",
                    "version_added": "1.0.0",
                    "version_added_collection": "testns.testcol2"
                },
                "testcol2option2": {
                    "description": [
                        "Another option taken from testcol2"
                    ],
                    "type": "str"
                }
            },
            "seealso": [
                {
                    "module": "ansible.builtin.ping"
                },
                {
                    "description": "Use this to fetch an URI",
                    "module": "ansible.builtin.uri"
                },
                {
                    "module": "testns.testcol.test"
                },
                {
                    "description": "A fake module",
                    "module": "testns.testcol.fakemodule"
                },
                {
                    "description": "See also the Ansible docsite.",
                    "link": "https://docs.ansible.com",
                    "name": "Ansible docsite"
                },
                {
                    "description": "Some foo bar.",
                    "ref": "foo_bar"
                }
            ],
            "short_description": "A random module",
            "version_added": "1.0.0",
            "version_added_collection": "testns.testcol"
        },
        "examples": "\n",
        "metadata": null,
        "return": {
            "a_first": {
                "description": "A first result.",
                "returned": "success",
                "type": "str"
            },
            "m_middle": {
                "contains": {
                    "suboption": {
                        "choices": [
                            "ARF",
                            "BARN",
                            "c_without_capital_first_letter"
                        ],
                        "description": "A suboption.",
                        "type": "str",
                        "version_added": "1.4.0",
                        "version_added_collection": "testns.testcol"
                    }
                },
                "description": [
                    "This should be in the middle.",
                    "Has some more data"
                ],
                "returned": "success and 1st of month",
                "type": "dict"
            },
            "z_last": {
                "description": "A last result.",
                "returned": "success",
                "type": "str",
                "version_added": "1.3.0",
                "version_added_collection": "testns.testcol"
            }
        }
    }
}