Skip to content

Commit db6924d

Browse files
royclarksonroyclarkson
committed
Add Since OSB API version tags to core javadoc
Document which Open Service Broker API spec version introduced each field, method, and endpoint across model, exception, controller, and service classes, and point spec links at the v2.16 tag instead of master so they don't drift as the spec evolves. Signed-off-by: Roy Clarkson <roy.clarkson@broadcom.com>
1 parent 9749380 commit db6924d

73 files changed

Lines changed: 714 additions & 59 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎spring-cloud-open-service-broker-core/src/main/java/org/springframework/cloud/servicebroker/controller/CatalogController.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* @author Scott Frederick
3636
* @author Roy Clarkson
3737
* @see <a href=
38-
* "https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#catalog-management">Open
38+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#catalog-management">Open
3939
* Service Broker API specification</a>
4040
*/
4141
@ServiceBrokerRestController

‎spring-cloud-open-service-broker-core/src/main/java/org/springframework/cloud/servicebroker/controller/ServiceInstanceBindingController.java‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
* @author Scott Frederick
5858
* @author Roy Clarkson
5959
* @see <a href=
60-
* "https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#binding">Open
60+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#binding">Open
6161
* Service Broker API specification</a>
6262
*/
6363
@ServiceBrokerRestController
@@ -106,6 +106,9 @@ public ServiceInstanceBindingController(CatalogService catalogService,
106106
* @param requestIdentity identity of the request sent from the platform
107107
* @param request the request body
108108
* @return the response
109+
* @see <a href=
110+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#binding">Open
111+
* Service Broker API specification: Binding</a>
109112
*/
110113
@PutMapping({ PLATFORM_PATH_MAPPING, PATH_MAPPING })
111114
public Mono<ResponseEntity<CreateServiceInstanceBindingResponse>> createServiceInstanceBinding(
@@ -172,6 +175,8 @@ else if (response.isBindingExisted()) {
172175

173176
/**
174177
* REST controller for getting a service instance binding.
178+
* <p>
179+
* Since OSB API 2.14.
175180
* @param pathVariables the path variables
176181
* @param serviceInstanceId the service instance ID
177182
* @param bindingId the service binding ID
@@ -182,6 +187,9 @@ else if (response.isBindingExisted()) {
182187
* from the platform
183188
* @param requestIdentity identity of the request sent from the platform
184189
* @return the response
190+
* @see <a href=
191+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#fetching-a-service-binding">Open
192+
* Service Broker API specification: Fetching a Service Binding</a>
185193
*/
186194
@GetMapping({ PLATFORM_PATH_MAPPING, PATH_MAPPING })
187195
public Mono<ResponseEntity<GetServiceInstanceBindingResponse>> getServiceInstanceBinding(
@@ -238,6 +246,8 @@ public Mono<ResponseEntity<GetServiceInstanceBindingResponse>> getServiceInstanc
238246

239247
/**
240248
* REST Controller for getting the last operation of a service instance binding.
249+
* <p>
250+
* Since OSB API 2.14.
241251
* @param pathVariables the path variables
242252
* @param serviceInstanceId the service instance ID
243253
* @param bindingId the service binding ID
@@ -249,6 +259,9 @@ public Mono<ResponseEntity<GetServiceInstanceBindingResponse>> getServiceInstanc
249259
* from the platform
250260
* @param requestIdentity identity of the request sent from the platform
251261
* @return the response
262+
* @see <a href=
263+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#polling-last-operation-for-service-bindings">Open
264+
* Service Broker API specification: Polling Last Operation for Service Bindings</a>
252265
*/
253266
@GetMapping({ PLATFORM_PATH_MAPPING + "/last_operation", PATH_MAPPING + "/last_operation" })
254267
public Mono<ResponseEntity<GetLastServiceBindingOperationResponse>> getServiceInstanceBindingLastOperation(
@@ -330,6 +343,9 @@ else if (e instanceof ServiceInstanceDoesNotExistException) {
330343
* from the platform
331344
* @param requestIdentity identity of the request sent from the platform
332345
* @return the response
346+
* @see <a href=
347+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#unbinding">Open
348+
* Service Broker API specification: Unbinding</a>
333349
*/
334350
@DeleteMapping({ PLATFORM_PATH_MAPPING, PATH_MAPPING })
335351
public Mono<ResponseEntity<DeleteServiceInstanceBindingResponse>> deleteServiceInstanceBinding(

‎spring-cloud-open-service-broker-core/src/main/java/org/springframework/cloud/servicebroker/controller/ServiceInstanceController.java‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
* @author Scott Frederick
5959
* @author Roy Clarkson
6060
* @see <a href=
61-
* "https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#provisioning">Open
61+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#provisioning">Open
6262
* Service Broker API specification</a>
6363
*/
6464
@ServiceBrokerRestController
@@ -103,6 +103,9 @@ public ServiceInstanceController(CatalogService catalogService, ServiceInstanceS
103103
* @param requestIdentity identity of the request sent from the platform
104104
* @param request the request body
105105
* @return the response
106+
* @see <a href=
107+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#provisioning">Open
108+
* Service Broker API specification: Provisioning</a>
106109
*/
107110
@PutMapping({ PLATFORM_PATH_MAPPING, PATH_MAPPING })
108111
public Mono<ResponseEntity<CreateServiceInstanceResponse>> createServiceInstance(
@@ -166,6 +169,8 @@ else if (response.isInstanceExisted()) {
166169

167170
/**
168171
* REST controller for getting a service instance.
172+
* <p>
173+
* Since OSB API 2.14.
169174
* @param pathVariables the path variables
170175
* @param serviceInstanceId the service instance ID
171176
* @param serviceDefinitionId the service definition ID
@@ -175,6 +180,9 @@ else if (response.isInstanceExisted()) {
175180
* from the platform
176181
* @param requestIdentity identity of the request sent from the platform
177182
* @return the response
183+
* @see <a href=
184+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#fetching-a-service-instance">Open
185+
* Service Broker API specification: Fetching a Service Instance</a>
178186
*/
179187
@GetMapping({ PLATFORM_PATH_MAPPING, PATH_MAPPING })
180188
public Mono<ResponseEntity<GetServiceInstanceResponse>> getServiceInstance(
@@ -228,6 +236,8 @@ public Mono<ResponseEntity<GetServiceInstanceResponse>> getServiceInstance(
228236

229237
/**
230238
* REST controller for getting the last operation of a service instance.
239+
* <p>
240+
* Since OSB API 2.7.
231241
* @param pathVariables the path variables
232242
* @param serviceInstanceId the service instance ID
233243
* @param serviceDefinitionId the service definition ID
@@ -238,6 +248,9 @@ public Mono<ResponseEntity<GetServiceInstanceResponse>> getServiceInstance(
238248
* from the platform
239249
* @param requestIdentity identity of the request sent from the platform
240250
* @return the response
251+
* @see <a href=
252+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#polling-last-operation-for-service-instances">Open
253+
* Service Broker API specification: Polling Last Operation for Service Instances</a>
241254
*/
242255
@GetMapping({ PLATFORM_PATH_MAPPING + "/last_operation", PATH_MAPPING + "/last_operation" })
243256
public Mono<ResponseEntity<GetLastServiceOperationResponse>> getServiceInstanceLastOperation(
@@ -310,6 +323,9 @@ public Mono<ResponseEntity<GetLastServiceOperationResponse>> getServiceInstanceL
310323
* from the platform
311324
* @param requestIdentity identity of the request sent from the platform
312325
* @return the response
326+
* @see <a href=
327+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#deprovisioning">Open
328+
* Service Broker API specification: Deprovisioning</a>
313329
*/
314330
@DeleteMapping({ PLATFORM_PATH_MAPPING, PATH_MAPPING })
315331
public Mono<ResponseEntity<DeleteServiceInstanceResponse>> deleteServiceInstance(
@@ -376,6 +392,9 @@ public Mono<ResponseEntity<DeleteServiceInstanceResponse>> deleteServiceInstance
376392
* @param requestIdentity identity of the request sent from the platform
377393
* @param request the request body
378394
* @return the response
395+
* @see <a href=
396+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#updating-a-service-instance">Open
397+
* Service Broker API specification: Updating a Service Instance</a>
379398
*/
380399
@PatchMapping({ PLATFORM_PATH_MAPPING, PATH_MAPPING })
381400
public Mono<ResponseEntity<UpdateServiceInstanceResponse>> updateServiceInstance(

‎spring-cloud-open-service-broker-core/src/main/java/org/springframework/cloud/servicebroker/exception/ServiceBrokerApiVersionException.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@
2525
* {@literal 412 PRECONDITION FAILED} being returned to the platform.
2626
*
2727
* @author Scott Frederick
28+
* @see <a href=
29+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#api-version-header">Open
30+
* Service Broker API specification</a>
2831
*/
2932
public class ServiceBrokerApiVersionException extends ServiceBrokerException {
3033

‎spring-cloud-open-service-broker-core/src/main/java/org/springframework/cloud/servicebroker/exception/ServiceBrokerApiVersionMissingException.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@
2424
* being returned to the platform.
2525
*
2626
* @author Roy Clarkson
27+
* @see <a href=
28+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#api-version-header">Open
29+
* Service Broker API specification</a>
2730
*/
2831
public class ServiceBrokerApiVersionMissingException extends ServiceBrokerException {
2932

‎spring-cloud-open-service-broker-core/src/main/java/org/springframework/cloud/servicebroker/exception/ServiceBrokerAsyncRequiredException.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,14 @@
2626
* Throwing this exception will result in an HTTP status code
2727
* {@literal 422 UNPROCESSABLE ENTITY} being returned to the platform.
2828
*
29+
* <p>
30+
* Since OSB API 2.7.
31+
*
2932
* @author Scott Frederick
3033
* @author Roy Clarkson
34+
* @see <a href=
35+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#service-broker-errors">Open
36+
* Service Broker API specification</a>
3137
*/
3238
public class ServiceBrokerAsyncRequiredException extends ServiceBrokerException {
3339

‎spring-cloud-open-service-broker-core/src/main/java/org/springframework/cloud/servicebroker/exception/ServiceBrokerBindingRequiresAppException.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,13 @@
2424
* Throwing this exception will result in an HTTP status code
2525
* {@literal 422 UNPROCESSABLE ENTITY} being returned to the platform.
2626
*
27+
* <p>
28+
* Since OSB API 2.8.
29+
*
2730
* @author Scott Frederick
31+
* @see <a href=
32+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#service-broker-errors">Open
33+
* Service Broker API specification</a>
2834
*/
2935
public class ServiceBrokerBindingRequiresAppException extends ServiceBrokerException {
3036

‎spring-cloud-open-service-broker-core/src/main/java/org/springframework/cloud/servicebroker/exception/ServiceBrokerConcurrencyException.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@
2525
* {@literal 422 UNPROCESSABLE ENTITY} being returned to the platform.
2626
*
2727
* @author Scott Frederick
28+
* @see <a href=
29+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#service-broker-errors">Open
30+
* Service Broker API specification</a>
2831
*/
2932
public class ServiceBrokerConcurrencyException extends ServiceBrokerException {
3033

‎spring-cloud-open-service-broker-core/src/main/java/org/springframework/cloud/servicebroker/exception/ServiceBrokerCreateOperationInProgressException.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,16 @@
2525
* Throwing this exception will result in an HTTP status code {@literal 202 ACCEPTED}
2626
* being returned to the platform.
2727
*
28+
* <p>
29+
* Since OSB API 2.7.
30+
*
2831
* @author Roy Clarkson
32+
* @see <a href=
33+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#provisioning">Open
34+
* Service Broker API specification: Provisioning</a>
35+
* @see <a href=
36+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#binding">Open
37+
* Service Broker API specification: Binding</a>
2938
*/
3039
public class ServiceBrokerCreateOperationInProgressException extends ServiceBrokerOperationInProgressException {
3140

‎spring-cloud-open-service-broker-core/src/main/java/org/springframework/cloud/servicebroker/exception/ServiceBrokerDeleteOperationInProgressException.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,16 @@
2525
* Throwing this exception will result in an HTTP status code {@literal 202 ACCEPTED}
2626
* being returned to the platform.
2727
*
28+
* <p>
29+
* Since OSB API 2.7.
30+
*
2831
* @author Roy Clarkson
32+
* @see <a href=
33+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#deprovisioning">Open
34+
* Service Broker API specification: Deprovisioning</a>
35+
* @see <a href=
36+
* "https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#unbinding">Open
37+
* Service Broker API specification: Unbinding</a>
2938
*/
3039
public class ServiceBrokerDeleteOperationInProgressException extends ServiceBrokerOperationInProgressException {
3140

0 commit comments

Comments
 (0)