Add constrained string model for item IDs #239
Merged
Conversation
This file contains 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
|
Pushing the discussion one step further, we should consider reinterpreting unique "ID" to mean that the same ID with dash/underscores/capitalisation is not allowed, e.g.,
|
jdbocarsly
reviewed
Jan 25, 2023
jdbocarsly
approved these changes
Jan 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a constrained string type for
HumanReadableIdentifiersto be used foritem_ids throughout. The exact parameters of these can be discussed, but for now, it restricts characters to alphanumeric with dashes and underscores, a maximum length of 16and minimum of 6(now removed - tbd).Unfortunately this type can only be properly used within a pydantic model at the moment (see linked discussion on pydantic repo in the code), which is hopefully good enough for now. Ideally we'd provide an endpoint that can validate these IDs for uniqueness and format without having to create the whole sample first.
Closes #228