[2.0] Multiple tags generates multiple operations

[Toilal]

When generating JaxRS Server with Swagger, operations with multiple tags are generated twice.

This seems to be quite the same as #356.

[Toilal]

Current workaround to keep a single Tag on each operation.

...
Swagger swagger = new SwaggerParser().read(inputSpec, clientOptInput.getAuthorizationValues(), true);
workaround(swagger);
new DefaultGenerator().opts(clientOptInput.opts(clientOpts).swagger(swagger)).generate();
...

protected void workaround(Swagger swagger) {
    for (Path path : swagger.getPaths().values()) {
        for (Operation op : path.getOperations()) {
            Iterator<String> iterator = op.getTags().iterator();
            boolean first = true;
            while (iterator.hasNext()) {
                if (first) {
                    first = false;
                } else {
                    iterator.remove();  
                }
                iterator.next();
            }
        }
    }
}

[webron]

@olensmar?

[olensmar]

i'll check it out - @Toilal do you have a swagger definition that I can use for testing?

[Toilal]

Try to set 2 tags on any operation in pet sample.

i'll check it out - @Toilal https://github.com/Toilal do you have a
swagger definition that I can use for testing?

—
Reply to this email directly or view it on GitHub
#820 (comment)
.

[olensmar]

This is actually per design (!) - although it doesn't really align with the idea behind tags in Swagger 2.0 at all (to allow for grouping of operations for whatever reason) - I suggest we remove this behaviour for now (i.e. just generate a single operation and ignore the tags) and open a separate issue for rethinking how tags should be applied with generating code...

@webron @Toilal thoughts?

[webron]

For a single-class implementation, it doesn't make sense to have duplicates, though perhaps @fehguy remembers a reason that I don't.

Eventually, the tags should be used to split the operations into multiple classes and then it would make sense (in some cases) to duplicate the operations.

[Toilal]

👍

I'm a new user to swagger and swagger-codegen, but it really doesn't make sense to generate operations multiple times in my case ...

[Toilal]

IMHO, i think tags should never affects generated code.

Maybe tags could only be displayed in javadoc of generated operations, or using a swagger annotation ...

[olensmar]

ok - i'll remove the logic that creates an operation once for each tag - hope this doesn't break things for anyone... @fehguy any thoughts?

[fehguy]

That would break things. @Toilal can you please explain more? The intention of mapping operations to tags does create potentially multiple operations but that is the intent. You can always override the grouping logic.

[Toilal]

How to override this logic ? (without implementing a new language ...)

When using multiple tags in swagger editor, it doesn't creates multiple operations in the docs. It only display the tags on the operation, and a filtering capabitilities. As a "naive" user, that's what I expect in swagger-codegen too.

If I tag an operation with both tag1 and tag2, it doesn't make sense to have distinct implementations for the operation.

Maybe it could generate 2 distinct resources (tag1 and tag2) delegating to the same operation implementation, but currently is creates 2 distinct operations in the same resource.

Issue can be reproduced on http://editor.swagger.io. Load the following yaml and generate JaxRS server. Generated PetsApi resource contains two methods : findPets(...) and findPets_1(...), because of the defined tags.

swagger: '2.0'
info:
  version: '1.0.0'
  title: Swagger Petstore (Simple)
  description: A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification
  termsOfService: http://helloreverb.com/terms/
  contact:
    name: Swagger API team
    email: foo@example.com
    url: http://swagger.io
  license:
    name: MIT
    url: http://opensource.org/licenses/MIT
host: petstore.swagger.wordnik.com
basePath: /api
schemes:
  - http
consumes:
  - application/json
produces:
  - application/json
paths:
  /pets:
    get:
      description: Returns all pets from the system that the user has access to
      operationId: findPets
      tags:
        - tag1
        - tag2
      produces:
        - application/json
        - application/xml
        - text/xml
        - text/html
      parameters:
        - name: tags
          in: query
          description: tags to filter by
          required: false
          type: array
          items:
            type: string
          collectionFormat: csv
        - name: limit
          in: query
          description: maximum number of results to return
          required: false
          type: integer
          format: int32
      responses:
        '200':
          description: pet response
          schema:
            type: array
            items:
              $ref: '#/definitions/pet'
        default:
          description: unexpected error
          schema:
            $ref: '#/definitions/errorModel'
    post:
      description: Creates a new pet in the store.  Duplicates are allowed
      operationId: addPet
      produces:
        - application/json
      parameters:
        - name: pet
          in: body
          description: Pet to add to the store
          required: true
          schema:
            $ref: '#/definitions/newPet'
      responses:
        '200':
          description: pet response
          schema:
            $ref: '#/definitions/pet'
        default:
          description: unexpected error
          schema:
            $ref: '#/definitions/errorModel'
  /pets/{id}:
    get:
      description: Returns a user based on a single ID, if the user does not have access to the pet
      operationId: findPetById
      produces:
        - application/json
        - application/xml
        - text/xml
        - text/html
      parameters:
        - name: id
          in: path
          description: ID of pet to fetch
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: pet response
          schema:
            $ref: '#/definitions/pet'
        default:
          description: unexpected error
          schema:
            $ref: '#/definitions/errorModel'
    delete:
      description: deletes a single pet based on the ID supplied
      operationId: deletePet
      parameters:
        - name: id
          in: path
          description: ID of pet to delete
          required: true
          type: integer
          format: int64
      responses:
        '204':
          description: pet deleted
        default:
          description: unexpected error
          schema:
            $ref: '#/definitions/errorModel'
definitions:
  pet:
    required:
      - id
      - name
    properties:
      id:
        type: integer
        format: int64
      name:
        type: string
      tag:
        type: string
  newPet:
      required:
        - name
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        tag:
          type: string
  errorModel:
    required:
      - code
      - message
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string

[Toilal]

Even worse, it generates two @get functions for the same @path in PetsApi resource. This can't be loaded in any JaxRS implementation.

[webron]

Tags in the spec were meant to replace and expand resources in previous versions.

The way I see it, for clients, I'd expect each tag to translate to a class/controller and contain its operations, so an operation can be duplicated across classes but not inside the same class.

For servers, this will most likely not make sense though, but if we do split it among classes, it's hard to say where it should be included. I agree it doesn't make sense to have multiple occurrences within the same class though.

[olensmar]

then the short-term solution is removing tag-handling in the jaxrs-server codegen for now... especially if the generated code currently doesn't work at all...