Merge branch 'master' into change-which-field-acts-as-an-identity-for-maintenance-info-object

Author: waterlink

openapi.yaml

@@ -619,6 +619,8 @@ components:
           type: string
         metadata:
           $ref: '#/components/schemas/Metadata'
+        maintenance_info:
+          $ref: '#/components/schemas/MaintenanceInfo'
         free:
           type: boolean
           default: true
@@ -887,6 +889,16 @@ components:
       description: "See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details."
       type: object
 
+    MaintenanceInfo:
+      type: object
+      required:
+        - version
+      properties:
+        version:
+          type: string
+        description:
+          type: string
+
     Object:
       type: object
 

spec.md

@@ -547,7 +547,8 @@ schema being used.
 
 | Response Field | Type | Description |
 | --- | --- | --- |
-| version* | string | This MUST be a string conforming to a semantic version. The Platform MAY use this field to determine whether an update is available for a Service Instance. |
+| version* | string | This MUST be a string conforming to a semantic version. The Platform MAY use this field to determine whether a maintenance update is available for a Service Instance. |
+| description | string | This SHOULD be a string describing the impact of the maintenance update, for example, important version changes, configuration changes, default value changes, etc. The Platform MAY present this information to the user before they trigger the maintenance update. |
 
 \* Fields with an asterisk are REQUIRED.
 
@@ -646,6 +647,7 @@ schema being used.
       },
       "maintenance_info": {
         "version": "2.1.1+abcdef",
+        "description": "OS image update.\nExpect downtime."
       }
     }, {
       "name": "fake-plan-2",

swagger.yaml

@@ -748,6 +748,8 @@ definitions:
     properties:
       version:
         type: string
+      description:
+        type: string
   Context:
     description: >-
       See [Context