Skip to content

Commit

Permalink
Allow periods in the name field
Browse files Browse the repository at this point in the history
Service class and plan names can contain periods (".").
  • Loading branch information
mihnjong-l authored Feb 13, 2018
1 parent 6983b33 commit 0b0c122
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,9 +334,9 @@ $ curl http://username:password@service-broker-url/v2/catalog -H "X-Broker-API-V

CLI clients will typically have restrictions on how names, such as service
and plan names, will be provided by users. Therefore, this specification
defines a "CLI-friendly" string as a short string that MUST only use
alphanumeric characters and hyphens, with no spaces. This will make it easier
for users when they have to type it as an argument on the command line.
defines a "CLI-friendly" string as a short string that MUST only use
alphanumeric characters, periods, and hyphens, with no spaces. This will make it
easier for users when they have to type it as an argument on the command line.
For comparison purposes, service and plan names MUST be treated as
case-sensitive strings.

Expand All @@ -361,7 +361,7 @@ It is therefore RECOMMENDED that implementations avoid such strings.

| Response Field | Type | Description |
| --- | --- | --- |
| name* | string | A CLI-friendly name of the service. MUST only contain alphanumeric characters and hyphens (no spaces). MUST be unique across all service objects returned in this response. MUST be a non-empty string. |
| name* | string | A CLI-friendly name of the service. MUST only contain alphanumeric characters, periods, and hyphens (no spaces). MUST be unique across all service objects returned in this response. MUST be a non-empty string. |
| id* | string | An identifier used to correlate this service in future requests to the Service Broker. This MUST be globally unique. MUST be a non-empty string. Using a GUID is RECOMMENDED. |
| description* | string | A short description of the service. MUST be a non-empty string. |
| tags | array-of-strings | Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service, enabling equivalent services to be swapped out without changes to dependent logic in applications, buildpacks, or other services. E.g. mysql, relational, redis, key-value, caching, messaging, amqp. |
Expand Down Expand Up @@ -397,7 +397,7 @@ how Platforms might expose these values to their users.
| Response Field | Type | Description |
| --- | --- | --- |
| id* | string | An identifier used to correlate this plan in future requests to the Service Broker. This MUST be globally unique. MUST be a non-empty string. Using a GUID is RECOMMENDED. |
| name* | string | The CLI-friendly name of the plan. MUST only contain alphanumeric characters and hyphens (no spaces). MUST be unique within the service. MUST be a non-empty string. |
| name* | string | The CLI-friendly name of the plan. MUST only contain alphanumeric characters, periods, and hyphens (no spaces). MUST be unique within the service. MUST be a non-empty string. |
| description* | string | A short description of the plan. MUST be a non-empty string. |
| 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. |
Expand Down

0 comments on commit 0b0c122

Please sign in to comment.