The JsonSchemaType should offer a method to produce the JSON Schema type value

[mikekistler]

Is your feature request related to a problem? Please describe.

The JsonSchemaType class is intended to represent a JSON Schema type, but its ToString() method currently produces a Pascal-cased string, e.g.:

JsonSchemaType.Object.ToString() == "Object"

but the actual JSON schema type is lowercase "object". So if a user wants to obtain the real JSON Schema type from a JsonSchemaType object, they currently must lowercase it themselves, and must use case-insensitive compares for type values in actual JSON schemas.

And there is the reverse problem, which is that EnumParse of a correctly-cased JSON Schema type currently throws an exception rather than returning the appropriate JsonSchemaType object.

Enum.Parse<JsonSchemaType>("object")

Unhandled exception. System.ArgumentException: Requested value 'object' was not found.
   at System.Enum.TryParseByName[TStorage](RuntimeType enumType, ReadOnlySpan`1 value, Boolean ignoreCase, Boolean throwOnFailure, TStorage& result)
   at System.Enum.TryParseByValueOrName[TUnderlying,TStorage](RuntimeType enumType, ReadOnlySpan`1 value, Boolean ignoreCase, Boolean throwOnFailure, TUnderlying& result)
   at System.Enum.Parse[TEnum](String value, Boolean ignoreCase)
   at System.Enum.Parse[TEnum](String value)
   at Program.<Main>$(String[] args)
Command terminated by signal 6

Describe the solution you'd like

I think the JsonSchemaType class should provide a method that returns the correctly-cased JSON Schema type.

In addition, Enum.Parse of a correctly-cased JSON schema type should return the appropriate JsonSchemaType object.

Describe alternatives you've considered

One alternative is to change the ToString() method to return a correctly cased JSON Schema type value.

Another alternative is to provide a new method, such as ToIdentifier(), that returns the correctly cased value.

For EnumParse, it should accept either the Pascal-cased or correctly-cased JSON Schema type and return the appropriate JsonSchemaType object.

Additional context

Recreate on dotnetfiddle

Discussion on aspnetcore PR 59480 that motivated this issue.

[baywet]

@mikekistler
Thank you for using the SDK and for reaching out.

What do you think of adding EnumMemberAttribute ??

[mikekistler]

@baywet Does this specify the value produced by ToString? And will Enum.Parse recognize these values? If yes than that sounds good to me!

[MaggieKimani1]

@mikekistler @baywet we already have a ToIdentifier() defined on the the JsonSchemaType as well as a ToJsonSchemaType() for converting the string representation to it's corresponding Enum type.

	JsonSchemaType.Object.ToIdentifier() == "object";
	"object".ToJsonSchemaType() == JsonSchemaType.Object;

You can use these in place of ToString() and Enum.Parse

[mikekistler]

@captainsafia Does this look good to you?

[baywet]

also, we've since tested enum member attribute and it does not impact to string as I expected.
I was most likely thinking of this description attribute instead
Implicit operators are worth looking at, even though using them in combination with enums and native types seems to be challenging

[captainsafia]

@mikekistler @baywet we already have a ToIdentifier() defined on the the JsonSchemaType as well as a ToJsonSchemaType() for converting the string representation to it's corresponding Enum type.

JsonSchemaType.Object.ToIdentifier() == "object";
"object".ToJsonSchemaType() == JsonSchemaType.Object;
You can use these in place of ToString() and Enum.Parse

I took a look at these methods and they don't seem to handle flags enums very well. Could we update the implementations so they support types like JsonSchemaType.String | JsonSchemaType.Null? Perhaps we can standardize the representation format for that to an array of lowercase strings, that would match the conventions used by System.Text.Json and make parsing these a little bit easier.