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

Refactor Schemas, use display name as label. #1324

Conversation

mialy-defelice
Copy link
Contributor

The changes here allow the user to set a flag to use their model display names as the schema label.

Note: display name will not be used if it does not conform to expectations (no spaces or blacklisted characters). If this is the case a warning will be raised. In many cases the user would likely not want to update their display name to conform to schema label requirements. For example, if the model specifies Not Applicable as a valid value, the current setup would convert it to a schema label internally while allowing model_id the display name to be used as a schema label.

To validate, please test for expected results via CLI and API.

Make sure to use display_name_as_label flag at each step.

Check convert, manifest generation, validation and submit.

@mialy-defelice
Copy link
Contributor Author

@andrewelamb the tests are failing now in a known way (it was recently fixed on dev) that should resolve when I pull in develop-refactor-schemas after we release it.
In the meantime, I just wanted to get this PR out to you to start testing.

Another thing to note about the conversion of the display names to labels (if they aren't valid to be used directly) is that I went ahead and stripped the blacklisted characters so they would at least be consistent if they needed to be uploaded to Synapse. But this can also be changed, if you think it would be better to just do the camel case conversion. This happens a lot when dealing with valid values as noted above. I do not have a strong preference on how to go about this. I initially did the standard conversion, then stripped the characters since that happens later when adding annotations, so I thought it would be more clear this way.

Let me know if you have any questions.

@mialy-defelice mialy-defelice deleted the branch develop-refactor-schemas January 18, 2024 21:56
@mialy-defelice mialy-defelice deleted the develop-rs-display-name-as-lable-FDS-1129 branch March 8, 2024 23:25
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.

1 participant