Document case sensitivity of name fields in API docs#5079
Open
philippthun wants to merge 1 commit intocloudfoundry:mainfrom
Open
Document case sensitivity of name fields in API docs#5079philippthun wants to merge 1 commit intocloudfoundry:mainfrom
philippthun wants to merge 1 commit intocloudfoundry:mainfrom
Conversation
Member
Author
|
Backwards Compatibility Tests need this fix: #5085 |
The API has inconsistent case sensitivity behavior across resources due to historical schema choices: some name columns use citext (case-insensitive) while others use plain varchar (case-sensitive). This was completely undocumented, causing confusion for API consumers. Add (case-insensitive) or (case-sensitive) annotations to: - Create endpoint name parameters, including uniqueness scope - List endpoint name filter parameters - Cross-resource name filters (e.g. service_broker_names) Case-insensitive: apps, organizations, spaces, domains, isolation segments, organization quotas, service plans, service offerings, tasks Case-sensitive: service instances, buildpacks, stacks, security groups, service brokers, space quotas, service credential bindings Also remove the misspelled 'case_insenstive' option from three migrations (stacks, lockings, frameworks). The typo meant the option was silently ignored, so these columns were always case-sensitive. Removing the dead option makes the code reflect actual behavior.
philippthun
force-pushed
the
document-name-case-sensitivity
branch
from
0d9771f to
3d74764
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The API has inconsistent case sensitivity behavior across resources due to historical schema choices: some name columns use
citext(case-insensitive) while others use plainvarchar(case-sensitive). This was completely undocumented, causing confusion for API consumers.Add (case-insensitive) or (case-sensitive) annotations to:
service_broker_names)Case-insensitive: apps, organizations, spaces, domains, isolation segments, organization quotas, service plans, service offerings, tasks
Case-sensitive: service instances, buildpacks, stacks, security groups, service brokers, space quotas, service credential bindings
Also remove the misspelled 'case_insenstive' option from three migrations (stacks, lockings, frameworks). The typo meant the option was silently ignored, so these columns were always case-sensitive. Removing the dead option makes the code reflect actual behavior.
I have reviewed the contributing guide
I have viewed, signed, and submitted the Contributor License Agreement
I have made this pull request to the
mainbranchI have run all the unit tests using
bundle exec rakeI have run CF Acceptance Tests