@itentialopensource/adapter-openstack_cinder

{ "openapi": "3.0.0", "info": { "version": "1.0", "title": "Openstack Cinder API" }, "servers": [ { "url": "http://{host}:{port}", "description": "Block Storage service (cinder) administrative endpoint", "variables": { "host": { "default": "localhost" }, "port": { "default": "8776" } } } ], "paths": { "/": { "get": { "operationId": "listAllApiVersions", "summary": "List All Api Versions", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-all-api-versions" }, "responses": { "300": { "description": "The resource corresponds to more than one representation." }, "400": { "description": "Some content in the request was invalid." }, "401": { "description": "User must authenticate before making a request." }, "403": { "description": "Policy does not allow current user to do this operation." }, "404": { "description": "The requested resource could not be found." }, "405": { "description": "Method is not valid for this endpoint and resource." }, "409": { "description": "This resource has an action in progress that would conflict with this request." }, "500": { "description": "Something went wrong with the service which prevents it from fulfilling\nthe request." }, "503": { "description": "The service cannot handle the request right now." } }, "tags": [ "API versions" ] } }, "/v3/": { "get": { "operationId": "showAPIV3Details", "summary": "Show API v3 details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-api-v3-details" }, "responses": { "200": { "description": "Request was successful." }, "403": { "description": "Policy does not allow current user to do this operation." } }, "tags": [ "API version details" ] } }, "/v3/{project_id}/extensions": { "get": { "operationId": "listKnownAPIExtensions", "summary": "List Known API extensions", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-known-api-extensions" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } } ], "responses": { "200": { "description": "Request was successful." }, "300": { "description": "The resource corresponds to more than one representation." } }, "tags": [ "API extensions (extensions)" ] } }, "/v3/{project_id}/types/{volume_type_id}": { "put": { "operationId": "updateAVolumeType", "summary": "Update a volume type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#update-a-volume-type" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "volume_type": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "is_public": { "type": "boolean" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volume types (types)" ] }, "get": { "operationId": "showVolumeTypeDetail", "summary": "Show volume type detail", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-volume-type-detail" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volume types (types)" ] }, "delete": { "operationId": "deleteAVolumeType", "summary": "Delete a volume type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#delete-a-volume-type" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } } ], "responses": { "202": { "description": "Request is accepted, but processing may take some time." } }, "tags": [ "Volume types (types)" ] } }, "/v3/{project_id}/types/{volume_type_id}/extra_specs": { "post": { "operationId": "createOrUpdateExtraSpecsForVolumeType", "summary": "Create or update extra specs for volume type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#create-or-update-extra-specs-for-volume-type" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "extra_specs": { "type": "object", "properties": { "key1": { "type": "string" }, "key2": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volume types (types)" ] }, "get": { "operationId": "showAllExtraSpecificationsForVolumeType", "summary": "Show all extra specifications for volume type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-all-extra-specifications-for-volume-type" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volume types (types)" ] } }, "/v3/{project_id}/types/{volume_type_id}/extra_specs/{key}": { "get": { "operationId": "showExtraSpecificationForVolumeType", "summary": "Show extra specification for volume type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-extra-specification-for-volume-type" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "description": "The key name of the extra spec for a volume type." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volume types (types)" ] }, "put": { "operationId": "updateExtraSpecificationForVolumeType", "summary": "Update extra specification for volume type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#update-extra-specification-for-volume-type" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "description": "The key name of the extra spec for a volume type." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "key1": { "type": "string" } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volume types (types)" ] }, "delete": { "operationId": "deleteExtraSpecificationForVolumeType", "summary": "Delete extra specification for volume type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#delete-extra-specification-for-volume-type" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "description": "The key name of the extra spec for a volume type." } } ], "responses": { "202": { "description": "Request is accepted, but processing may take some time." } }, "tags": [ "Volume types (types)" ] } }, "/v3/{project_id}/types/default": { "get": { "operationId": "showDefaultVolumeType", "summary": "Show default volume type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-default-volume-type" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } } ], "responses": { "200": { "description": "Request was successful." }, "404": { "description": "The requested resource could not be found." }, "500": { "description": "Something went wrong with the service which prevents it from fulfilling\nthe request." } }, "tags": [ "Volume types (types)" ] } }, "/v3/{project_id}/types": { "get": { "operationId": "listAllVolumeTypes", "summary": "List all volume types", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-all-volume-types" }, "parameters": [ { "name": "is_public", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter the volume type by public visibility.\nSee valid boolean values." } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "description": "Comma-separated list of sort keys and optional\nsort directions in the form of < key > [: < direction > ]. A valid\ndirection is asc (ascending) or desc (descending)." } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number\nof items up to a limit value. Use the limit parameter to make\nan initial limited request and use the ID of the last-seen item\nfrom the response as the marker parameter value in a\nsubsequent limited request." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with limit to return a slice of items. offset\nis where to start in the list." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The ID of the last-seen item. Use the limit\nparameter to make an initial limited request and use the ID of the\nlast-seen item from the response as the marker parameter value\nin a subsequent limited request." } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volume types (types)" ] }, "post": { "operationId": "createAVolumeType", "summary": "Create a volume type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#create-a-volume-type" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "volume_type": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "os-volume-type-access:is_public": { "type": "boolean" }, "extra_specs": { "type": "object", "properties": { "capabilities": { "type": "string" } } } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volume types (types)" ] } }, "/v3/{project_id}/types/{volume_type_id}/encryption": { "get": { "operationId": "showAnEncryptionType", "summary": "Show an encryption type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-an-encryption-type" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volume types (types)" ] }, "post": { "operationId": "createAnEncryptionType", "summary": "Create an encryption type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#create-an-encryption-type" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "encryption": { "type": "object", "properties": { "key_size": { "type": "integer" }, "provider": { "type": "string" }, "control_location": { "type": "string" }, "cipher": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volume types (types)" ] } }, "/v3/{project_id}/types/{volume_type_id}/encryption/{key}": { "get": { "operationId": "showEncryptionSpecsItem", "summary": "Show encryption specs item", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-encryption-specs-item" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "description": "The key name of the encryption spec for a volume type." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volume types (types)" ] } }, "/v3/{project_id}/types/{volume_type_id}/encryption/{encryption_id}": { "delete": { "operationId": "deleteAnEncryptionType", "summary": "Delete an encryption type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#delete-an-encryption-type" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } }, { "name": "encryption_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the encryption type." } } ], "responses": { "202": { "description": "Request is accepted, but processing may take some time." } }, "tags": [ "Volume types (types)" ] }, "put": { "operationId": "updateAnEncryptionType", "summary": "Update an encryption type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#update-an-encryption-type" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } }, { "name": "encryption_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the encryption type." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "encryption": { "type": "object", "properties": { "key_size": { "type": "integer" }, "provider": { "type": "string" }, "control_location": { "type": "string" }, "cipher": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volume types (types)" ] } }, "/v3/{project_id}/types/{volume_type}/action": { "post": { "operationId": "addPrivateVolumeTypeAccessToProject", "summary": "Add private volume type access to project", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#add-private-volume-type-access-to-project" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "addProjectAccess": { "type": "object", "properties": { "project": { "type": "string" } } } } } } } }, "responses": { "202": { "description": "Request is accepted, but processing may take some time." } }, "tags": [ "Volume type access (types, action) (types, os-volume-type-access)" ] } }, "/v3/{project_id}/types/{volume_type}/os-volume-type-access": { "get": { "operationId": "listPrivateVolumeTypeAccessDetail", "summary": "List private volume type access detail", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-private-volume-type-access-detail" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_type", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID for an existing volume type." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volume type access (types, action) (types, os-volume-type-access)" ] } }, "/v3/default-types/{project-id}": { "put": { "operationId": "createOrUpdateADefaultVolumeType", "summary": "Create or update a default volume type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#create-or-update-a-default-volume-type" }, "parameters": [ { "name": "project-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "default_type": { "type": "object", "properties": { "volume_type": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." }, "400": { "description": "Some content in the request was invalid." }, "404": { "description": "The requested resource could not be found." } }, "tags": [ "Default Volume Types (default-types)" ] }, "get": { "operationId": "showADefaultVolumeType", "summary": "Show a default volume type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-a-default-volume-type" }, "parameters": [ { "name": "project-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } } ], "responses": { "200": { "description": "Request was successful." }, "404": { "description": "The requested resource could not be found." } }, "tags": [ "Default Volume Types (default-types)" ] }, "delete": { "operationId": "deleteADefaultVolumeType", "summary": "Delete a default volume type", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#delete-a-default-volume-type" }, "parameters": [ { "name": "project-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } } ], "responses": { "204": { "description": "Request fulfilled but service does not return anything." }, "404": { "description": "The requested resource could not be found." } }, "tags": [ "Default Volume Types (default-types)" ] } }, "/v3/default-types/": { "get": { "operationId": "listDefaultVolumeTypes", "summary": "List default volume types", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-default-volume-types" }, "responses": { "200": { "description": "Request was successful." }, "404": { "description": "The requested resource could not be found." } }, "tags": [ "Default Volume Types (default-types)" ] } }, "/v3/{project_id}/volumes/detail": { "get": { "operationId": "listAccessibleVolumesWithDetails", "summary": "List accessible volumes with details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-accessible-volumes-with-details" }, "parameters": [ { "name": "all_tenants", "in": "query", "required": false, "schema": { "type": "string", "description": "Shows details for all project. Admin only." } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "description": "Comma-separated list of sort keys and optional\nsort directions in the form of < key > [: < direction > ]. A valid\ndirection is asc (ascending) or desc (descending)." } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number\nof items up to a limit value. Use the limit parameter to make\nan initial limited request and use the ID of the last-seen item\nfrom the response as the marker parameter value in a\nsubsequent limited request." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with limit to return a slice of items. offset\nis where to start in the list." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The ID of the last-seen item. Use the limit\nparameter to make an initial limited request and use the ID of the\nlast-seen item from the response as the marker parameter value\nin a subsequent limited request." } }, { "name": "with_count", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to show count in API response or not, default is False." } }, { "name": "created_at", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters reuslts by a time that resources are created at with time\ncomparison operators: gt/gte/eq/neq/lt/lte.\nThe date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm.\nThe ±hh:mm value, if included, returns the time zone as an offset from UTC." } }, { "name": "updated_at", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters reuslts by a time that resources are updated at with time\ncomaprison operators: gt/gte/eq/neq/lt/lte.\nThe date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm.\nThe ±hh:mm value, if included, returns the time zone as an offset from UTC." } }, { "name": "consumes_quota", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filters results by consumes_quota field. Resources that don’t use\nquotas are usually temporary internal resources created to perform an\noperation. Default is to not filter by it. Filtering by this option may\nnot be always possible in a cloud, see\nList Resource Filters to determine whether this\nfilter is available in your cloud." } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } } ], "responses": { "200": { "description": "Request was successful." }, "400": { "description": "Some content in the request was invalid." } }, "tags": [ "Volumes (volumes)" ] } }, "/v3/{project_id}/volumes": { "post": { "operationId": "createAVolume", "summary": "Create a volume", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#create-a-volume" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "volume": { "type": "object", "properties": { "size": { "type": "integer" }, "availability_zone": { "type": "string" }, "source_volid": { "type": "string" }, "description": { "type": "string" }, "multiattach": { "type": "boolean" }, "snapshot_id": { "type": "string" }, "backup_id": { "type": "string" }, "name": { "type": "string" }, "imageRef": { "type": "string" }, "volume_type": { "type": "string" }, "metadata": { "type": "object" }, "consistencygroup_id": { "type": "string" } } }, "OS-SCH-HNT:scheduler_hints": { "type": "object", "properties": { "same_host": { "type": "array", "items": { "type": "string" } } } } } } } } }, "responses": { "202": { "description": "Request is accepted, but processing may take some time." } }, "tags": [ "Volumes (volumes)" ] }, "get": { "operationId": "listAccessibleVolumes", "summary": "List accessible volumes", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-accessible-volumes" }, "parameters": [ { "name": "all_tenants", "in": "query", "required": false, "schema": { "type": "string", "description": "Shows details for all project. Admin only." } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "description": "Comma-separated list of sort keys and optional\nsort directions in the form of < key > [: < direction > ]. A valid\ndirection is asc (ascending) or desc (descending)." } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number\nof items up to a limit value. Use the limit parameter to make\nan initial limited request and use the ID of the last-seen item\nfrom the response as the marker parameter value in a\nsubsequent limited request." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with limit to return a slice of items. offset\nis where to start in the list." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The ID of the last-seen item. Use the limit\nparameter to make an initial limited request and use the ID of the\nlast-seen item from the response as the marker parameter value\nin a subsequent limited request." } }, { "name": "with_count", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to show count in API response or not, default is False." } }, { "name": "created_at", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters reuslts by a time that resources are created at with time\ncomparison operators: gt/gte/eq/neq/lt/lte.\nThe date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm.\nThe ±hh:mm value, if included, returns the time zone as an offset from UTC." } }, { "name": "consumes_quota", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filters results by consumes_quota field. Resources that don’t use\nquotas are usually temporary internal resources created to perform an\noperation. Default is to not filter by it. Filtering by this option may\nnot be always possible in a cloud, see\nList Resource Filters to determine whether this\nfilter is available in your cloud." } }, { "name": "updated_at", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters reuslts by a time that resources are updated at with time\ncomaprison operators: gt/gte/eq/neq/lt/lte.\nThe date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm.\nThe ±hh:mm value, if included, returns the time zone as an offset from UTC." } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } } ], "responses": { "200": { "description": "Request was successful." }, "400": { "description": "Some content in the request was invalid." } }, "tags": [ "Volumes (volumes)" ] } }, "/v3/{project_id}/volumes/{volume_id}": { "get": { "operationId": "showAVolume’sDetails", "summary": "Show a volume’s details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-a-volume-s-details" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the volume." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volumes (volumes)" ] }, "put": { "operationId": "updateAVolume", "summary": "Update a volume", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#update-a-volume" }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the project in a multi-tenancy cloud." } }, { "name": "volume_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the volume." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "volume": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "metadata": { "type": "object", "properties": { "name": { "type": "string" } } } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Volumes (volumes)" ] }, "delete": { "operationId": "deleteAVolume", "summary": "Delete a volume", "externalDocs": { "url": "https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#delete-a-volume" }, "parameters": [ { "name": "cascade", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Remove any snapshots along with the volume. Default=False." } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Indicates whether to force delete a volume even if\nthe volume is in deleting or error_deleting. Default is false." } }, { "name": "project_id", "in":