[new rule]: Enum cannot be: "type": "Boolean",

[jianyexi]

Lint rule description

Enum can not be: "type": "boolean",

Related swagger example

Azure/autorest.python#847
https://github.com/Azure/azure-rest-api-specs/pull/14676/files

Category

SDK

Severity level

Error

Applies to

Management plane API spec, Data plane API spec

How to fix the violation

avoid this usage

What't the impact if breaking the rule

python does not support Boolean Enum

[jianyexi]

@lmazuel can you help confirm this rule ? as it's from our backlog for long time not sure if it's valid now

[jianyexi]

@msyyc to confirm as well

[msyyc]

Hi @jianyexi, Python has solved the compatible issue in this scenario, so it is not necessary for python now. Thanks!

[lmazuel]

@jianyexi from a big picture perspective (and not just Python), this rule is necessary to make sure we genreate SDK that makes sense. Boolean being two values only (true/false), making this an eum is an anti-pattern

[jianyexi]

@jianyexi from a big picture perspective (and not just Python), this rule is necessary to make sure we genreate SDK that makes sense. Boolean being two values only (true/false), making this an eum is an anti-pattern

thanks got it, but seems we have a rule EnumInsteadOfboolean, which is kind of conflict with the current rule, so do we prefer a string type enum instead of boolean in this case ?

[lmazuel]

It's not a conflict, they do not have the same role. EnumInsteadOfBoolean is defined as:

Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined.

This is to tell service team to not use boolean at all, but replace with strings is better on the server side. Assuming a service team has already committed to boolean and it's too late, then they must NOT use an enum that wrap that boolean. Not the same abstraction level.