openservicebrokerapi / servicebroker

Open Service Broker API Specification
https://openservicebrokerapi.org/
Apache License 2.0
1.19k stars 436 forks source link

Add 'description' field to the 'maintenance_info.' #663

Closed waterlink closed 5 years ago

waterlink commented 5 years ago

This tackles the There SHOULD be some indication of the impact of an update part of #641.

This is not necessarily about a description string containing versions changes only, this may contain details about configuration changes, the default value changes, etc.

The main use case for maintenance_info and description field is for the plans that need maintenance done to them every 2-4 weeks or so, thus creating a new plan every time is not an option.

#165560405

What is the problem this PR solves? A description of what the problem is, or a link to an issue which this is related to.

Checklist:

cfdreddbot commented 5 years ago

:white_check_mark: Hey waterlink! The commit authors and yourself have already signed the CLA.

mattmcneeney commented 5 years ago

@waterlink there is a conflict with spec.md

waterlink commented 5 years ago

@mattmcneeney conflict should be fixed

jberkhahn commented 5 years ago

This looks good to me.