diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index dd88c56a63..2e29f94507 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -7,6 +7,18 @@ path-amphora-id: in: path required: true type: uuid +path-flavor-id: + description: | + The ID of the flavor to query. + in: path + required: true + type: uuid +path-flavorprofile-id: + description: | + The ID of the flavor profile to query. + in: path + required: true + type: uuid path-healthmonitor-id: description: | The ID of the health monitor to query. @@ -305,18 +317,72 @@ description-optional: in: body required: false type: string +enabled: + description: | + If the resource is available for use. + in: body + required: true + type: boolean +enabled-optional: + description: | + If the resource is available for use. The default is True. + in: body + required: false + type: boolean +flavor: + description: | + A flavor object. + in: body + required: true + type: object +flavor-data: + description: | + The JSON string containing the flavor metadata. + in: body + required: true + type: string +flavor-data-optional: + description: | + The JSON string containing the flavor metadata. + in: body + required: false + type: string flavor-id: description: | The ID of the flavor. in: body required: true - type: string + type: uuid flavor-id-optional: description: | The ID of the flavor. in: body required: false - type: string + type: uuid +flavor-profile-id: + description: | + The ID of the flavor profile. + in: body + required: true + type: uuid +flavorprofile: + description: | + A ``flavorprofile`` object. + in: body + required: true + type: object +flavorprofiles: + description: | + A list of ``flavorprofile`` objects. + in: body + required: true + type: array +flavors: + description: | + A list of ``flavor`` objects. + in: body + required: true + type: array healthmonitor-delay: description: | The time, in seconds, between sending probes to members. @@ -911,6 +977,12 @@ provider-name: in: body required: true type: string +provider-name-optional: + description: | + Provider name. + in: body + required: false + type: string provider-optional: description: | Provider name for the load balancer. Default is ``octavia``. diff --git a/api-ref/source/v2/examples/flavor-create-curl b/api-ref/source/v2/examples/flavor-create-curl new file mode 100644 index 0000000000..841f2b70e7 --- /dev/null +++ b/api-ref/source/v2/examples/flavor-create-curl @@ -0,0 +1 @@ +curl -X POST -H "Content-Type: application/json" -H "X-Auth-Token: " -d '{"flavor":{"name":"Basic","description":"A basic standalone Octavia load balancer.","enabled":true,"flavor_profile_id":"5712097e-0092-45dc-bff0-ab68b61ad51a"}}' http://198.51.100.10:9876/v2.0/lbaas/flavors diff --git a/api-ref/source/v2/examples/flavor-create-request.json b/api-ref/source/v2/examples/flavor-create-request.json new file mode 100644 index 0000000000..5dcdd39831 --- /dev/null +++ b/api-ref/source/v2/examples/flavor-create-request.json @@ -0,0 +1,8 @@ +{ + "flavor": { + "name": "Basic", + "description": "A basic standalone Octavia load balancer.", + "enabled": true, + "flavor_profile_id": "5712097e-0092-45dc-bff0-ab68b61ad51a" + } +} diff --git a/api-ref/source/v2/examples/flavor-create-response.json b/api-ref/source/v2/examples/flavor-create-response.json new file mode 100644 index 0000000000..443639b074 --- /dev/null +++ b/api-ref/source/v2/examples/flavor-create-response.json @@ -0,0 +1,9 @@ +{ + "flavor": { + "id": "8f94060c-8d5b-4472-9cfd-e8a2b909481d", + "name": "Basic", + "description": "A basic standalone Octavia load balancer.", + "enabled": true, + "flavor_profile_id": "5712097e-0092-45dc-bff0-ab68b61ad51a" + } +} diff --git a/api-ref/source/v2/examples/flavor-delete-curl b/api-ref/source/v2/examples/flavor-delete-curl new file mode 100644 index 0000000000..a64b486fb5 --- /dev/null +++ b/api-ref/source/v2/examples/flavor-delete-curl @@ -0,0 +1 @@ +curl -X DELETE -H "X-Auth-Token: " http://198.51.100.10:9876/v2.0/lbaas/flavors/8f94060c-8d5b-4472-9cfd-e8a2b909481d diff --git a/api-ref/source/v2/examples/flavor-list-curl b/api-ref/source/v2/examples/flavor-list-curl new file mode 100644 index 0000000000..62702ff643 --- /dev/null +++ b/api-ref/source/v2/examples/flavor-list-curl @@ -0,0 +1 @@ +curl -X GET -H "X-Auth-Token: " http://198.51.100.10:9876/v2.0/lbaas/flavors diff --git a/api-ref/source/v2/examples/flavor-profile-list-curl b/api-ref/source/v2/examples/flavor-profile-list-curl new file mode 100644 index 0000000000..cfbe2bec4e --- /dev/null +++ b/api-ref/source/v2/examples/flavor-profile-list-curl @@ -0,0 +1 @@ +curl -X GET -H "X-Auth-Token: " http://198.51.100.10:9876/v2.0/lbaas/flavorprofiles diff --git a/api-ref/source/v2/examples/flavor-show-curl b/api-ref/source/v2/examples/flavor-show-curl new file mode 100644 index 0000000000..7b04f1ffa6 --- /dev/null +++ b/api-ref/source/v2/examples/flavor-show-curl @@ -0,0 +1 @@ +curl -X GET -H "X-Auth-Token: " http://198.51.100.10:9876/v2.0/lbaas/flavors/8f94060c-8d5b-4472-9cfd-e8a2b909481d diff --git a/api-ref/source/v2/examples/flavor-show-response.json b/api-ref/source/v2/examples/flavor-show-response.json new file mode 100644 index 0000000000..443639b074 --- /dev/null +++ b/api-ref/source/v2/examples/flavor-show-response.json @@ -0,0 +1,9 @@ +{ + "flavor": { + "id": "8f94060c-8d5b-4472-9cfd-e8a2b909481d", + "name": "Basic", + "description": "A basic standalone Octavia load balancer.", + "enabled": true, + "flavor_profile_id": "5712097e-0092-45dc-bff0-ab68b61ad51a" + } +} diff --git a/api-ref/source/v2/examples/flavor-update-curl b/api-ref/source/v2/examples/flavor-update-curl new file mode 100644 index 0000000000..99c583926c --- /dev/null +++ b/api-ref/source/v2/examples/flavor-update-curl @@ -0,0 +1 @@ +curl -X PUT -H "Content-Type: application/json" -H "X-Auth-Token: " -d '{"flavor":{"name":"Basic","description":"A basic standalone Octavia load balancer.","enabled":false}}' http://198.51.100.10:9876/v2.0/lbaas/flavors/8f94060c-8d5b-4472-9cfd-e8a2b909481d diff --git a/api-ref/source/v2/examples/flavor-update-request.json b/api-ref/source/v2/examples/flavor-update-request.json new file mode 100644 index 0000000000..000b531f3a --- /dev/null +++ b/api-ref/source/v2/examples/flavor-update-request.json @@ -0,0 +1,7 @@ +{ + "flavor": { + "name": "Basic", + "description": "A basic standalone Octavia load balancer.", + "enabled": false + } +} diff --git a/api-ref/source/v2/examples/flavor-update-response.json b/api-ref/source/v2/examples/flavor-update-response.json new file mode 100644 index 0000000000..8d8fb791c8 --- /dev/null +++ b/api-ref/source/v2/examples/flavor-update-response.json @@ -0,0 +1,9 @@ +{ + "flavor": { + "id": "8f94060c-8d5b-4472-9cfd-e8a2b909481d", + "name": "Basic", + "description": "A basic standalone Octavia load balancer.", + "enabled": false, + "flavor_profile_id": "5712097e-0092-45dc-bff0-ab68b61ad51a" + } +} diff --git a/api-ref/source/v2/examples/flavorprofile-create-curl b/api-ref/source/v2/examples/flavorprofile-create-curl new file mode 100644 index 0000000000..c949289332 --- /dev/null +++ b/api-ref/source/v2/examples/flavorprofile-create-curl @@ -0,0 +1 @@ +curl -X POST -H "Content-Type: application/json" -H "X-Auth-Token: " -d '{"flavorprofile":{"name":"amphora-act-stdby","provider_name":"amphora","flavor_data":"{\"loadbalancer_topology\": \"ACTIVE_STANDBY\"}"}}' http://198.51.100.10:9876/v2.0/lbaas/flavorprofiles diff --git a/api-ref/source/v2/examples/flavorprofile-create-request.json b/api-ref/source/v2/examples/flavorprofile-create-request.json new file mode 100644 index 0000000000..7f72850f3a --- /dev/null +++ b/api-ref/source/v2/examples/flavorprofile-create-request.json @@ -0,0 +1,8 @@ +{ + "flavorprofile": + { + "name": "amphora-act-stdby", + "provider_name": "amphora", + "flavor_data": "{\"loadbalancer_topology\": \"ACTIVE_STANDBY\"}" + } +} diff --git a/api-ref/source/v2/examples/flavorprofile-create-response.json b/api-ref/source/v2/examples/flavorprofile-create-response.json new file mode 100644 index 0000000000..a98f72bad4 --- /dev/null +++ b/api-ref/source/v2/examples/flavorprofile-create-response.json @@ -0,0 +1,9 @@ +{ + "flavorprofile": + { + "id": "5712097e-0092-45dc-bff0-ab68b61ad51a", + "name": "amphora-act-stdby", + "provider_name": "amphora", + "flavor_data": "{\"loadbalancer_topology\": \"ACTIVE_STANDBY\"}" + } +} diff --git a/api-ref/source/v2/examples/flavorprofile-delete-curl b/api-ref/source/v2/examples/flavorprofile-delete-curl new file mode 100644 index 0000000000..ca461f4e71 --- /dev/null +++ b/api-ref/source/v2/examples/flavorprofile-delete-curl @@ -0,0 +1 @@ +curl -X DELETE -H "X-Auth-Token: " http://198.51.100.10:9876/v2.0/lbaas/flavorprofiles/5712097e-0092-45dc-bff0-ab68b61ad51a diff --git a/api-ref/source/v2/examples/flavorprofile-show-curl b/api-ref/source/v2/examples/flavorprofile-show-curl new file mode 100644 index 0000000000..db3f8ce27f --- /dev/null +++ b/api-ref/source/v2/examples/flavorprofile-show-curl @@ -0,0 +1 @@ +curl -X GET -H "X-Auth-Token: " http://198.51.100.10:9876/v2.0/lbaas/flavorprofiles/5712097e-0092-45dc-bff0-ab68b61ad51a diff --git a/api-ref/source/v2/examples/flavorprofile-show-response.json b/api-ref/source/v2/examples/flavorprofile-show-response.json new file mode 100644 index 0000000000..a98f72bad4 --- /dev/null +++ b/api-ref/source/v2/examples/flavorprofile-show-response.json @@ -0,0 +1,9 @@ +{ + "flavorprofile": + { + "id": "5712097e-0092-45dc-bff0-ab68b61ad51a", + "name": "amphora-act-stdby", + "provider_name": "amphora", + "flavor_data": "{\"loadbalancer_topology\": \"ACTIVE_STANDBY\"}" + } +} diff --git a/api-ref/source/v2/examples/flavorprofile-update-curl b/api-ref/source/v2/examples/flavorprofile-update-curl new file mode 100644 index 0000000000..26d5e348d2 --- /dev/null +++ b/api-ref/source/v2/examples/flavorprofile-update-curl @@ -0,0 +1 @@ +curl -X PUT -H "Content-Type: application/json" -H "X-Auth-Token: " -d '{"flavorprofile":{"name":"amphora-standalone","provider_name":"amphora","flavor_data":"{\"loadbalancer_topology\": \"SINGLE\"}"}}' http://198.51.100.10:9876/v2.0/lbaas/flavorprofiles/5712097e-0092-45dc-bff0-ab68b61ad51a diff --git a/api-ref/source/v2/examples/flavorprofile-update-request.json b/api-ref/source/v2/examples/flavorprofile-update-request.json new file mode 100644 index 0000000000..c9b2a62218 --- /dev/null +++ b/api-ref/source/v2/examples/flavorprofile-update-request.json @@ -0,0 +1,8 @@ +{ + "flavorprofile": + { + "name": "amphora-standalone", + "provider_name": "amphora", + "flavor_data": "{\"loadbalancer_topology\": \"SINGLE\"}" + } +} diff --git a/api-ref/source/v2/examples/flavorprofile-update-response.json b/api-ref/source/v2/examples/flavorprofile-update-response.json new file mode 100644 index 0000000000..fa245412b5 --- /dev/null +++ b/api-ref/source/v2/examples/flavorprofile-update-response.json @@ -0,0 +1,9 @@ +{ + "flavorprofile": + { + "id": "5712097e-0092-45dc-bff0-ab68b61ad51a", + "name": "amphora-standalone", + "provider_name": "amphora", + "flavor_data": "{\"loadbalancer_topology\": \"SINGLE\"}" + } +} diff --git a/api-ref/source/v2/examples/flavorprofiles-list-response.json b/api-ref/source/v2/examples/flavorprofiles-list-response.json new file mode 100644 index 0000000000..79caee2e0b --- /dev/null +++ b/api-ref/source/v2/examples/flavorprofiles-list-response.json @@ -0,0 +1,10 @@ +{ + "flavorprofiles": [ + { + "id": "5712097e-0092-45dc-bff0-ab68b61ad51a", + "name": "amphora-act-stdby", + "provider_name": "amphora", + "flavor_data": "{\"loadbalancer_topology\": \"ACTIVE_STANDBY\"}" + } + ] +} diff --git a/api-ref/source/v2/examples/flavors-list-response.json b/api-ref/source/v2/examples/flavors-list-response.json new file mode 100644 index 0000000000..f7a68c6676 --- /dev/null +++ b/api-ref/source/v2/examples/flavors-list-response.json @@ -0,0 +1,11 @@ +{ + "flavors": [ + { + "id": "8f94060c-8d5b-4472-9cfd-e8a2b909481d", + "name": "Basic", + "description": "A basic standalone Octavia load balancer.", + "enabled": true, + "flavor_profile_id": "5712097e-0092-45dc-bff0-ab68b61ad51a" + } + ] +} diff --git a/api-ref/source/v2/flavor.inc b/api-ref/source/v2/flavor.inc new file mode 100644 index 0000000000..335004bd9a --- /dev/null +++ b/api-ref/source/v2/flavor.inc @@ -0,0 +1,295 @@ +.. -*- rst -*- + +List Flavors +============ + +.. rest_method:: GET /v2.0/lbaas/flavors + +List all available flavors. + +Use the ``fields`` query parameter to control which fields are +returned in the response body. Additionally, you can filter results +by using query string parameters. For information, see :ref:`filtering`. + +The list might be empty. + +**New in version 2.6** + +.. rest_status_code:: success ../http-status.yaml + + - 200 + +.. rest_status_code:: error ../http-status.yaml + + - 400 + - 401 + - 500 + +Request +------- + +.. rest_parameters:: ../parameters.yaml + + - fields: fields + +Curl Example +------------ + +.. literalinclude:: examples/flavor-list-curl + :language: bash + +Response Parameters +------------------- + +.. rest_parameters:: ../parameters.yaml + + - description: description + - enabled: enabled + - flavor_profile_id: flavor-profile-id + - flavors: flavors + - id: flavor-id + - name: name + +Response Example +---------------- + +.. literalinclude:: examples/flavors-list-response.json + :language: javascript + +Create Flavor +============= + +.. rest_method:: POST /v2.0/lbaas/flavors + +Creates a flavor. + +If the API cannot fulfill the request due to insufficient data or +data that is not valid, the service returns the HTTP ``Bad Request +(400)`` response code with information about the failure in the +response body. Validation errors require that you correct the error +and submit the request again. + +If you are not an administrative user the service returns the HTTP ``Forbidden +(403)`` response code. + +**New in version 2.6** + +.. rest_status_code:: success ../http-status.yaml + + - 201 + +.. rest_status_code:: error ../http-status.yaml + + - 400 + - 401 + - 403 + - 500 + +Request +------- + +.. rest_parameters:: ../parameters.yaml + + - description: description-optional + - enabled: enabled-optional + - flavor: flavor + - flavor_profile_id: flavor-profile-id + - name: name + +Request Example +---------------- + +.. literalinclude:: examples/flavor-create-request.json + :language: javascript + +Curl Example +------------ + +.. literalinclude:: examples/flavor-create-curl + :language: bash + +Response Parameters +------------------- + +.. rest_parameters:: ../parameters.yaml + + - description: description + - enabled: enabled + - flavor_profile_id: flavor-profile-id + - flavor: flavor + - id: flavor-id + - name: name + +Response Example +---------------- + +.. literalinclude:: examples/flavor-create-response.json + :language: javascript + + +Show Flavor Details +=================== + +.. rest_method:: GET /v2.0/lbaas/flavors/{flavor_id} + +Shows the details of a flavor. + +Use the ``fields`` query parameter to control which fields are +returned in the response body. Additionally, you can filter results +by using query string parameters. For information, see :ref:`filtering`. + +This operation does not require a request body. + +**New in version 2.6** + +.. rest_status_code:: success ../http-status.yaml + + - 200 + +.. rest_status_code:: error ../http-status.yaml + + - 401 + - 404 + - 500 + +Request +------- + +.. rest_parameters:: ../parameters.yaml + + - fields: fields + - flavor_id: path-flavor-id + +Curl Example +------------ + +.. literalinclude:: examples/flavor-show-curl + :language: bash + +Response Parameters +------------------- + +.. rest_parameters:: ../parameters.yaml + + - description: description + - enabled: enabled + - flavor_profile_id: flavor-profile-id + - flavor: flavor + - id: flavor-id + - name: name + +Response Example +---------------- + +.. literalinclude:: examples/flavor-show-response.json + :language: javascript + +Update a Flavor +=============== + +.. rest_method:: PUT /v2.0/lbaas/flavors/{flavor_id} + +Update a flavor. + +If you are not an administrative user the service returns the HTTP ``Forbidden +(403)`` response code. + +**New in version 2.6** + +.. rest_status_code:: success ../http-status.yaml + + - 200 + +.. rest_status_code:: error ../http-status.yaml + + - 400 + - 401 + - 403 + - 404 + - 500 + +Request +------- + +.. rest_parameters:: ../parameters.yaml + + - description: description-optional + - enabled: enabled-optional + - flavor: flavor + - flavor_id: path-flavor-id + - name: name-optional + +Request Example +--------------- + +.. literalinclude:: examples/flavor-update-request.json + :language: javascript + +Curl Example +------------ + +.. literalinclude:: examples/flavor-update-curl + :language: bash + +Response Parameters +------------------- + +.. rest_parameters:: ../parameters.yaml + + - description: description + - enabled: enabled + - flavor_profile_id: flavor-profile-id + - flavor: flavor + - id: flavor-id + - name: name + +Response Example +---------------- + +.. literalinclude:: examples/flavor-update-response.json + :language: javascript + +Remove a Flavor +=============== + +.. rest_method:: DELETE /v2.0/lbaas/flavors/{flavor_id} + +Remove a flavor and its associated configuration. + +If any load balancers are using this flavor the service returns the HTTP +``Conflict (409)`` response code. + +If you are not an administrative user the service returns the HTTP ``Forbidden +(403)`` response code. + +**New in version 2.6** + +.. rest_status_code:: success ../http-status.yaml + + - 204 + +.. rest_status_code:: error ../http-status.yaml + + - 401 + - 403 + - 404 + - 409 + - 500 + +Request +------- + +.. rest_parameters:: ../parameters.yaml + + - flavor_id: path-flavor-id + +Curl Example +------------ + +.. literalinclude:: examples/flavor-delete-curl + :language: bash + +Response +-------- + +There is no body content for the response of a successful DELETE request. diff --git a/api-ref/source/v2/flavorprofile.inc b/api-ref/source/v2/flavorprofile.inc new file mode 100644 index 0000000000..27f7a09d68 --- /dev/null +++ b/api-ref/source/v2/flavorprofile.inc @@ -0,0 +1,297 @@ +.. -*- rst -*- + +List Flavor Profiles +==================== + +.. rest_method:: GET /v2.0/lbaas/flavorprofiles + +List all available flavor profiles. + +Use the ``fields`` query parameter to control which fields are +returned in the response body. Additionally, you can filter results +by using query string parameters. For information, see :ref:`filtering`. + +If you are not an administrative user the service returns the HTTP ``Forbidden +(403)`` response code. + +The list might be empty. + +**New in version 2.6** + +.. rest_status_code:: success ../http-status.yaml + + - 200 + +.. rest_status_code:: error ../http-status.yaml + + - 400 + - 401 + - 403 + - 500 + +Request +------- + +.. rest_parameters:: ../parameters.yaml + + - fields: fields + +Curl Example +------------ + +.. literalinclude:: examples/flavor-profile-list-curl + :language: bash + +Response Parameters +------------------- + +.. rest_parameters:: ../parameters.yaml + + - flavor_data: flavor-data + - flavorprofiles: flavorprofiles + - id: flavor-profile-id + - name: name + - provider_name: provider-name + +Response Example +---------------- + +.. literalinclude:: examples/flavorprofiles-list-response.json + :language: javascript + +Create Flavor Profile +===================== + +.. rest_method:: POST /v2.0/lbaas/flavorprofiles + +Creates a flavor profile. + +If the API cannot fulfill the request due to insufficient data or +data that is not valid, the service returns the HTTP ``Bad Request +(400)`` response code with information about the failure in the +response body. Validation errors require that you correct the error +and submit the request again. + +If you are not an administrative user the service returns the HTTP ``Forbidden +(403)`` response code. + +**New in version 2.6** + +.. rest_status_code:: success ../http-status.yaml + + - 201 + +.. rest_status_code:: error ../http-status.yaml + + - 400 + - 401 + - 403 + - 500 + +Request +------- + +.. rest_parameters:: ../parameters.yaml + + - flavor_data: flavor-data + - flavorprofile: flavorprofile + - name: name + - provider_name: provider-name + +Request Example +---------------- + +.. literalinclude:: examples/flavorprofile-create-request.json + :language: javascript + +Curl Example +------------ + +.. literalinclude:: examples/flavorprofile-create-curl + :language: bash + +Response Parameters +------------------- + +.. rest_parameters:: ../parameters.yaml + + - flavor_data: flavor-data + - flavorprofile: flavorprofile + - id: flavor-profile-id + - name: name + - provider_name: provider-name + +Response Example +---------------- + +.. literalinclude:: examples/flavorprofile-create-response.json + :language: javascript + +Show Flavor Profile Details +=========================== + +.. rest_method:: GET /v2.0/lbaas/flavorprofiles/{flavorprofile_id} + +Shows the details of a flavor profile. + +Use the ``fields`` query parameter to control which fields are +returned in the response body. Additionally, you can filter results +by using query string parameters. For information, see :ref:`filtering`. + +If you are not an administrative user the service returns the HTTP ``Forbidden +(403)`` response code. + +This operation does not require a request body. + +**New in version 2.6** + +.. rest_status_code:: success ../http-status.yaml + + - 200 + +.. rest_status_code:: error ../http-status.yaml + + - 401 + - 403 + - 404 + - 500 + +Request +------- + +.. rest_parameters:: ../parameters.yaml + + - fields: fields + - flavorprofile_id: path-flavorprofile-id + +Curl Example +------------ + +.. literalinclude:: examples/flavorprofile-show-curl + :language: bash + +Response Parameters +------------------- + +.. rest_parameters:: ../parameters.yaml + + - flavor_data: flavor-data + - flavorprofile: flavorprofile + - id: flavor-profile-id + - name: name + - provider_name: provider-name + +Response Example +---------------- + +.. literalinclude:: examples/flavorprofile-show-response.json + :language: javascript + +Update a Flavor Profile +======================= + +.. rest_method:: PUT /v2.0/lbaas/flavorprofiles/{flavorprofile_id} + +Update a flavor profile. + +If you are not an administrative user the service returns the HTTP ``Forbidden +(403)`` response code. + +**New in version 2.6** + +.. rest_status_code:: success ../http-status.yaml + + - 200 + +.. rest_status_code:: error ../http-status.yaml + + - 400 + - 401 + - 403 + - 404 + - 500 + +Request +------- + +.. rest_parameters:: ../parameters.yaml + + - flavor_data: flavor-data-optional + - flavorprofile: flavorprofile + - flavorprofile_id: path-flavorprofile-id + - name: name-optional + - provider_name: provider-name-optional + +Request Example +--------------- + +.. literalinclude:: examples/flavorprofile-update-request.json + :language: javascript + +Curl Example +------------ + +.. literalinclude:: examples/flavorprofile-update-curl + :language: bash + +Response Parameters +------------------- + +.. rest_parameters:: ../parameters.yaml + + - flavor_data: flavor-data + - flavorprofile: flavorprofile + - id: flavor-profile-id + - name: name + - provider_name: provider-name + +Response Example +---------------- + +.. literalinclude:: examples/flavorprofile-update-response.json + :language: javascript + +Remove a Flavor Profile +======================= + +.. rest_method:: DELETE /v2.0/lbaas/flavorprofiles/{flavorprofile_id} + +Remove a flavor profile and its associated configuration. + +If any flavors using this flavor profile the service returns the HTTP +``Conflict (409)`` response code. + +If you are not an administrative user the service returns the HTTP ``Forbidden +(403)`` response code. + +**New in version 2.6** + +.. rest_status_code:: success ../http-status.yaml + + - 204 + +.. rest_status_code:: error ../http-status.yaml + + - 401 + - 403 + - 404 + - 409 + - 500 + +Request +------- + +.. rest_parameters:: ../parameters.yaml + + - flavorprofile_id: path-flavorprofile-id + +Curl Example +------------ + +.. literalinclude:: examples/flavorprofile-delete-curl + :language: bash + +Response +-------- + +There is no body content for the response of a successful DELETE request. diff --git a/api-ref/source/v2/index.rst b/api-ref/source/v2/index.rst index ff6c03fdcb..20acf575a4 100644 --- a/api-ref/source/v2/index.rst +++ b/api-ref/source/v2/index.rst @@ -56,6 +56,16 @@ Providers --------- .. include:: provider.inc +------- +Flavors +------- +.. include:: flavor.inc + +--------------- +Flavor Profiles +--------------- +.. include:: flavorprofile.inc + -------- Amphorae --------