diff --git a/api-ref/source/os-server-groups.inc b/api-ref/source/os-server-groups.inc index 949d3a6864..250c136528 100644 --- a/api-ref/source/os-server-groups.inc +++ b/api-ref/source/os-server-groups.inc @@ -1,5 +1,4 @@ .. -*- rst -*- -.. needs:parameter_verification .. needs:example_verification .. needs:body_verification @@ -41,14 +40,14 @@ Response .. rest_parameters:: parameters.yaml - - server_groups: server_groups + - server_groups: server_groups_list - id: server_group_id - - name: name + - name: name_server_group - policies: policies - members: members - - metadata: metadata - - project_id: project_id - - user_id: user_id + - metadata: metadata_required + - project_id: project_id_server_group + - user_id: user_id_server_group **Example List Server Groups: JSON response** @@ -85,14 +84,14 @@ Response .. rest_parameters:: parameters.yaml - - server_groups: server_groups + - server_groups: server_groups_list - id: server_group_id - - name: name + - name: name_server_group - policies: policies - members: members - - metadata: metadata - - project_id: project_id - - user_id: user_id + - metadata: metadata_required + - project_id: project_id_server_group + - user_id: user_id_server_group **Example Create Server Group: JSON response** @@ -123,14 +122,14 @@ Response .. rest_parameters:: parameters.yaml - - server_groups: server_groups + - server_groups: server_groups_list - id: server_group_id - - name: name + - name: name_server_group - policies: policies - members: members - - metadata: metadata - - project_id: project_id - - user_id: user_id + - metadata: metadata_required + - project_id: project_id_server_group + - user_id: user_id_server_group **Example Show Server Group Details: JSON response** diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 4fcb875c30..a5ea7837e6 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -570,6 +570,13 @@ user_id_query_set_quota: in: query required: false type: string +user_id_server_group: + description: | + The user ID who owns the server group. + min_version: 2.13 + in: query + required: false + type: string # variables in body accessIPv4: @@ -1588,6 +1595,13 @@ metadata_items_quota_optional: in: body required: false type: integer +metadata_required: + description: | + Metadata key and value pairs. The maximum size of the metadata key and value is + 255 bytes each. This field is never used, always kept empty. + in: body + required: true + type: object migrate: description: | The action. @@ -1600,12 +1614,6 @@ name: in: body required: true type: string -name_10: - description: | - The name of the server group. - in: body - required: true - type: string name_3: description: | The name to associate with the keypair. @@ -1631,6 +1639,12 @@ name_9: in: body required: false type: string +name_server_group: + description: | + The name of the server group. + in: body + required: true + type: string namespace: description: | A URL pointing to the namespace for this extension. @@ -1905,8 +1919,9 @@ policies: description: | A list of one or more policy names to associate with the server group. The list must contain at least one policy name. The current valid policy names are ``anti-affinity`` - and ``affinity``. Each policy name must be a non-empty string with no leading - or trailing spaces. Maximum length is 255 characters. + , ``affinity``, ``soft-anti-affinity`` and 'soft-affinity', the latter two were + added in microversion 2.15. Each policy name must be a non-empty string with + no leading or trailing spaces. Maximum length is 255 characters. in: body required: true type: array @@ -1983,6 +1998,13 @@ project_id: in: body required: false type: string +project_id_server_group: + description: | + The project ID who owns the server group. + min_version: 2.13 + in: body + required: false + type: string public_key: description: | The public ssh key to import. If you omit this value, a key is generated. @@ -2271,6 +2293,12 @@ server_groups_1: in: body required: true type: array +server_groups_list: + description: | + The list of existing server groups. + in: body + required: true + type: list server_groups_quota_details: description: | The object of detailed server groups, including in_use,