Skip to content

[csharp][netcore] Do not validate enum parameters #9594

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.

Sign up for GitHub

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
wing328 merged 1 commit into from
Jun 3, 2021
Merged

[csharp][netcore] Do not validate enum parameters #9594

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions modules/openapi-generator/src/main/resources/csharp-netcore/modelGeneric.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,7 @@
{{/parent}}
{{#vars}}
{{#hasValidation}}
{{^isEnum}}
{{#maxLength}}
// {{{name}}} ({{{dataType}}}) maxLength
if(this.{{{name}}} != null && this.{{{name}}}.Length > {{maxLength}})

@prajon84 prajon84 May 26, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Instead of not validating for enum params. What about if:
this.{{{name}}}.ToString().Length > {{maxLength}} so that it will work for other case like:

	uuid_property:
      description: This is description
      type: string
      format: uuid
      maxLength: 36

Else, it will also break at: UuidProperty.Length > 36

@jfeltesse-mdsol jfeltesse-mdsol May 27, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm not sure I understand what you mean, are you saying strings with format: uuid are not String objects and thus need the toString() call? Looks like a separate issue if that's what you meant.

Here the fix simply skips adding validation checks if the property specifies an enum, which is a very reliable and future-proof way, me thinks.

@Blackclaws Blackclaws May 27, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Strings with format: uuid are of Guid type in c#. The comment is valid however and worth some thought. If there is a simple way to keep validation and still have the enum behavior that might be worth exploring. However having validation for enum parameters would mean that they might break at some point in the future when one decides to use the forbidden values for the first time instead of breaking immediately.

@prajon84 prajon84 May 27, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes. I meant to say is Strings with format: uuid are of Guid type in c#.
And, as the above validations like MaxLength/ MinLength are specific to string type. Its better to convert to string type using ToString() before validating the property.
Similar to that I found in ruby-client -> https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/ruby-client/partial_model_generic.mustache#L302 ( to_s converts to string IIUC)

Besides, it might be separate issue but the gist of the bug is same.

@Blackclaws Blackclaws May 27, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Guids really don't have the same issue however. Reason being that it performs its own validation. Of course the same applies you could technically have the validation parameters in the spec I guess. It just makes no sense whatsoever.

Expand Down Expand Up @@ -343,6 +344,7 @@

{{/isByteArray}}
{{/pattern}}
{{/isEnum}}
{{/hasValidation}}
{{/vars}}
yield break;
Expand Down