Skip to content

change analysis description to be nullable #452

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

Merged
merged 2 commits into from
Oct 27, 2022

Conversation

qjiang002
Copy link
Collaborator

Allow analysis description to be nullable

When uploading custom analyses without descriptions, the following error will occur and the web will break down.

[500] None is not of type 'string' Failed validating 'type' in schema['allOf'][1]['properties']['system_info']['properties']['analyses']['items']['properties']['description']: {'type': 'string'} On instance['system_info']['analyses'][9]['description']: None

This is because Analysis's description property is fixed to string type. Setting Analysis description to be nullable also makes it consistent with its SDK setting.

Web chart title change

The chart title is {metricName} by {analysisDescription}, and the default analyses's descriptions are the same as the corresponding feature descriptions. Since custom analysis description can be null, use the feature name as analysisDescription when analysis description is not defined.

Copy link
Collaborator

@pfliu-nlp pfliu-nlp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@qjiang002 qjiang002 requested a review from lyuyangh October 27, 2022 02:32
@qjiang002 qjiang002 merged commit 3e6be75 into main Oct 27, 2022
@qjiang002 qjiang002 deleted the fix-analysis-description-nullable branch October 27, 2022 02:42
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.

3 participants