Skip to content

no-enum

Full name
@azure-tools/typespec-azure-core/no-enum

Azure services favor extensible enums to avoid breaking changes as new enum values are added. TypeSpec enums are closed. Using a union with the base scalar(string, int32, int64, etc.) as a variant instead of an enum makes it extensible.

❌ Incorrect

Section titled “❌ Incorrect”
enum PetKind {
  Cat,
  Dog,
}

✅ Correct

Section titled “✅ Correct”
union PetKind {
  Cat: "Cat",
  Dog: "Dog",
  string,
}

Ok. Enum is allowed for versioning purposes.

enum Version {
  2021_01_01: "2021-01-01",
  2022_01_01: "2022-01-01",
}