a40cf11ee5
In the TUI absense of "required" leads to ID/NAME being optional what those could never be. In adition also ensure that the response struct as well as fields themselves are public so that we can consume them. Change-Id: I7850b6de85a1e2aa74d597bca7226430bb45cb2c
502 lines
19 KiB
Python
502 lines
19 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||
# not use this file except in compliance with the License. You may obtain
|
||
# a copy of the License at
|
||
#
|
||
# http://www.apache.org/licenses/LICENSE-2.0
|
||
#
|
||
# Unless required by applicable law or agreed to in writing, software
|
||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||
# License for the specific language governing permissions and limitations
|
||
# under the License.
|
||
#
|
||
import copy
|
||
from typing import Any
|
||
|
||
from cinder.api.schemas import admin_actions
|
||
|
||
from codegenerator.openapi.cinder_schemas import common
|
||
from codegenerator.common.schema import ParameterSchema
|
||
from codegenerator.common.schema import TypeSchema
|
||
|
||
|
||
ATTACHMENT_SCHEMA: dict[str, Any] = {
|
||
"type": "object",
|
||
"properties": {
|
||
"server_id": {"type": ["string", "null"], "format": "uuid"},
|
||
"attachment_id": {"type": "string", "format": "uuid"},
|
||
"attached_at": {"type": "string", "format": "date-time"},
|
||
"host_name": {"type": ["string", "null"]},
|
||
"volume_id": {"type": "string", "format": "uuid"},
|
||
"device": {"type": ["string", "null"]},
|
||
"id": {"type": "string", "format": "uuid"},
|
||
},
|
||
"additionalProperties": False,
|
||
"required": [
|
||
"server_id",
|
||
"attachment_id",
|
||
"host_name",
|
||
"volume_id",
|
||
"device",
|
||
"id",
|
||
],
|
||
}
|
||
|
||
ATTACHMENTS_SCHEMA: dict[str, Any] = {
|
||
"type": "array",
|
||
"items": copy.deepcopy(ATTACHMENT_SCHEMA),
|
||
}
|
||
|
||
VOLUME_SHORT_SCHEMA: dict[str, Any] = {
|
||
"type": "object",
|
||
"description": "A volume object.",
|
||
"properties": {
|
||
"name": {
|
||
"type": ["string", "null"],
|
||
"description": "The volume name.",
|
||
},
|
||
"links": {
|
||
"description": "The volume links.",
|
||
**copy.deepcopy(common.LINKS_SCHEMA),
|
||
},
|
||
"id": {
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "The UUID of the volume.",
|
||
},
|
||
},
|
||
"required": ["id", "name"],
|
||
}
|
||
|
||
VOLUME_SCHEMA: dict[str, Any] = {
|
||
"type": "object",
|
||
"description": "A volume object.",
|
||
"properties": {
|
||
"name": {
|
||
"type": ["string", "null"],
|
||
"description": "The volume name.",
|
||
},
|
||
"description": {
|
||
"type": ["string", "null"],
|
||
"description": "The volume description.",
|
||
},
|
||
"volume_type": {
|
||
"type": "string",
|
||
"description": "The associated volume type name for the volume.",
|
||
},
|
||
"metadata": copy.deepcopy(common.METADATA_SCHEMA),
|
||
"snapshot_id": {
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "To create a volume from an existing snapshot, specify the UUID of the volume snapshot. The volume is created in same availability zone and with same size as the snapshot.",
|
||
},
|
||
"source_volid": {
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "The UUID of the source volume. The API creates a new volume with the same size as the source volume unless a larger size is requested.",
|
||
},
|
||
"consistencygroup_id": {
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "The UUID of the consistency group.",
|
||
},
|
||
"size": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"description": "The size of the volume, in gibibytes (GiB).",
|
||
},
|
||
"availability_zone": {
|
||
"type": "string",
|
||
"description": "The name of the availability zone.",
|
||
},
|
||
"bootable": {
|
||
"type": "boolean",
|
||
"description": "Enables or disables the bootable attribute. You can boot an instance from a bootable volume.",
|
||
},
|
||
"multiattach": {
|
||
"type": "boolean",
|
||
"description": "If true, this volume can attach to more than one instance.",
|
||
},
|
||
"status": {"type": "string", "description": "The volume status."},
|
||
"migration_status": {
|
||
"type": "string",
|
||
"description": "The volume migration status. Admin only.",
|
||
},
|
||
"attachments": {
|
||
"description": "Instance attachment information. If this volume is attached to a server instance, the attachments list includes the UUID of the attached server, an attachment UUID, the name of the attached host, if any, the volume UUID, the device, and the device UUID. Otherwise, this list is empty.",
|
||
**copy.deepcopy(ATTACHMENTS_SCHEMA),
|
||
},
|
||
"links": {
|
||
"description": "The volume links.",
|
||
**copy.deepcopy(common.LINKS_SCHEMA),
|
||
},
|
||
"encrypted": {
|
||
"type": "boolean",
|
||
"description": "If true, this volume is encrypted.",
|
||
},
|
||
"created_at": {
|
||
"type": "string",
|
||
"format": "date-time",
|
||
"description": "The date and time when the resource was created.",
|
||
},
|
||
"updated_at": {
|
||
"type": "string",
|
||
"format": "date-time",
|
||
"description": "The date and time when the resource was updated.",
|
||
},
|
||
"replication_status": {
|
||
"type": "string",
|
||
"description": "The volume replication status.",
|
||
},
|
||
"id": {
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "The UUID of the volume.",
|
||
},
|
||
"user_id": {
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "The UUID of the user.",
|
||
},
|
||
"volume_type_id": {
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "The associated volume type ID for the volume.",
|
||
"x-openstack": {"min-ver": "3.63"},
|
||
},
|
||
"group_id": {
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "The ID of the group.",
|
||
"x-openstack": {"min-ver": "3.63"},
|
||
},
|
||
"provider_id": {
|
||
"type": ["string", "null"],
|
||
"format": "uuid",
|
||
"description": "The provider ID for the volume. The value is either a string set by the driver or null if the driver doesn’t use the field or if it hasn’t created it yet. Only returned for administrators.",
|
||
"x-openstack": {"min-ver": "3.21"},
|
||
},
|
||
"service_uuid": {
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "A unique identifier that’s used to indicate what node the volume-service for a particular volume is being serviced by.",
|
||
"x-openstack": {"min-ver": "3.48"},
|
||
},
|
||
"shared_targets": {
|
||
"type": "boolean",
|
||
"description": "An indicator whether the host connecting the volume should lock for the whole attach/detach process or not. true means only is iSCSI initiator running on host doesn’t support manual scans, false means never use locks, and null means to always use locks. Look at os-brick’s guard_connection context manager. Default=True.",
|
||
"x-openstack": {"min-ver": "3.48"},
|
||
},
|
||
"cluster_name": {
|
||
"type": "string",
|
||
"description": "The cluster name of volume backend.",
|
||
"x-openstack": {"min-ver": "3.61"},
|
||
},
|
||
"consumes_quota": {
|
||
"type": "boolean",
|
||
"description": "Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation.",
|
||
"x-openstack": {"min-ver": "3.65"},
|
||
},
|
||
},
|
||
"required": [
|
||
"attachments",
|
||
"bootable",
|
||
"encrypted",
|
||
"id",
|
||
"migration_status",
|
||
"name",
|
||
"replication_status",
|
||
"size",
|
||
"status",
|
||
"user_id",
|
||
],
|
||
"additionalProperties": True,
|
||
}
|
||
|
||
VOLUME_CONTAINER_SCHEMA: dict[str, Any] = {
|
||
"type": "object",
|
||
"description": "A volume object.",
|
||
"properties": {"volume": copy.deepcopy(VOLUME_SCHEMA)},
|
||
"required": ["volume"],
|
||
"additionalProperties": False,
|
||
}
|
||
|
||
VOLUMES_SCHEMA: dict[str, Any] = {
|
||
"type": "object",
|
||
"description": "A container with list of volume objects.",
|
||
"properties": {
|
||
"volumes": {
|
||
"type": "array",
|
||
"items": copy.deepcopy(VOLUME_SHORT_SCHEMA),
|
||
"description": "A list of volume objects.",
|
||
}
|
||
},
|
||
}
|
||
|
||
VOLUMES_DETAIL_SCHEMA: dict[str, Any] = {
|
||
"type": "object",
|
||
"description": "A container with list of volume objects.",
|
||
"properties": {
|
||
"volumes": {
|
||
"type": "array",
|
||
"items": copy.deepcopy(VOLUME_SCHEMA),
|
||
"description": "A list of volume objects.",
|
||
}
|
||
},
|
||
}
|
||
|
||
VOLUME_PARAMETERS: dict[str, Any] = {
|
||
"all_tenants": {
|
||
"in": "query",
|
||
"name": "all_tenants",
|
||
"schema": {"type": "boolean"},
|
||
"description": "Shows details for all project. Admin only.",
|
||
},
|
||
"sort": {
|
||
"in": "query",
|
||
"name": "sort",
|
||
"schema": {"type": "string"},
|
||
"description": "Comma-separated list of sort keys and optional sort directions in the form of < key > [: < direction > ]. A valid direction is asc (ascending) or desc (descending).",
|
||
},
|
||
"sort_key": {
|
||
"in": "query",
|
||
"name": "sort_key",
|
||
"schema": {"type": "string"},
|
||
"description": "Sorts by an attribute. A valid value is name, status, container_format, disk_format, size, id, created_at, or updated_at. Default is created_at. The API uses the natural sorting direction of the sort_key attribute value. Deprecated in favour of the combined sort parameter.",
|
||
},
|
||
"sort_dir": {
|
||
"in": "query",
|
||
"name": "sort_dir",
|
||
"schema": {"type": "string", "enum": ["asc", "desc"]},
|
||
"description": "Sorts by one or more sets of attribute and sort direction combinations. If you omit the sort direction in a set, default is desc. Deprecated in favour of the combined sort parameter.",
|
||
},
|
||
"limit": {
|
||
"in": "query",
|
||
"name": "limit",
|
||
"schema": {"type": "integer", "minimum": 1},
|
||
"description": "Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.",
|
||
},
|
||
"offset": {
|
||
"in": "query",
|
||
"name": "offset",
|
||
"schema": {"type": "integer"},
|
||
"description": "Used in conjunction with limit to return a slice of items. offset is where to start in the list.",
|
||
},
|
||
"marker": {
|
||
"in": "query",
|
||
"name": "marker",
|
||
"schema": {"type": "string", "format": "uuid"},
|
||
"description": "The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.",
|
||
},
|
||
"with_count": {
|
||
"in": "query",
|
||
"name": "with_count",
|
||
"schema": {"type": "boolean"},
|
||
"description": "Whether to show count in API response or not, default is False.",
|
||
"x-openstack": {"min-ver": "3.45"},
|
||
},
|
||
"created_at": {
|
||
"in": "query",
|
||
"name": "created_at",
|
||
"schema": {"type": "string", "format": "date-time"},
|
||
"description": "Filters reuslts by a time that resources are created at with time comparison operators: gt/gte/eq/neq/lt/lte.",
|
||
"x-openstack": {"min-ver": "3.60"},
|
||
},
|
||
"updated_at": {
|
||
"in": "query",
|
||
"name": "updated_at",
|
||
"schema": {"type": "string", "format": "date-time"},
|
||
"description": "Filters reuslts by a time that resources are updated at with time comparison operators: gt/gte/eq/neq/lt/lte.",
|
||
"x-openstack": {"min-ver": "3.60"},
|
||
},
|
||
"consumes_quota": {
|
||
"in": "query",
|
||
"name": "consumes_quota",
|
||
"schema": {"type": "boolean"},
|
||
"description": "Filters results by consumes_quota field. Resources that don’t use quotas are usually temporary internal resources created to perform an operation. Default is to not filter by it. Filtering by this option may not be always possible in a cloud, see List Resource Filters to determine whether this filter is available in your cloud.",
|
||
"x-openstack": {"min-ver": "3.65"},
|
||
},
|
||
}
|
||
|
||
VOLUME_RESET_STATUS_SCHEMA: dict[str, Any] = admin_actions.reset
|
||
|
||
VOLUME_UPLOAD_IMAGE_RESPONSE_SCHEMA: dict[str, Any] = {
|
||
"type": "object",
|
||
"properties": {
|
||
"container_format": {
|
||
"type": "string",
|
||
"description": "Container format for the new image. Default is bare.",
|
||
},
|
||
"disk_format": {
|
||
"type": "string",
|
||
"description": "Disk format for the new image. Default is raw.",
|
||
},
|
||
"display_description": {
|
||
"type": "string",
|
||
"description": "The volume description.",
|
||
},
|
||
"id": {
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "The UUID of the volume.",
|
||
},
|
||
"image_id": {
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "The uuid for the new image.",
|
||
},
|
||
"image_name": {
|
||
"type": "string",
|
||
"description": "The name for the new image.",
|
||
},
|
||
"protected": {
|
||
"type": "boolean",
|
||
"description": "Whether the new image is protected. Default=False.",
|
||
"x-openstack": {"min-ver": "3.1"},
|
||
},
|
||
"size": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"description": "The size of the volume, in gibibytes (GiB).",
|
||
},
|
||
"status": {"type": "integer", "description": "The volume status."},
|
||
"updated_at": {
|
||
"type": "string",
|
||
"format": "date-time",
|
||
"description": "The date and time when the resource was updated.",
|
||
},
|
||
"visibility": {
|
||
"type": "string",
|
||
"description": "The visibility property of the new image. Default is private.",
|
||
"x-openstack": {"min-ver": "3.1"},
|
||
},
|
||
"volume_type": {
|
||
"type": "string",
|
||
"description": "The associated volume type name for the volume.",
|
||
},
|
||
},
|
||
}
|
||
|
||
|
||
def _post_process_operation_hook(
|
||
openapi_spec, operation_spec, path: str | None = None
|
||
):
|
||
"""Hook to allow service specific generator to modify details"""
|
||
operationId = operation_spec.operationId
|
||
if operationId in [
|
||
"project_id/volumes:get",
|
||
"volumes:get",
|
||
"project_id/volumes/detail:get",
|
||
"volumes/detail:get",
|
||
]:
|
||
for pname in [
|
||
"all_tenants",
|
||
"sort",
|
||
"sort_key",
|
||
"sort_dir",
|
||
"limit",
|
||
"offset",
|
||
"marker",
|
||
"with_count",
|
||
"created_at",
|
||
"updated_at",
|
||
"consumes_quota",
|
||
]:
|
||
ref = f"#/components/parameters/{pname}"
|
||
if ref not in [x.ref for x in operation_spec.parameters]:
|
||
operation_spec.parameters.append(ParameterSchema(ref=ref))
|
||
elif operationId in ["project_id/volumes/summary:get"]:
|
||
for pname in ["all_tenants"]:
|
||
ref = f"#/components/parameters/{pname}"
|
||
if ref not in [x.ref for x in operation_spec.parameters]:
|
||
operation_spec.parameters.append(ParameterSchema(ref=ref))
|
||
|
||
|
||
def _get_schema_ref(
|
||
openapi_spec, name, description=None, schema_def=None, action_name=None
|
||
) -> tuple[str | None, str | None, bool]:
|
||
mime_type: str = "application/json"
|
||
ref: str
|
||
# ### Volume
|
||
if name == "VolumesListResponse":
|
||
openapi_spec.components.schemas.setdefault(
|
||
name, TypeSchema(**VOLUMES_SCHEMA)
|
||
)
|
||
ref = f"#/components/schemas/{name}"
|
||
if name == "VolumesDetailResponse":
|
||
openapi_spec.components.schemas.setdefault(
|
||
name, TypeSchema(**VOLUMES_DETAIL_SCHEMA)
|
||
)
|
||
ref = f"#/components/schemas/{name}"
|
||
elif name in [
|
||
"VolumeShowResponse",
|
||
"VolumeUpdateResponse",
|
||
"VolumesCreateResponse",
|
||
]:
|
||
openapi_spec.components.schemas.setdefault(
|
||
name, TypeSchema(**VOLUME_CONTAINER_SCHEMA)
|
||
)
|
||
ref = f"#/components/schemas/{name}"
|
||
# ### Volume Metadata
|
||
elif name in [
|
||
"VolumesMetadataListResponse",
|
||
"VolumesMetadataUpdate_All",
|
||
"VolumesMetadataUpdate_AllResponse",
|
||
"VolumesMetadataCreateResponse",
|
||
"VolumesActionOs-Set_Image_MetadataResponse",
|
||
"VolumesActionOs-Show_Image_MetadataResponse",
|
||
]:
|
||
openapi_spec.components.schemas.setdefault(
|
||
name, TypeSchema(**common.METADATA_CONTAINER_SCHEMA)
|
||
)
|
||
ref = f"#/components/schemas/{name}"
|
||
elif name in [
|
||
"VolumesMetadataShowResponse",
|
||
"VolumesMetadataUpdate",
|
||
"VolumesMetadataUpdateResponse",
|
||
]:
|
||
openapi_spec.components.schemas.setdefault(
|
||
name, TypeSchema(**common.METADATA_ITEM_SCHEMA)
|
||
)
|
||
ref = f"#/components/schemas/{name}"
|
||
# Volume Actions
|
||
elif name == "VolumesActionRevertResponse":
|
||
return (None, None, True)
|
||
elif name == "VolumesActionOs-Reset_StatusRequest":
|
||
openapi_spec.components.schemas.setdefault(
|
||
name, TypeSchema(**VOLUME_RESET_STATUS_SCHEMA)
|
||
)
|
||
ref = f"#/components/schemas/{name}"
|
||
elif name in [
|
||
"VolumesActionOs-Reset_StatusResponse",
|
||
"VolumesActionOs-Force_DeleteResponse",
|
||
"VolumesActionOs-Force_DetachResponse",
|
||
"VolumesActionOs-Migrate_VolumeResponse",
|
||
"VolumesActionOs-Migrate_Volume_CompletionResponse",
|
||
"VolumesActionOs-AttachResponse",
|
||
"VolumesActionOs-DetachResponse",
|
||
"VolumesActionOs-ReserveResponse",
|
||
"VolumesActionOs-UnreserveResponse",
|
||
"VolumesActionOs-Begin_DetachingResponse",
|
||
"VolumesActionOs-Roll_DetachingResponse",
|
||
"VolumesActionOs-Initialize_ConnectionResponse",
|
||
"VolumesActionOs-Terminate_ConnectionResponse",
|
||
"VolumesActionOs-ExtendResponse",
|
||
"VolumesActionOs-Update_Readonly_FlagResponse",
|
||
"VolumesActionOs-RetypeResponse",
|
||
"VolumesActionOs-Set_BootableResponse",
|
||
"VolumesActionOs-ReimageResponse",
|
||
"VolumesActionOs-Unset_Image_MetadataResponse",
|
||
"VolumesActionOs-UnmanageResponse",
|
||
]:
|
||
return (None, None, True)
|
||
elif name == "VolumesActionOs-Volume_Upload_ImageResponse":
|
||
openapi_spec.components.schemas.setdefault(
|
||
name, TypeSchema(**VOLUME_UPLOAD_IMAGE_RESPONSE_SCHEMA)
|
||
)
|
||
ref = f"#/components/schemas/{name}"
|
||
else:
|
||
return (None, None, False)
|
||
|
||
return (ref, mime_type, True)
|