v3 improves enums (#188)

* Adds int and str enum literal outputs

* Adds enum literal outputs when possible

Author: spacether

modules/openapi-json-schema-generator/src/main/resources/python/components/schemas/_helper_enum_class.hbs

@@ -6,15 +6,15 @@ class {{enumInfo.valueToName.jsonPathPiece.camelCase}}:
 
     @schemas.classproperty
         {{#eq @key.type "string"}}
-    def {{this}}(cls) -> str:
+    def {{this}}(cls) -> typing_extensions.Literal["{{{@key.value}}}"]:
         return {{jsonPathPiece.camelCase}}.validate("{{{@key.value}}}")
         {{/eq}}
         {{#eq @key.type "number"}}
     def {{this}}(cls) -> typing.Union[int, float]:
         return {{jsonPathPiece.camelCase}}.validate({{{@key.value}}})
         {{/eq}}
         {{#eq @key.type "integer"}}
-    def {{this}}(cls) -> int:
+    def {{this}}(cls) -> typing_extensions.Literal[{{{@key.value}}}]:
         return {{jsonPathPiece.camelCase}}.validate({{{@key.value}}})
         {{/eq}}
         {{#eq @key.type "boolean"}}

samples/openapi3/client/3_0_3_unit_test/python/src/unit_test_api/components/schema/enum_with0_does_not_match_false.py

@@ -15,7 +15,7 @@
 class EnumWith0DoesNotMatchFalseEnums:
 
     @schemas.classproperty
-    def POSITIVE_0(cls) -> int:
+    def POSITIVE_0(cls) -> typing_extensions.Literal[0]:
         return EnumWith0DoesNotMatchFalse.validate(0)
 
 

samples/openapi3/client/3_0_3_unit_test/python/src/unit_test_api/components/schema/enum_with1_does_not_match_true.py

@@ -15,7 +15,7 @@
 class EnumWith1DoesNotMatchTrueEnums:
 
     @schemas.classproperty
-    def POSITIVE_1(cls) -> int:
+    def POSITIVE_1(cls) -> typing_extensions.Literal[1]:
         return EnumWith1DoesNotMatchTrue.validate(1)
 
 

samples/openapi3/client/3_0_3_unit_test/python/src/unit_test_api/components/schema/enum_with_escaped_characters.py

@@ -15,11 +15,11 @@
 class EnumWithEscapedCharactersEnums:
 
     @schemas.classproperty
-    def FOO_LINE_FEED_LF_BAR(cls) -> str:
+    def FOO_LINE_FEED_LF_BAR(cls) -> typing_extensions.Literal["foo\nbar"]:
         return EnumWithEscapedCharacters.validate("foo\nbar")
 
     @schemas.classproperty
-    def FOO_CARRIAGE_RETURN_CR_BAR(cls) -> str:
+    def FOO_CARRIAGE_RETURN_CR_BAR(cls) -> typing_extensions.Literal["foo\rbar"]:
         return EnumWithEscapedCharacters.validate("foo\rbar")
 
 

samples/openapi3/client/3_0_3_unit_test/python/src/unit_test_api/components/schema/enums_in_properties.py

@@ -15,7 +15,7 @@
 class FooEnums:
 
     @schemas.classproperty
-    def FOO(cls) -> str:
+    def FOO(cls) -> typing_extensions.Literal["foo"]:
         return Foo.validate("foo")
 
 
@@ -69,7 +69,7 @@ def validate(
 class BarEnums:
 
     @schemas.classproperty
-    def BAR(cls) -> str:
+    def BAR(cls) -> typing_extensions.Literal["bar"]:
         return Bar.validate("bar")
 
 

samples/openapi3/client/3_0_3_unit_test/python/src/unit_test_api/components/schema/nul_characters_in_strings.py

@@ -15,7 +15,7 @@
 class NulCharactersInStringsEnums:
 
     @schemas.classproperty
-    def HELLO_NULL_THERE(cls) -> str:
+    def HELLO_NULL_THERE(cls) -> typing_extensions.Literal["hello\x00there"]:
         return NulCharactersInStrings.validate("hello\x00there")
 
 

samples/openapi3/client/3_0_3_unit_test/python/src/unit_test_api/components/schema/simple_enum_validation.py

@@ -15,15 +15,15 @@
 class SimpleEnumValidationEnums:
 
     @schemas.classproperty
-    def POSITIVE_1(cls) -> int:
+    def POSITIVE_1(cls) -> typing_extensions.Literal[1]:
         return SimpleEnumValidation.validate(1)
 
     @schemas.classproperty
-    def POSITIVE_2(cls) -> int:
+    def POSITIVE_2(cls) -> typing_extensions.Literal[2]:
         return SimpleEnumValidation.validate(2)
 
     @schemas.classproperty
-    def POSITIVE_3(cls) -> int:
+    def POSITIVE_3(cls) -> typing_extensions.Literal[3]:
         return SimpleEnumValidation.validate(3)
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/basque_pig.py

@@ -15,7 +15,7 @@
 class ClassNameEnums:
 
     @schemas.classproperty
-    def BASQUE_PIG(cls) -> str:
+    def BASQUE_PIG(cls) -> typing_extensions.Literal["BasquePig"]:
         return ClassName.validate("BasquePig")
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/complex_quadrilateral.py

@@ -15,7 +15,7 @@
 class QuadrilateralTypeEnums:
 
     @schemas.classproperty
-    def COMPLEX_QUADRILATERAL(cls) -> str:
+    def COMPLEX_QUADRILATERAL(cls) -> typing_extensions.Literal["ComplexQuadrilateral"]:
         return QuadrilateralType.validate("ComplexQuadrilateral")
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/currency.py

@@ -15,11 +15,11 @@
 class CurrencyEnums:
 
     @schemas.classproperty
-    def EUR(cls) -> str:
+    def EUR(cls) -> typing_extensions.Literal["eur"]:
         return Currency.validate("eur")
 
     @schemas.classproperty
-    def USD(cls) -> str:
+    def USD(cls) -> typing_extensions.Literal["usd"]:
         return Currency.validate("usd")
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/danish_pig.py

@@ -15,7 +15,7 @@
 class ClassNameEnums:
 
     @schemas.classproperty
-    def DANISH_PIG(cls) -> str:
+    def DANISH_PIG(cls) -> typing_extensions.Literal["DanishPig"]:
         return ClassName.validate("DanishPig")
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/enum_arrays.py

@@ -15,11 +15,11 @@
 class JustSymbolEnums:
 
     @schemas.classproperty
-    def GREATER_THAN_SIGN_EQUALS_SIGN(cls) -> str:
+    def GREATER_THAN_SIGN_EQUALS_SIGN(cls) -> typing_extensions.Literal[">="]:
         return JustSymbol.validate(">=")
 
     @schemas.classproperty
-    def DOLLAR_SIGN(cls) -> str:
+    def DOLLAR_SIGN(cls) -> typing_extensions.Literal["$"]:
         return JustSymbol.validate("$")
 
 
@@ -83,11 +83,11 @@ def validate(
 class ItemsEnums:
 
     @schemas.classproperty
-    def FISH(cls) -> str:
+    def FISH(cls) -> typing_extensions.Literal["fish"]:
         return Items.validate("fish")
 
     @schemas.classproperty
-    def CRAB(cls) -> str:
+    def CRAB(cls) -> typing_extensions.Literal["crab"]:
         return Items.validate("crab")
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/enum_class.py

@@ -15,23 +15,23 @@
 class EnumClassEnums:
 
     @schemas.classproperty
-    def _ABC(cls) -> str:
+    def _ABC(cls) -> typing_extensions.Literal["_abc"]:
         return EnumClass.validate("_abc")
 
     @schemas.classproperty
-    def HYPHEN_MINUS_EFG(cls) -> str:
+    def HYPHEN_MINUS_EFG(cls) -> typing_extensions.Literal["-efg"]:
         return EnumClass.validate("-efg")
 
     @schemas.classproperty
-    def LEFT_PARENTHESIS_XYZ_RIGHT_PARENTHESIS(cls) -> str:
+    def LEFT_PARENTHESIS_XYZ_RIGHT_PARENTHESIS(cls) -> typing_extensions.Literal["(xyz)"]:
         return EnumClass.validate("(xyz)")
 
     @schemas.classproperty
-    def COUNT_1M(cls) -> str:
+    def COUNT_1M(cls) -> typing_extensions.Literal["COUNT_1M"]:
         return EnumClass.validate("COUNT_1M")
 
     @schemas.classproperty
-    def COUNT_50M(cls) -> str:
+    def COUNT_50M(cls) -> typing_extensions.Literal["COUNT_50M"]:
         return EnumClass.validate("COUNT_50M")
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/enum_test.py

@@ -15,15 +15,15 @@
 class EnumStringEnums:
 
     @schemas.classproperty
-    def UPPER(cls) -> str:
+    def UPPER(cls) -> typing_extensions.Literal["UPPER"]:
         return EnumString.validate("UPPER")
 
     @schemas.classproperty
-    def LOWER(cls) -> str:
+    def LOWER(cls) -> typing_extensions.Literal["lower"]:
         return EnumString.validate("lower")
 
     @schemas.classproperty
-    def EMPTY(cls) -> str:
+    def EMPTY(cls) -> typing_extensions.Literal[""]:
         return EnumString.validate("")
 
 
@@ -97,15 +97,15 @@ def validate(
 class EnumStringRequiredEnums:
 
     @schemas.classproperty
-    def UPPER(cls) -> str:
+    def UPPER(cls) -> typing_extensions.Literal["UPPER"]:
         return EnumStringRequired.validate("UPPER")
 
     @schemas.classproperty
-    def LOWER(cls) -> str:
+    def LOWER(cls) -> typing_extensions.Literal["lower"]:
         return EnumStringRequired.validate("lower")
 
     @schemas.classproperty
-    def EMPTY(cls) -> str:
+    def EMPTY(cls) -> typing_extensions.Literal[""]:
         return EnumStringRequired.validate("")
 
 
@@ -179,11 +179,11 @@ def validate(
 class EnumIntegerEnums:
 
     @schemas.classproperty
-    def POSITIVE_1(cls) -> int:
+    def POSITIVE_1(cls) -> typing_extensions.Literal[1]:
         return EnumInteger.validate(1)
 
     @schemas.classproperty
-    def NEGATIVE_1(cls) -> int:
+    def NEGATIVE_1(cls) -> typing_extensions.Literal[-1]:
         return EnumInteger.validate(-1)
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/equilateral_triangle.py

@@ -15,7 +15,7 @@
 class TriangleTypeEnums:
 
     @schemas.classproperty
-    def EQUILATERAL_TRIANGLE(cls) -> str:
+    def EQUILATERAL_TRIANGLE(cls) -> typing_extensions.Literal["EquilateralTriangle"]:
         return TriangleType.validate("EquilateralTriangle")
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/integer_enum.py

@@ -15,15 +15,15 @@
 class IntegerEnumEnums:
 
     @schemas.classproperty
-    def POSITIVE_0(cls) -> int:
+    def POSITIVE_0(cls) -> typing_extensions.Literal[0]:
         return IntegerEnum.validate(0)
 
     @schemas.classproperty
-    def POSITIVE_1(cls) -> int:
+    def POSITIVE_1(cls) -> typing_extensions.Literal[1]:
         return IntegerEnum.validate(1)
 
     @schemas.classproperty
-    def POSITIVE_2(cls) -> int:
+    def POSITIVE_2(cls) -> typing_extensions.Literal[2]:
         return IntegerEnum.validate(2)
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/integer_enum_big.py

@@ -15,15 +15,15 @@
 class IntegerEnumBigEnums:
 
     @schemas.classproperty
-    def POSITIVE_10(cls) -> int:
+    def POSITIVE_10(cls) -> typing_extensions.Literal[10]:
         return IntegerEnumBig.validate(10)
 
     @schemas.classproperty
-    def POSITIVE_11(cls) -> int:
+    def POSITIVE_11(cls) -> typing_extensions.Literal[11]:
         return IntegerEnumBig.validate(11)
 
     @schemas.classproperty
-    def POSITIVE_12(cls) -> int:
+    def POSITIVE_12(cls) -> typing_extensions.Literal[12]:
         return IntegerEnumBig.validate(12)
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/integer_enum_one_value.py

@@ -15,7 +15,7 @@
 class IntegerEnumOneValueEnums:
 
     @schemas.classproperty
-    def POSITIVE_0(cls) -> int:
+    def POSITIVE_0(cls) -> typing_extensions.Literal[0]:
         return IntegerEnumOneValue.validate(0)
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/integer_enum_with_default_value.py

@@ -15,15 +15,15 @@
 class IntegerEnumWithDefaultValueEnums:
 
     @schemas.classproperty
-    def POSITIVE_0(cls) -> int:
+    def POSITIVE_0(cls) -> typing_extensions.Literal[0]:
         return IntegerEnumWithDefaultValue.validate(0)
 
     @schemas.classproperty
-    def POSITIVE_1(cls) -> int:
+    def POSITIVE_1(cls) -> typing_extensions.Literal[1]:
         return IntegerEnumWithDefaultValue.validate(1)
 
     @schemas.classproperty
-    def POSITIVE_2(cls) -> int:
+    def POSITIVE_2(cls) -> typing_extensions.Literal[2]:
         return IntegerEnumWithDefaultValue.validate(2)
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/isosceles_triangle.py

@@ -15,7 +15,7 @@
 class TriangleTypeEnums:
 
     @schemas.classproperty
-    def ISOSCELES_TRIANGLE(cls) -> str:
+    def ISOSCELES_TRIANGLE(cls) -> typing_extensions.Literal["IsoscelesTriangle"]:
         return TriangleType.validate("IsoscelesTriangle")
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/json_patch_request_add_replace_test.py

@@ -18,15 +18,15 @@
 class OpEnums:
 
     @schemas.classproperty
-    def ADD(cls) -> str:
+    def ADD(cls) -> typing_extensions.Literal["add"]:
         return Op.validate("add")
 
     @schemas.classproperty
-    def REPLACE(cls) -> str:
+    def REPLACE(cls) -> typing_extensions.Literal["replace"]:
         return Op.validate("replace")
 
     @schemas.classproperty
-    def TEST(cls) -> str:
+    def TEST(cls) -> typing_extensions.Literal["test"]:
         return Op.validate("test")
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/json_patch_request_move_copy.py

@@ -18,11 +18,11 @@
 class OpEnums:
 
     @schemas.classproperty
-    def MOVE(cls) -> str:
+    def MOVE(cls) -> typing_extensions.Literal["move"]:
         return Op.validate("move")
 
     @schemas.classproperty
-    def COPY(cls) -> str:
+    def COPY(cls) -> typing_extensions.Literal["copy"]:
         return Op.validate("copy")
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/json_patch_request_remove.py

@@ -17,7 +17,7 @@
 class OpEnums:
 
     @schemas.classproperty
-    def REMOVE(cls) -> str:
+    def REMOVE(cls) -> typing_extensions.Literal["remove"]:
         return Op.validate("remove")
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/map_test.py

@@ -132,11 +132,11 @@ def validate(
 class AdditionalPropertiesEnums:
 
     @schemas.classproperty
-    def UPPER(cls) -> str:
+    def UPPER(cls) -> typing_extensions.Literal["UPPER"]:
         return AdditionalProperties3.validate("UPPER")
 
     @schemas.classproperty
-    def LOWER(cls) -> str:
+    def LOWER(cls) -> typing_extensions.Literal["lower"]:
         return AdditionalProperties3.validate("lower")