meraki_admin - Added full return documentation for normal responses (#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

(cherry picked from commit 5960b215bb)
pull/42883/head
Kevin Breit 6 years ago committed by Matt Clay
parent b0dae4f90e
commit be411bc9ba

@ -106,47 +106,60 @@ EXAMPLES = r'''
RETURN = r''' RETURN = r'''
data: data:
description: Information about the created or manipulated object. description: List of administrators.
returned: info returned: success
type: list type: complex
sample: contains:
[ email:
{ description: Email address of administrator.
"email": "john@doe.com", returned: success
"id": "12345677890", type: string
"name": "John Doe", sample: your@email.com
"networks": [], id:
"orgAccess": "full", description: Unique identification number of administrator.
"tags": [] returned: success
}
]
changed:
description: Whether object changed as a result of the request.
returned: info
type: string type: string
sample: sample: 1234567890
"changed": false name:
description: Given name of administrator.
status: returned: success
description: HTTP response code type: string
returned: info sample: John Doe
type: int networks:
sample: description: List of networks administrator has access on.
"status": 200 returned: success
type: complex
response: contains:
description: HTTP response description and bytes id:
returned: info 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 type: string
sample: sample: full
"response": "OK (unknown bytes)"
failed:
description: Boolean value whether the task failed
returned: info
type: bool
sample:
"failed": false
''' '''
import os import os

Loading…
Cancel
Save