swagger-api/swagger-codegen

JavaScript: Errornous generation of param types in JSDoc for enum and array typed parameters

Open

#2925 aperta il 20 mag 2016

Vedi su GitHub
 (5 commenti) (0 reazioni) (0 assegnatari)HTML (5474 fork)batch import
Client: JavaScript/Node.jsFeature: DocumentationIssue: Bughelp wanted

Metriche repository

Star
 (12.701 star)
Metriche merge PR
 (Merge medio 4h 43m) (10 PR mergiate in 30 g)

Descrizione

Description

This is generated

    /**
     * Массовые операции над объектами клиентов
     * @param {Array.<module:model/Integer>} objectsList Список идентификаторов объектов для массовой операции
     * @param {module:model/String} operation Тип операции
     * data is of type: {Array.<module:model/BatchResults>}
     */

But should be something like this:

    /**
     * Массовые операции над объектами клиентов
     * @param {Number[]} objectsList Список идентификаторов объектов для массовой операции
     * @param {String} operation Тип операции
     * data is of type: {Array.<module:model/BatchResults>}
     */

Source spec for this part is:

  /batch/clients/{operation}:
    put:
      summary: "Массовые операции над объектами клиентов"
      operationId: "batch_clients"
      parameters:
        - name: "objects_list"
          description: "Список идентификаторов объектов для массовой операции"
          required: true
          schema:
            type: "array"
            items:
              type: "integer"
              format: "int64"
              description: "Идентификатор объекта"
          in: "body"
        - name: "operation"
          description: "Тип операции"
          required: true
          type: "string"
          enum:
            - 'reload'
            - 'reboot'
            - 'shutdown'
          in: "path"
      responses:
        200:
          description: ""
          schema:
            type: "array"
            items:
              $ref: BatchResults
Swagger-codegen version

Latest master.

Swagger declaration file content or url

https://gist.github.com/arikon/2f078fcf15aae07984c7e1d35def90bf

Command line used for generation
SWAGGER_JSON=swagger-new.json
SWAGGER_OUTPUT=sandbox-json-api

export JAVA_HOME=$(/usr/libexec/java_home -v 1.7)
export PATH=${JAVA_HOME}/bin:$PATH

java -jar swagger-codegen/modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
    -i ${SWAGGER_JSON} \
    -l javascript \
    -o ${SWAGGER_OUTPUT} \
    --additional-properties usePromises=true
Steps to reproduce
Related issues
Suggest a Fix

Guida contributor