api-ref: Add description field in Endpoint

The Keystone defines a 'description' field on its schema which can be
returned if the user have set it on resource creation/update, but the
docs doesn't mention this field, which can be confusing.

Change-Id: Id64792411d2704fee581cf86806eb430f0319256
Signed-off-by: Winicius Silva <winiciusab12@gmail.com>
This commit is contained in:
Winicius Silva 2025-12-08 15:39:09 -03:00
parent 5b5c573c2f
commit 4a0299e03c
2 changed files with 13 additions and 0 deletions

View file

@ -935,6 +935,13 @@ endpoint:
in: body
required: true
type: object
endpoint_description:
description: |
The endpoint description. It is returned only when set on the
resource.
in: body
required: false
type: string
endpoint_enabled:
description: |
Indicates whether the endpoint appears in the

View file

@ -338,6 +338,7 @@ Parameters
- endpoints: endpoints
- id: endpoint_id
- name: endpoint_name
- description: endpoint_description
Status Codes
~~~~~~~~~~~~
@ -383,6 +384,7 @@ Parameters
- service_id: service_id
- region_id: region_id_not_required
- name: endpoint_name
- description: endpoint_description
Example
~~~~~~~
@ -408,6 +410,7 @@ Parameters
- id: endpoint_id
- name: endpoint_name
- region_id: region_id_required
- description: endpoint_description
Status Codes
~~~~~~~~~~~~
@ -458,6 +461,7 @@ Parameters
- region: endpoint_region
- interface: endpoint_interface
- service_id: service_id
- description: endpoint_description
Status Codes
~~~~~~~~~~~~
@ -504,6 +508,7 @@ Parameters
- service_id: service_id
- endpoint_id: endpoint_id_path
- name: endpoint_name
- description: endpoint_description
Example
~~~~~~~
@ -527,6 +532,7 @@ Parameters
- interface: endpoint_interface
- name: endpoint_name
- service_id: service_id
- description: endpoint_description
Status Codes
~~~~~~~~~~~~