Skip to content

Commit

Permalink
Merge pull request #595 from jberkhahn/updateable_plans
Browse files Browse the repository at this point in the history
Add updateable field to plan object
  • Loading branch information
kibbles-n-bytes committed Oct 16, 2018
2 parents 000e102 + e707184 commit 18cdf15
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions spec.md
Expand Up @@ -452,7 +452,7 @@ It is therefore RECOMMENDED that implementations avoid such strings.
| bindings_retrievable | boolean | Specifies whether the [Fetching a Service Binding](#fetching-a-service-binding) endpoint is supported for all plans. |
| metadata | object | An opaque object of metadata for a Service Offering. It is expected that Platforms will treat this as a blob. Note that there are [conventions](profile.md#service-metadata) in existing Service Brokers and Platforms for fields that aid in the display of catalog data. |
| dashboard_client | [DashboardClient](profile.md#dashboard-client-object) | A Cloud Foundry extension described in [Catalog Extensions](profile.md#catalog-extensions). Contains the data necessary to activate the Dashboard SSO feature for this service. |
| plan_updateable | boolean | Whether the service supports upgrade/downgrade for some plans. Please note that the misspelling of the attribute `plan_updatable` as `plan_updateable` was done by mistake. We have opted to keep that misspelling instead of fixing it and thus breaking backward compatibility. Defaults to false. |
| plan_updateable | boolean | Whether the Service Offering supports upgrade/downgrade for Service Plans by default. Service Plans can override this field (see [Service Plan](#plan-object)). Please note that the misspelling of the attribute `plan_updatable` as `plan_updateable` was done by mistake. We have opted to keep that misspelling instead of fixing it and thus breaking backward compatibility. Defaults to false. |
| plans* | array of [Plan](#plan-object) objects | A list of plans for this service, schema is defined below. MUST contain at least one plan. |

\* Fields with an asterisk are REQUIRED.
Expand All @@ -476,6 +476,7 @@ how Platforms might expose these values to their users.
| metadata | object | An opaque object of metadata for a Service Plan. It is expected that Platforms will treat this as a blob. Note that there are [conventions](profile.md#service-metadata) in existing Service Brokers and Platforms for fields that aid in the display of catalog data. |
| free | boolean | When false, Service Instances of this plan have a cost. The default is true. |
| bindable | boolean | Specifies whether Service Instances of the Service Plan can be bound to applications. This field is OPTIONAL. If specified, this takes precedence over the `bindable` attribute of the service. If not specified, the default is derived from the service. |
| plan_updateable | boolean | Whether the Plan supports upgrade/downgrade/sidegrade to another version. This field is OPTIONAL. If specificed, this takes precedence over the Service Offering's `plan_updateable` field. If not specified, the default is derived from the Service Offering. Please note that the attribute is intentionally misspelled as `plan_updateable` for legacy reasons. |
| schemas | [Schemas](#schemas-object) | Schema definitions for Service Instances and Service Bindings for the plan. |

\* Fields with an asterisk are REQUIRED.
Expand Down Expand Up @@ -1036,8 +1037,8 @@ Service Instance to other plans. By modifying parameters, users can change
configuration options that are specific to a service or plan.

To enable support for the update of the plan, a Service Broker MUST declare
support per service by including `"plan_updateable": true` in its [catalog
endpoint](#catalog-management).
support per service by including `"plan_updateable": true` in either the Service Offering
or Service Plan in its [catalog endpoint](#catalog-management).

If `"plan_updateable": true` is declared for a plan in the
[Catalog](#catalog-management) endpoint, the Platform MAY request a plan change
Expand Down

0 comments on commit 18cdf15

Please sign in to comment.