Added notes for distinguising pattern from regex #1314
Conversation
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
linglp
requested changes
Feb 4, 2026
|
|
||
| The format of this attribute. See [format](https://json-schema.org/understanding-json-schema/reference/type#format) The type of this attribute must be "string" or "string_list". The value of this column will appear as the `format` of this attribute in the JSON Schema. Must be one of: | ||
|
|
||
| Note: If you want your data to MATCH a regex use the `Pattern` column. If you want your data to BE a regex pattern use this column, with the the `regex` value. |
Contributor
There was a problem hiding this comment.
I think this block should not followed "Must be one of:"
Contributor
There was a problem hiding this comment.
How about something like this:
Note: The Format and Pattern columns serve different purposes:
Pattern: Use to validate that data matches a specific regex pattern (e.g., enforce that email addresses follow a certain format)
Format: Use with the regex value to indicate that the data itself is a regex pattern being stored (not validated against one)
Available format values:
date-time
email
hostname
xxx
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Problem:
There was some confusion on when to use the
Patterncolumn vs theFormatcolumn in the Curator CSV data model.Solution:
Added some notes to show when to use which.
https://synapsepythonclient--1314.org.readthedocs.build/en/1314/explanations/curator_data_model/