Skip to content

Conversation

@jasonkung22
Copy link
Contributor

@jasonkung22 jasonkung22 commented Dec 3, 2024

In the header/path/query request mode, whether to enable the enumeration converter, the default value is false.

  1. If true, the enumeration value is parsed as an enumeration example value.
  2. If false, take the enumeration name as the enumeration example value

PR: TongchengOpenSource/smart-doc#989

@shalousun
Copy link
Contributor

@jasonkung22 enumNameExample should default to true. This setting aligns with the most common use case for the majority of users and ensures compatibility with older users. Setting it to false would negatively impact the upgrade experience for most users.

@jasonkung22
Copy link
Contributor Author

@jasonkung22 enumNameExample should default to true. This setting aligns with the most common use case for the majority of users and ensures compatibility with older users. Setting it to false would negatively impact the upgrade experience for most users.

ok, from the feedback on Issue and previous experience, I mistakenly assume that most users would prefer to display enumValue, so the default value is set to false. However, if configured to true, there may be some interference for users who wish to display Enumvalues. There is no perfect solution. so I will change the default value to true

@jasonkung22 jasonkung22 force-pushed the feat/config_enum_name_example branch from e621c53 to c4882b6 Compare December 7, 2024 14:35
@jasonkung22 jasonkung22 changed the title feat: Add the 'enumNameExample' configuration, default 'false' feat: Add the 'enumNameExample' configuration, default 'true' Dec 7, 2024
@jasonkung22
Copy link
Contributor Author

Because it is not sure what the next version number will be, if the next version number is not '3.1.0', it may need to be changed

@shalousun
Copy link
Contributor

Because it is not sure what the next version number will be, if the next version number is not '3.1.0', it may need to be changed

next version is 3.1.0

@jasonkung22 jasonkung22 force-pushed the feat/config_enum_name_example branch from c4882b6 to 1cadace Compare December 11, 2024 05:13
@jasonkung22 jasonkung22 changed the title feat: Add the 'enumNameExample' configuration, default 'true' feat: Add the 'enumConvertor' configuration, default 'true' Dec 11, 2024
@jasonkung22 jasonkung22 force-pushed the feat/config_enum_name_example branch from 1cadace to 56e5e19 Compare December 11, 2024 05:17
@jasonkung22 jasonkung22 changed the title feat: Add the 'enumConvertor' configuration, default 'true' feat: Add the 'enumConvertor' configuration, default 'false' Dec 12, 2024
In the header/path/query request mode, whether to enable the enumeration converter, the default value is false.
1. If true, the enumeration value is parsed as an enumeration example value.
2. If false, take the enumeration name as the enumeration example value

PR: TongchengOpenSource/smart-doc#989
@jasonkung22 jasonkung22 force-pushed the feat/config_enum_name_example branch from 56e5e19 to 4272021 Compare December 12, 2024 01:48
@shalousun shalousun merged commit 59f9eb9 into smart-doc-group:master Dec 12, 2024
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