Add more examples of nameOverrides to docs

[edorphy]

Question

I'm using the generator against App Store Connect API. I have the namingStrategy set to idiomatic and this produces really fun parameters such as the /v1/apps filter parameter of

                public init(
                    filter_lbrack_name_rbrack_: [Swift.String]? = nil,
                    filter_lbrack_bundleId_rbrack_: [Swift.String]? = nil,
                    filter_lbrack_sku_rbrack_: [Swift.String]? = nil,

The API is riddled with filter[something] query parameters so I'm not entirely sure if I want to sign up for the endeavor, but, gotta get one rename to work. I am not finding much in the way of documentation here so I could be doing something entirely wrong or simply not supported.
https://github.com/search?q=repo%3Aapple%2Fswift-openapi-generator%20nameOverrides&type=code

This is the only reference I could find showing an example:

swift-openapi-generator/Sources/swift-openapi-generator/Documentation.docc/Proposals/SOAR-0013.md

Lines 143 to 147 in 0bd6d84

	```yaml
	nameOverrides:
	'+1': 'thumbsUp'
	'-1': 'thumbsDown'
	```

So I tried this, but without any success.

nameOverrides:
  'filter_lbrack_name_rbrack_': 'filterName'

Here is an excerpt from the ASC open api spec:

  /v1/apps:
    get:
      tags:
        - Apps
      operationId: apps_getCollection
      parameters:
        - name: filter[name]
          in: query
          description: filter by attribute 'name'
          schema:
            type: array
            items:
              type: string
          style: form
          explode: false
          required: false
        - name: filter[bundleId]
          in: query
          description: filter by attribute 'bundleId'
          schema:
            type: array
            items:
              type: string
          style: form
          explode: false
          required: false
        - name: filter[sku]
          in: query
          description: filter by attribute 'sku'
          schema:
            type: array
            items:
              type: string
          style: form
          explode: false
          required: false

[czechboy0]

Hi @edorphy,

you need to provide the original name from the OpenAPI doc, so:

nameOverrides:
  'filter[name]': 'filterName'

[edorphy]

@czechboy0

Thanks! That sure did the trick.

Would you consider this an enhancement request to add more details to the documentation or example projects to help other newcomers?

[czechboy0]

Sure, updated 🙂