Skip to content

Commit

Permalink
meraki_admin - Added full return documentation for normal responses (a…
Browse files Browse the repository at this point in the history
…nsible#42487)

* Added full return documentation for normal responses

* Changed returned for responses

- Old responses were saying always returned, should have been success
or something more refined
  • Loading branch information
kbreit authored and dagwieers committed Jul 9, 2018
1 parent 0c59a3b commit 5960b21
Showing 1 changed file with 54 additions and 14 deletions.
68 changes: 54 additions & 14 deletions lib/ansible/modules/network/meraki/meraki_admin.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,20 +121,60 @@

RETURN = r'''
data:
description: Information about the created or manipulated object.
returned: info
type: list
sample:
[
{
"email": "[email protected]",
"id": "12345677890",
"name": "John Doe",
"networks": [],
"orgAccess": "full",
"tags": []
}
]
description: List of administrators.
returned: success
type: complex
contains:
email:
description: Email address of administrator.
returned: success
type: string
sample: [email protected]
id:
description: Unique identification number of administrator.
returned: success
type: string
sample: 1234567890
name:
description: Given name of administrator.
returned: success
type: string
sample: John Doe
networks:
description: List of networks administrator has access on.
returned: success
type: complex
contains:
id:
description: The network ID.
returned: when network permissions are set
type: string
sample: N_0123456789
access:
description: Access level of administrator. Options are 'full', 'read-only', or 'none'.
returned: when network permissions are set
type: string
sample: read-only
tags:
description: Tags the adminsitrator has access on.
returned: success
type: complex
contains:
tag:
description: Tag name.
returned: when tag permissions are set
type: string
sample: production
access:
description: Access level of administrator. Options are 'full', 'read-only', or 'none'.
returned: when tag permissions are set
type: string
sample: full
orgAccess:
description: The privilege of the dashboard administrator on the organization. Options are 'full', 'read-only', or 'none'.
returned: success
type: string
sample: full
'''

import os
Expand Down

0 comments on commit 5960b21

Please sign in to comment.