autorest: Follow-up for 653 Issue - Duplicate operationIds and underscore symbol - AutoRest has a bug around underscores

If you need a case study for why verb_another_verb_whatever etc is going to continue then look no further than EVE Online - https://esi.tech.ccp.is/latest/swagger.json?datasource=tranquility

Point is if you’re going to walk into this entire “AutoRest” with the attitude of “if its not within our bubble, its not at all” then you’ve learned nothing from our days with SOAP.

Deferring for “stable” is also a weak avoidance behaviour. Address the issue and keep this open until you’ve confined the solution to a reasonable approach. GitHub isn’t Microsoft Connect and the days of when we used to triage problematic issues like this with “as per design” or “deferred to x” isn’t going to work with OSS space.

This is how you bank hate debt with developers.

I have never been a fan of the implicit decision in AutoRest to parse the operationId and use that as the basis for choosing “method-group” and “method” names. Seems kinda hacky to me to begin with.

AutoRest is replete with implicit assumptions … such is the life when you inherit a codebase.

Later this week, we’re starting work on an overhauled configuration system that will make it simpler to override behavior in the code generation process (by providing an external file that contains the information to the generator), without having to edit the swagger file itself (which helps not only @bowman-jm 's scenario of an automated swagger generation, but others who don’t want to pollute the swagger with information that doesn’t really describe the wire-behavior)

It should not be terribly difficult to provide an override for methodgroup and method name on a per-operation basis in there.

We should be using Tags first, then OpId.

Though, the way @centur describes the Verb and Noun both containing underscores worries me a bit. It seems like this will end up with some pretty nasty names. How do you decide where the noun and the verb are with something like: Nou_n_V_er_b? If you have undefined number of _, then building nice names from OperationIds is going to be pretty gnarly. Do you then got to where Capitalizations are? I don’t really want to play that game, b/c I don’t think we will ever make everyone happy.

I think we should do the following:

1. Use Tags for groups, then the full OpId in the language normalized form.
2. If no Tags, then use OpIds where the group is the first substring before the first _, and the operation name is the language normalized form of the substring after the first _.

The

So… there is a way to handle this now without changing AutoRest itself (and at this point, I’m not inclined to revisit decisions made prior to me taking over the project).

If you switch to using a configuration file for running AutoRest (use autorest init to get an example) , you can use a directive to modify the model.

Make a readme.md in your folder something like this:

# MyPetStore
> see https://aka.ms/autorest

This is the AutoRest configuration file for the MyPetstore.

---
## Getting Started 
To build the SDK for MyPetstore  simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run:

> `autorest`

To see additional help and options, run:
 
> `autorest --help`
---

#### Basic Information 
These are the global settings for MyAPI.

``` yaml
# list all the input OpenAPI files (may be YAML, JSON, or Literate- OpenAPI markdown)
input-file:
  - petstore.json

# this allows you to programatically tweak the swagger file before it is modeled.
directive:
  from: swagger-document # do it globally 
  where: $.paths.*.* 
  
  # if every operation has a tag, you can be simple:
  transform: $.operationId = `${$.tags[0]}_${$.operationId}`
  
  # otherwise if you have some things that don't have a `tags` use this:
  # transform: $.operationId = `${( $.tags || [] )[0] || "some_prefix_here" }_${$.operationId}`  
   
```

---
#### Language-specific settings: CSharp

These settings apply only when `--csharp` is specified on the command line.

``` yaml $(csharp) 
csharp:
  namespace: My.PetStore
```

and then run

autorest --csharp readme.md

and it will use the first tag for each operation as the group name.