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

[#387] Remove "SwagEdit" references from validation error and warning… #388

Merged
merged 4 commits into from
Sep 28, 2017

Conversation

ghillairet
Copy link
Member

… messages

@@ -22,7 +22,7 @@ error_additional_properties_not_allowed = object has properties %s which are not
error_required_properties = object has missing required properties %s
error_duplicate_keys = Duplicate key: the object has more than one property named %s
error_cannot_read_content = Unable to read content. It may be invalid YAML
error_missing_reference= Invalid Reference - SwagEdit was unable to resolve the reference. \n\
error_missing_reference= Invalid Reference - KaiZen Editor was unable to resolve the reference. \n\
Copy link
Member

Choose a reason for hiding this comment

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

This i18n binding is not used in the editor code, I only found usages in ReferenceValidatorTest. We can remove it to avoid code duplication and replace messages in tests with the messages defined in the core plugin.

@@ -22,7 +22,7 @@ error_additional_properties_not_allowed = object has properties %s which are not
error_required_properties = object has missing required properties %s
error_duplicate_keys = Duplicate key: the object has more than one property named %s
error_cannot_read_content = Unable to read content. It may be invalid YAML
error_missing_reference= Invalid Reference - SwagEdit was unable to resolve the reference. \n\
Copy link
Member

Choose a reason for hiding this comment

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

The same here, it's only used in tests, we can eliminate it.

@@ -9,7 +9,7 @@
# ModelSolv, Inc. - initial API and implementation and/or initial documentation
###############################################################################

error_missing_reference= Invalid Reference - SwagEdit was unable to resolve the reference. \n\
error_missing_reference= Invalid Reference - KaiZen Editor was unable to resolve the reference. \n\
Copy link
Member

Choose a reason for hiding this comment

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

This message is actually used by Validator, but we should change phrasing to Unable to resolve the reference
See description:

"Unable to resolve the reference" is fine. We don't need to say "KaiZen OpenAPI Editor is unable to resolve the reference."

@tfesenko
Copy link
Member

I found several other entries in GUI, e.g. this one (specified in plugin.xml):
screen shot 2017-09-22 at 8 21 51 pm

I recommend doing a case-sensitive search for SwagEdit on all KZOE plugins to locate UI labels. We should also use this possibility to update Java docs (found by search), but the class name can be left intact.

@tfesenko
Copy link
Member

@ghillairet , I left several suggestions in this PR. Please address them when you have the time 😓

@ghillairet
Copy link
Member Author

@tfesenko I think I removed them all now.

@@ -9,7 +9,7 @@
# ModelSolv, Inc. - initial API and implementation and/or initial documentation
###############################################################################

error_missing_reference= Invalid Reference - KaiZen Editor was unable to resolve the reference. \n\
error_missing_reference= Invalid Reference - Unable to resolve the reference. \n\
Copy link
Member

Choose a reason for hiding this comment

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

Cool!

@@ -13,27 +13,3 @@ swagedit_wizard_title = Swagger Spec

# wizard
swagedit_wizard_description = This wizard creates a new Swagger Spec in YAML format, which can be opened in KaiZen Editor.
Copy link
Member

Choose a reason for hiding this comment

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

Wow! Thanks!

@tfesenko
Copy link
Member

Looks good:

  • SwagEdit was removed from GUI items

Note that SwagEdit still used in maven artifactIds, but it's out of scope of this issue.

@tfesenko tfesenko merged commit d6bc8c1 into master Sep 28, 2017
@tfesenko tfesenko deleted the task/387 branch September 28, 2017 14:30
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.

2 participants