0192a4ab0c
This patch set is one of many to add api reference documentation to valet. This specifc patch adds the /v1/groups/ api documentation. User can generate the documentation by ``tox -eapi-ref``. Change-Id: Ic5016abd9f95de98effeaceb4b9f8c1fc7943d6a Signed-off-by: Tin Lam <tin@irrational.io>
51 lines
1.0 KiB
YAML
51 lines
1.0 KiB
YAML
# Parameters in header
|
|
|
|
# Parameters in query
|
|
group_id_query:
|
|
description: |
|
|
The UUID of a group
|
|
in: query
|
|
required: true
|
|
type: string
|
|
member_id_query:
|
|
description: |
|
|
The UUID of a member
|
|
in: query
|
|
required: true
|
|
type: string
|
|
|
|
# Parameters in body
|
|
group_description:
|
|
description: |
|
|
Description of a group.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
group_id_body:
|
|
description: |
|
|
The UUID of a group
|
|
in: body
|
|
required: true
|
|
type: UUID
|
|
group_members:
|
|
description: |
|
|
List of group member UUIDs.
|
|
in: body
|
|
required: true
|
|
type: list
|
|
group_name:
|
|
description: |
|
|
Name for a group. Must contain only letters (A-Za-z), numbers (0-9),
|
|
hypens (-), periods (.), underscores (_), and tildes (~). See
|
|
RFC 3986, Section 2.3. This parameter is immutable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
group_type:
|
|
description: |
|
|
Type of a group. Currently, the only valid value is ``exclusivity``.
|
|
This parameter is immutable.
|
|
in: body
|
|
required: true
|
|
type: string
|