@amarzavery Why can't this "enum-as-constant" behavior be opt-in? If I put modelAsString: false in my spec, AutoRest should always respect it when the target language supports enums. Instead, right now my model type that uses my single-valued enum now uses string instead of the enum type. In the following code, searchMode should be of an enum type:

        /// <summary>
        /// Initializes a new instance of the Suggester class.
        /// </summary>
        public Suggester(string name, string searchMode, IList<string> sourceFields)
        {
            Name = name;
            SearchMode = searchMode;
            SourceFields = sourceFields;
        }

        /// <summary>
        /// Gets or sets the name of the suggester.
        /// </summary>
        [JsonProperty(PropertyName = "name")]
        public string Name { get; set; }

        /// <summary>
        /// Gets or sets a value indicating the capabilities of the suggester.
        /// </summary>
        [JsonProperty(PropertyName = "searchMode")]
        public string SearchMode { get; set; }

In the future when you add more values to the Enum, then it is abreaking change any way. So does the mechanism of breaking change ["Constant --> Enum with multiple value" OR "Single value Enum --> Multiple Value Enum" ] matter so much ?

Yes, it does matter, because you're creating more work for customers to upgrade to the newer library.

I freely admit that it's lame having a single-valued enum, and it was premature generalization on our part when we designed the API. That said, we have shipped that API and a .NET client that models SuggestSearchMode as an enum, and it really sucks that this is now broken.

Please be careful when making such changes to AutoRest. They really need to be opt-in.

Generate enums even with 1 value #783

Description

stankovskiopenedon Mar 3, 2016

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

stankovski
openedon Mar 3, 2016