Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guidance for supported string lengths #518

Merged
merged 1 commit into from
May 22, 2018
Merged

Add guidance for supported string lengths #518

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,10 @@ Instances of these plans. For example, Platforms might restrict the actions
that users can perform on existing Service Instances if the associated service
or plan is deleted. Consider your deprecation strategy.

Platforms MAY have limits on the length of strings that they can handle or
display to end users, such as the description of a Service or Service Plan. It
is RECOMMENDED that strings do not exceed 255 characters to increase the
likelihood of having compatibility with any Platform.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry to sandbag one more comment, but perhaps we want to give an out to the platform for truncation? like:

Platforms MAY truncate strings longer than 255 characters. or something like that. This says the platforms have limits as a warning to the broker but does not say what the platform will do to a string from a broker that is too long.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My concern with that sentence is that it may make service authors think that Platforms would still be compatible (as in, they could use the service broker), but in CFs case, a string over 255 characters means you can't register the broker at all.


The following sections describe catalog requests and responses in the Service
Broker API.
Expand Down