Release Proposal: v2.14

README.md

@@ -2,16 +2,16 @@
 
 ![Open Service Broker API](https://github.com/openservicebrokerapi/servicebroker/blob/master/logo.png?raw=true)
 
-## Latest Release: v2.13
-[Specification](https://github.com/openservicebrokerapi/servicebroker/blob/v2.13/spec.md)
+## Latest Release: v2.14
+[Specification](https://github.com/openservicebrokerapi/servicebroker/blob/v2.14/spec.md)
 
-[OpenAPI doc](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/openservicebrokerapi/servicebroker/v2.13/openapi.yaml)
+[OpenAPI doc](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/openservicebrokerapi/servicebroker/v2.14/openapi.yaml)
 
-[Profile](https://github.com/openservicebrokerapi/servicebroker/blob/v2.13/profile.md)
+[Profile](https://github.com/openservicebrokerapi/servicebroker/blob/v2.14/profile.md)
 
 [Workflows](diagram.md)
 
-[Release notes](https://github.com/openservicebrokerapi/servicebroker/blob/v2.13/release-notes.md)
+[Release notes](https://github.com/openservicebrokerapi/servicebroker/blob/v2.14/release-notes.md)
 
 ## Working Changes (might contain changes that are not yet released)
 Changes in these documents have been accepted by the working group for the next
@@ -46,4 +46,3 @@ wanting to implement a Platform or Service Broker.
 The [Platform Compatibility](compatibility.md) document is a quick way to track
 the state of current and pending feature additions, how they align with
 releases, and which platforms are currently supporting them.
-

diagram.md

@@ -1,4 +1,4 @@
-# Open Service Broker API v2.13 Workflows
+# Open Service Broker API v2.14 Workflows
 
 ![Workflows](https://docs.google.com/drawings/d/e/2PACX-1vQhhzTYSje1CBCP85pg4z7_tuAdEkt3gvLpRBCzCrGzdrPqqDWwWsh3kEuM3Zc6lKamgTisrOUp7tL7/pub?w=1008&h=4680)
 

openapi.yaml

@@ -85,7 +85,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ServiceInstanceAsyncProvision'
+                $ref: '#/components/schemas/ServiceInstanceAsyncOperation'
         '400':
           description: Bad Request
           content:
@@ -142,7 +142,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/AsyncOperation'
+                $ref: '#/components/schemas/ServiceInstanceAsyncOperation'
         '400':
           description: Bad Request
           content:
@@ -280,7 +280,62 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ServiceInstanceLastOperation'
+                $ref: '#/components/schemas/LastOperationResource'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '410':
+          description: Gone
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+
+  /v2/service_instances/{instance_id}/service_bindings/{binding_id}/last_operation:
+    get:
+      summary: last requested operation state for service binding
+      tags:
+        - ServiceBindings
+      operationId: serviceBinding.lastOperation.get
+      parameters:
+        - $ref: '#/components/parameters/APIVersion'
+        - name: instance_id
+          in: path
+          description: instance id of instance to find last operation applied to it
+          required: true
+          schema:
+            type: string
+        - name: binding_id
+          in: path
+          description: binding id of service binding to find last operation applied to it
+          required: true
+          schema:
+            type: string
+        - name: service_id
+          in: query
+          description: id of the service associated with the instance
+          schema:
+            type: string
+        - name: plan_id
+          in: query
+          description: id of the plan associated with the instance
+          schema:
+            type: string
+        - name: operation
+          in: query
+          description: a provided identifier for the operation
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/LastOperationResource'
         '400':
           description: Bad Request
           content:
@@ -315,6 +370,11 @@ paths:
           required: true
           schema:
             type: string
+        - name: accepts_incomplete
+          in: query
+          description: asynchronous operations supported
+          schema:
+            type: boolean
       requestBody:
         description: parameters for the requested service binding
         required: true
@@ -335,6 +395,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ServiceBinding'
+        '202':
+          description: Accepted
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AsyncOperation'
         '400':
           description: Bad Request
           content:
@@ -385,13 +451,24 @@ paths:
           required: true
           schema:
             type: string
+        - name: accepts_incomplete
+          in: query
+          description: asynchronous operations supported
+          schema:
+            type: boolean
       responses:
         '200':
           description: OK
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Object'
+        '202':
+          description: Accepted
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AsyncOperation'
         '400':
           description: Bad Request
           content:
@@ -610,7 +687,7 @@ components:
         dashboard_url:
           type: string
 
-    ServiceInstanceAsyncProvision:
+    ServiceInstanceAsyncOperation:
       type: object
       properties:
         dashboard_url:
@@ -655,7 +732,7 @@ components:
         operation:
           type: string
 
-    ServiceInstanceLastOperation:
+    LastOperationResource:
       type: object
       required:
         - state

release-notes.md

@@ -1,5 +1,61 @@
 # Service Broker API Release Notes
 
+## [v2.14](https://github.com/openservicebrokerapi/servicebroker/blob/v2.14/spec.md)
+2018-07-24
+
+* Added GET endpoints for fetching a
+  [Service Instance](https://github.com/openservicebrokerapi/servicebroker/blob/v2.14/spec.md#fetching-a-service-instance)
+  and
+  [Service Binding](https://github.com/openservicebrokerapi/servicebroker/blob/v2.14/spec.md#fetching-a-service-binding)
+* Added support for asynchronous Service Bindings
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/334))
+  and a new
+  [last operation endpoint for Service Bindings](https://github.com/openservicebrokerapi/servicebroker/blob/v2.14/spec.md#polling-last-operation-for-service-bindings)
+  endpoint
+* Added clarity around concurrent updates
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/300))
+* Added clarity on how Platform's can clean up after a failed provision or bind
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/353))
+* Added Opaque Bearer Tokens to the
+  [Platform to Service Broker Authentication](https://github.com/openservicebrokerapi/servicebroker/blob/v2.14/spec.md#platform-to-service-broker-authentication)
+  section
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/398))
+* Provided guidance for CLI-friendly names
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/425))
+* Allow for uppercase characters in Service and Service Plan names
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/433))
+* Clarify that extra fields in requests and responses are allowed
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/436))
+* Allow an updated `dashboard_url` to be provided when updating a Service
+  Instance ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/437))
+* Added an [OpenAPI 2.0 implementation](https://github.com/openservicebrokerapi/servicebroker/blob/v2.14/openapi.yaml)
+* Allow for periods in name fields
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/452))
+* Removed the need for Platforms to perform orphan mitigation when receiving an
+  `HTTP 408` response code
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/456))
+* Moved the `dashboard_client` field to
+  [Cloud Foundry Catalog Extensions](https://github.com/openservicebrokerapi/servicebroker/blob/v2.14/profile.md#cloud-foundry-catalog-extensions)
+* Added a [compatibility matrix](https://github.com/openservicebrokerapi/servicebroker/blob/v2.14/compatibility.md)
+  describing which optional features in the specification are supported by
+  different Platforms
+* Added clarity for returning Service Binding information via the GET endpoints
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/517))
+* Added guidance for supported string lengths
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/518))
+* Clarified that the `plan_updateable` field affects modifying the Service Plan,
+  not parameters ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/519))
+* Clarified which Service Plan ID to use for polling the last operation endpoint
+  after an update ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/522))
+* Clarified Platform behaviour when a dashboard URL is not returned
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/527))
+* Fixed an incompatible change introduced in v2.12
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/540))
+* Added clarity around the state of resources after a failure
+  ([PR](https://github.com/openservicebrokerapi/servicebroker/pull/541))
+* Added [Content Type](https://github.com/openservicebrokerapi/servicebroker/blob/v2.14/spec.md#content-type)
+  guidelines
+
 ## [v2.13](https://github.com/openservicebrokerapi/servicebroker/blob/v2.13/spec.md)
 2017-09-19