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.

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

Conversation

mattmcneeney
Copy link
Contributor

See #509

@cfdreddbot
Copy link

Hey mattmcneeney!

Thanks for submitting this pull request! I'm here to inform the recipients of the pull request that you and the commit authors have already signed the CLA.

@duglin
Copy link
Contributor

duglin commented May 15, 2018

LGTM

Approved with PullApprove

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.

@mattmcneeney
Copy link
Contributor Author

Needs reviews!

@n3wscott
Copy link
Contributor

@mattmcneeney stop using the service broker repo for development. Make a fork in your own space and make PRs from there :D

@mattmcneeney
Copy link
Contributor Author

@n3wscott Ha I didn't even realise I was doing that... Serves me right for editing in the browser!

@zrob
Copy link
Member

zrob commented May 22, 2018

lgtm

Approved with PullApprove

@fmui
Copy link
Member

fmui commented May 22, 2018

LGTM

Approved with PullApprove

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants