Merge "Add flavor-based reservations to API reference"

api-ref/source/v1/leases.inc

@@ -85,6 +85,24 @@ Parameters for Instance Reservation
 The following parameters are returned for instance reservation. All parameters
 are in the ``reservation`` object.
 
+.. rest_parameters:: parameters.yaml
+
+  - reservation.amount: reservation_amount
+  - reservation.vcpus: reservation_vcpus
+  - reservation.memory_mb: reservation_memory_mb
+  - reservation.disk_gb: reservation_disk_gb
+  - reservation.affinity : reservation_affinity
+  - reservation.resource_properties: reservation_resource_properties
+  - reservation.flavor_id: reservation_flavor_id
+  - reservation.server_group_id: reservation_server_group_id
+  - reservation.aggregate_id: reservation_aggregate_id
+
+Parameters for Flavor-based Instance Reservation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The following parameters are returned for flavor-based instance reservation.
+All parameters are in the ``reservation`` object.
+
 .. rest_parameters:: parameters.yaml
 
   - reservation.amount: reservation_amount
@@ -161,6 +179,19 @@ are in the ``reservation`` object.
   - reservation.affinity : reservation_affinity
   - reservation.resource_properties: reservation_resource_properties
 
+Parameters for Flavor-based Instance Reservation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The following parameters are required for flavor-based instance reservation.
+All parameters are in the ``reservation`` object.
+
+.. rest_parameters:: parameters.yaml
+
+  - reservation.amount: reservation_amount
+  - reservation.flavor_id: reservation_flavor_id
+  - reservation.affinity : reservation_affinity
+  - reservation.resource_properties: reservation_resource_properties
+
 **Example of Create Lease Request**
 
 .. literalinclude:: ../../../doc/api_samples/leases/lease-create-req.json
@@ -225,6 +256,21 @@ Parameters for Instance Reservation
 The following parameters are returned for instance reservation. All parameters
 are in the ``reservation`` object.
 
+.. rest_parameters:: parameters.yaml
+
+  - reservation.amount: reservation_amount
+  - reservation.vcpus: reservation_vcpus
+  - reservation.memory_mb: reservation_memory_mb
+  - reservation.disk_gb: reservation_disk_gb
+  - reservation.affinity : reservation_affinity
+  - reservation.resource_properties: reservation_resource_properties
+  - reservation.flavor_id: reservation_flavor_id
+  - reservation.server_group_id: reservation_server_group_id
+  - reservation.aggregate_id: reservation_aggregate_id
+
+Parameters for Flavor-based Instance Reservation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 .. rest_parameters:: parameters.yaml
 
   - reservation.amount: reservation_amount
@@ -326,6 +372,21 @@ Parameters for Instance Reservation
 The following parameters are returned for instance reservation. All parameters
 are in the ``reservation`` object.
 
+.. rest_parameters:: parameters.yaml
+
+  - reservation.amount: reservation_amount
+  - reservation.vcpus: reservation_vcpus
+  - reservation.memory_mb: reservation_memory_mb
+  - reservation.disk_gb: reservation_disk_gb
+  - reservation.affinity : reservation_affinity
+  - reservation.resource_properties: reservation_resource_properties
+  - reservation.flavor_id: reservation_flavor_id
+  - reservation.server_group_id: reservation_server_group_id
+  - reservation.aggregate_id: reservation_aggregate_id
+
+Parameters for Flavor-based Instance Reservation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 .. rest_parameters:: parameters.yaml
 
   - reservation.amount: reservation_amount
@@ -406,6 +467,12 @@ are in the ``reservation`` object.
   - reservation.affinity : reservation_affinity_optional
   - reservation.resource_properties: reservation_resource_properties_optional
 
+Parameters for Flavor-based Instance Reservation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Lease updates are not currently supported for flavor-based instance
+reservations.
+
 **Example of Update Lease Request**
 
 .. literalinclude:: ../../../doc/api_samples/leases/lease-update-req.json
@@ -482,6 +549,12 @@ are in the ``reservation`` object.
   - reservation.server_group_id: reservation_server_group_id
   - reservation.aggregate_id: reservation_aggregate_id
 
+Parameters for Flavor-based Instance Reservation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Lease updates are not currently supported for flavor-based instance
+reservations.
+
 **Example of Update Lease Response**
 
 .. literalinclude:: ../../../doc/api_samples/leases/lease-update-resp.json