feat!: Collection.key -> Collection.collection_code#504
Draft
kdmccormick wants to merge 1 commit intomainfrom
Draft
feat!: Collection.key -> Collection.collection_code#504kdmccormick wants to merge 1 commit intomainfrom
kdmccormick wants to merge 1 commit intomainfrom
Conversation
Also, standardize internal usage of collection_key to collection_code. This helps clarify that Collection.key is *not* an OpaqueKey, but is rather a local slug, which can be combined with other identifiers to form a fully- qualified LibraryCollectionKey instance. BREAKING CHANGE: Collection.key has been renamed to Collection.collection_code. The underlying database field is still named _key. BREAKING CHANGE: Collection.collection_code now validates that its contents is a valid 'Slug' [A-Za-z0-9_-]. This was already effectively true, because LibraryCollectionKey can only be built with slug-like parts, but we now enforce it at the db level. Part of: #322
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.
Also, standardize internal usage of collection_key to collection_code. This helps clarify that Collection.key is not an OpaqueKey, but is rather a local slug, which can be combined with other identifiers to form a fully- qualified LibraryCollectionKey instance.
BREAKING CHANGE: Collection.key has been renamed to Collection.collection_code. The underlying database field is still named _key.
BREAKING CHANGE: Collection.get_by_key is now Collection.get_by_code
BREAKING CHANGE: Collection.collection_code now validates that its contents is a valid 'Slug' [A-Za-z0-9_-]. This was already effectively true, because LibraryCollectionKey can only be built with slug-like parts, but we now enforce it at the db level.
Part of: #322