Merge "api-ref: Add (deprecated) endpoint name docs"

This commit is contained in:
Zuul 2025-12-10 08:34:03 +00:00 committed by Gerrit Code Review
commit fb730b7402
2 changed files with 13 additions and 3 deletions

View file

@ -978,9 +978,14 @@ endpoint_links:
type: object
endpoint_name:
description: |
The endpoint name.
(Deprecated) The endpoint name. The field will only be returned in responses
when set on the resource.
This field is deprecated as it provides no value. Endpoints are better
described by the combination of service, region and interface they describe
or by their ID.
in: body
required: true
required: false
type: string
endpoint_region:
description: |

View file

@ -337,6 +337,7 @@ Parameters
- service_id: service_id
- endpoints: endpoints
- id: endpoint_id
- name: endpoint_name
Status Codes
~~~~~~~~~~~~
@ -381,6 +382,7 @@ Parameters
- interface: endpoint_interface
- service_id: service_id
- region_id: region_id_not_required
- name: endpoint_name
Example
~~~~~~~
@ -404,6 +406,7 @@ Parameters
- interface: endpoint_interface
- service_id: service_id
- id: endpoint_id
- name: endpoint_name
- region_id: region_id_required
Status Codes
@ -500,6 +503,7 @@ Parameters
- interface: endpoint_interface
- service_id: service_id
- endpoint_id: endpoint_id_path
- name: endpoint_name
Example
~~~~~~~
@ -521,6 +525,7 @@ Parameters
- url: endpoint_url
- region: endpoint_region
- interface: endpoint_interface
- name: endpoint_name
- service_id: service_id
Status Codes
@ -579,4 +584,4 @@ Status Codes
- 400
- 401
- 403
- 404
- 404