diff --git a/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl b/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl index 49f2e4dbf..b48425300 100644 --- a/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl @@ -288,11 +288,80 @@ - Updates a specified image. (Since - Image API v2.0.) + + Updates a specified image. (Since Image API v2.0.) - Request body must conform to one of the following - media types: + + Depending on the referenced target location, this operation + performs one of the following functions: + + + + + The target location is an array index. A new value is + inserted into the array at the specified index. + + + + + The target location is an object member that does not + exist. A new member is added to the object. + + + + + The target location is an object member that exists. + The member value is replaced. + + + + + The operation object MUST contain a value member that + specifies the value to add. For example: + +{ + "op": "add", + "path": "/a/b/c", + "value": [ + "foo", + "bar" + ] +} + + The target location MUST reference one of these values: + + + + + The root of the target document. The specified value is the + entire content of the target document. + + + + + A member to add to an object. The specified value is added + to that object at the specified location. If the member + already exists, it is replaced by the specified value. + + + + + An element to add to the array. The specified value is added + to the array at the specified location. Any element that is + at or above the specified index is shifted one position to + the right. The specified index MUST NOT be greater than the + number of elements in the array. If the hyphen (-) character + is used to index the end of the array (see [RFC6901]), the + value is appended to the array. + + + + + Because this operation adds to existing objects and arrays, its + target location often does not exist. + + + The request body must conform to one of the following media types: @@ -304,51 +373,52 @@ - You can also use the &PATCH; method to add or remove - image properties. + + You can also use the &PATCH; method to add or remove image + properties. - For information about the &PATCH; method and the available - media types, see - - Image - API v2 HTTP PATCH media types. + For information about the &PATCH; method and the available media + types, see Image API v2 + HTTP PATCH media types. Preconditions - When adding or replacing a new location - to the specified image, you must set the disk_format - and container_format parameters in the image. + + When you add or replace a location to the specified image, + you must set the disk_format and + container_format parameters in the image. - When locations of the specified image - is replaced by replacing operation, the old location - must be set in the image on ahead. + + When you replace a location, a location must be previously + set in the image. Synchronous Postconditions - With correct permissions, you can see - the updated values of the image's attributes. - - - - With correct permissions, you can see - the image status as active through API calls - after adding a location to the image which had no - location. + + With correct permissions, you can view the updated values of + the attributes of the image. - With correct permissions, you can see the image status as - queued through API calls after removing all - locations from the image. + After you add a location to an image that had no location + and with correct permissions, you can use API calls to view + the image status as active. + + + + + After you remove all locations from the image and with + correct permissions, you can use API calls to view the image + status as queued. @@ -356,10 +426,10 @@ - If you cannot update locations, your request might lack - some information. Ensure that you meet the preconditions - and run the request again. If the request fails again, - review your API request. + If you cannot update locations, your request might + be missing some information. Make sure that you meet + the preconditions and run the request again. If the + request fails again, review your API request.