SynonymMap model should take IEnumerable<string> for synonyms

The generated model for SynonymMap takes a single string for synonyms, which the user would then have to pass with newlines embedded. This “magic formula” approach is something we try to avoid and just make it obvious and idiomatic. Guidelines recommend instead taking an IEnumerable<string> for the parameter and perhaps define the property as an IList<string> to allow adding to it. The de/serializer should handle splitting and joining with newlines accordingly.

/cc @brjohnstmsft

[brjohnstmsft]

Talked with @Yahnoosh about this. Here’s the summary:

• Synonym maps are usually authored as text files, and often imported from another system.
• The REST API documentation is misleading about newline always being the separator – that actually depends on the format. For now, we only support the SOLR format, and newline is the delimiter for that format.
• Stream makes sense as a way to ingest synonym map files on Create/CreateOrUpdate. However, the single-string property in the SynonymMap object should also be an option, if for no other reasons that demos/samples and the Get/List APIs.

Please let me know if you have any questions.

[brjohnstmsft]

@heaths Having a constructor that takes a Stream or TextReader makes sense. I think it’s a pretty safe assumption that it will always be text, so TextReader is probably fine.

Taking format as a parameter is problematic right now because there is only one allowable value (it should be an enum and not a string BTW). We hide it in Track 1 because it’s pointless for users to have to pass the same value all the time. If we can add it as an additional parameter (or constructor overload) later, IMO we can leave it out for now.

I would actually question the value of the third constructor rather than the second. If the map isn’t coming from a file, it’s probably being pasted from somewhere else. Constructing it programmatically line-by-line is useful for samples, but that’s about it. CC @Yahnoosh who can back me up on this.