diff --git a/api-ref/source/v3/authenticate-v3.inc b/api-ref/source/v3/authenticate-v3.inc index db94c06aa7..88c90f57d0 100644 --- a/api-ref/source/v3/authenticate-v3.inc +++ b/api-ref/source/v3/authenticate-v3.inc @@ -183,8 +183,8 @@ Response Parameters - region_id: region_id - methods: methods - roles: roles - - url: url - - region: region + - url: endpoint_url + - region: endpoint_region - token: token - expires_at: expires_at - project: project @@ -193,7 +193,7 @@ Response Parameters - extras: extras - user: user - audit_ids: audit_ids - - interface: interface + - interface: endpoint_interface - endpoints: endpoints - type: type - id: id diff --git a/api-ref/source/v3/domains-config-v3.inc b/api-ref/source/v3/domains-config-v3.inc index 86dd50efaa..e59985251f 100644 --- a/api-ref/source/v3/domains-config-v3.inc +++ b/api-ref/source/v3/domains-config-v3.inc @@ -63,7 +63,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - url: url + - url: endpoint_url - driver: driver - ldap: ldap - config: config @@ -96,7 +96,7 @@ Request .. rest_parameters:: parameters.yaml - - url: url + - url: endpoint_url - driver: driver - ldap: ldap - config: config @@ -117,7 +117,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - url: url + - url: endpoint_url - driver: driver - ldap: ldap - config: config @@ -180,7 +180,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - url: url + - url: endpoint_url - driver: driver - ldap: ldap - config: config @@ -213,7 +213,7 @@ Request .. rest_parameters:: parameters.yaml - - url: url + - url: endpoint_url - driver: driver - ldap: ldap - config: config @@ -233,7 +233,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - url: url + - url: endpoint_url - driver: driver - ldap: ldap - config: config @@ -283,7 +283,7 @@ Request .. rest_parameters:: parameters.yaml - - url: url + - url: endpoint_url - driver: driver - ldap: ldap - config: config @@ -302,7 +302,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - url: url + - url: endpoint_url - driver: driver - ldap: ldap - config: config @@ -338,7 +338,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - url: url + - url: endpoint_url - driver: driver - ldap: ldap - config: config @@ -367,7 +367,7 @@ Request .. rest_parameters:: parameters.yaml - - url: url + - url: endpoint_url - driver: driver - ldap: ldap - config: config @@ -386,7 +386,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - url: url + - url: endpoint_url - driver: driver - ldap: ldap - config: config diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index 12f1cbc07f..83b9a65164 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -47,7 +47,7 @@ domain_id_path: in: path required: true type: string -endpoint_id: +endpoint_id_path: description: | The endpoint ID. in: path @@ -223,7 +223,7 @@ include_subtree_query: required: false type: boolean min_version: 3.6 -interface_2: +interface_query: description: | Filters the response by an interface. in: query @@ -322,7 +322,7 @@ scope_project_id_query: in: query required: false type: string -service_id_3: +service_id_query: description: | Filters the response by a service ID. in: query @@ -685,15 +685,6 @@ enabled: in: body required: false type: boolean -enabled_1: - description: | - Defines whether the endpoint appears in the - service catalog: - ``false``. The endpoint does not appear in the - service catalog. - ``true``. The endpoint appears in the service - catalog. Default is ``true``. - in: body - required: false - type: boolean enabled_10: description: | Defines whether the service and its endpoints @@ -715,15 +706,6 @@ enabled_2: in: body required: false type: boolean -enabled_7: - description: | - Indicates whether the endpoint appears in the - service catalog: - ``false``. The endpoint does not appear in the - service catalog. - ``true``. The endpoint appears in the service - catalog. - in: body - required: true - type: boolean enabled_user_request_body: description: | If the user is enabled, this value is ``true``. @@ -756,12 +738,78 @@ endpoint: in: body required: true type: object +endpoint_enabled: + description: | + Indicates whether the endpoint appears in the + service catalog: - ``false``. The endpoint does not appear in the + service catalog. - ``true``. The endpoint appears in the service + catalog. + in: body + required: true + type: boolean +endpoint_enabled_notRequired: + description: | + Defines whether the endpoint appears in the + service catalog: - ``false``. The endpoint does not appear in the + service catalog. - ``true``. The endpoint appears in the service + catalog. Default is ``true``. + in: body + required: false + type: boolean +endpoint_id: + description: | + The endpoint ID. + in: body + required: true + type: string +endpoint_interface: + description: | + The interface type, which describes the + visibility of the endpoint. Value is: - ``public``. Visible by + end users on a publicly available network interface. - + ``internal``. Visible by end users on an unmetered internal + network interface. - ``admin``. Visible by administrative users + on a secure network interface. + in: body + required: true + type: string +endpoint_links: + description: | + The links for the ``endpoint`` resource. + in: body + required: true + type: object +endpoint_name: + description: | + The endpoint name. + in: body + required: true + type: string +endpoint_region: + description: | + (Deprecated in v3.2) The geographic location of + the service endpoint. + in: body + required: true + type: string +endpoint_url: + description: | + The endpoint URL. + in: body + required: true + type: string endpoints: description: | - An ``endpoints`` object. + A list of ``endpoint`` objects. in: body required: true type: array +endpoints_links: + description: | + The links for the ``endpoints`` resource. + in: body + required: true + type: object expires_at: description: | The date and time when the token expires. @@ -976,28 +1024,6 @@ identity_1: in: body required: true type: object -interface: - description: | - The interface type, which describes the - visibility of the endpoint. Value is: - ``public``. Visible by - end users on a publicly available network interface. - - ``internal``. Visible by end users on an unmetered internal - network interface. - ``admin``. Visible by administrative users - on a secure network interface. - in: body - required: true - type: string -interface_1: - description: | - The interface type, which describes the - visibility of the endpoint. A valid value is: - ``public``. - Visible by end users on a publicly available network interface. - - ``internal``. Visible by end users on an unmetered internal - network interface. - ``admin``. Visible by administrative users - on a secure network interface. - in: body - required: true - type: string is_domain_request_body: description: | Indicates whether the project also acts as a domain. If set to ``true``, @@ -1082,18 +1108,6 @@ links_12: in: body required: true type: object -links_13: - description: | - The links for the ``endpoints`` resource. - in: body - required: true - type: object -links_2: - description: | - The links for the ``endpoint`` resource. - in: body - required: true - type: object links_3: description: | The links for the ``group`` resource. @@ -1206,12 +1220,6 @@ name_2: in: body required: true type: string -name_3: - description: | - The endpoint name. - in: body - required: true - type: string name_4: description: | The group name. @@ -1439,13 +1447,6 @@ projects: in: body required: true type: array -region: - description: | - (Deprecated in v3.2) The geographic location of - the service endpoint. - in: body - required: true - type: string region_2: description: | (Deprecated in v3.2) The geographic location of @@ -1665,12 +1666,6 @@ type_7: in: body required: false type: string -url: - description: | - The endpoint URL. - in: body - required: true - type: string url_1: description: | The LDAP URL. diff --git a/api-ref/source/v3/service-catalog.inc b/api-ref/source/v3/service-catalog.inc index d7cf16d272..c34b2c4d2b 100644 --- a/api-ref/source/v3/service-catalog.inc +++ b/api-ref/source/v3/service-catalog.inc @@ -112,7 +112,7 @@ Request .. rest_parameters:: parameters.yaml - - endpoint_id: endpoint_id + - endpoint_id: endpoint_id_path Response Parameters ------------------- @@ -120,11 +120,11 @@ Response Parameters .. rest_parameters:: parameters.yaml - endpoint: endpoint - - name: name - - links: links - - url: url - - region: region - - interface: interface + - name: endpoint_name + - links: endpoint_links + - url: endpoint_url + - region: endpoint_region + - interface: endpoint_interface - service_id: service_id Response Example @@ -150,11 +150,11 @@ Request .. rest_parameters:: parameters.yaml - endpoint: endpoint - - url: url - - region: region - - interface: interface + - url: endpoint_url + - region: endpoint_region + - interface: endpoint_interface - service_id: service_id - - endpoint_id: endpoint_id + - endpoint_id: endpoint_id_path Request Example --------------- @@ -168,10 +168,11 @@ Response Parameters .. rest_parameters:: parameters.yaml - endpoint: endpoint - - links: links - - url: url - - region: region - - interface: interface + - id: endpoint_id + - links: endpoint_links + - url: endpoint_url + - region: endpoint_region + - interface: endpoint_interface - service_id: service_id Response Example @@ -196,7 +197,7 @@ Request .. rest_parameters:: parameters.yaml - - endpoint_id: endpoint_id + - endpoint_id: endpoint_id_path List endpoints @@ -214,8 +215,8 @@ Request .. rest_parameters:: parameters.yaml - - interface: interface - - service_id: service_id + - interface: interface_query + - service_id: service_id_query Response Parameters ------------------- @@ -223,14 +224,14 @@ Response Parameters .. rest_parameters:: parameters.yaml - region_id: region_id - - links: links - - url: url - - region: region - - enabled: enabled - - interface: interface + - links: endpoints_links + - url: endpoint_url + - region: endpoint_region + - enabled: endpoint_enabled + - interface: endpoint_region - service_id: service_id - endpoints: endpoints - - id: id + - id: endpoint_id Response Example ---------------- @@ -255,9 +256,9 @@ Request .. rest_parameters:: parameters.yaml - endpoint: endpoint - - url: url - - enabled: enabled - - interface: interface + - url: endpoint_url + - enabled: endpoint_enabled_notRequired + - interface: endpoint_interface - service_id: service_id - region_id: region_id @@ -273,13 +274,13 @@ Response Parameters .. rest_parameters:: parameters.yaml - endpoint: endpoint - - links: links - - url: url - - region: region - - enabled: enabled - - interface: interface + - links: endpoint_links + - url: endpoint_url + - region: endpoint_region + - enabled: endpoint_enabled + - interface: endpoint_interface - service_id: service_id - - id: id + - id: endpoint_id - region_id: region_id