Skip to content

Conversation

@etherealjoy
Copy link
Contributor

@etherealjoy etherealjoy commented Mar 9, 2019

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh, ./bin/security/{LANG}-petstore.sh and ./bin/openapi3/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

  • add support for enum for Qt5 client and server
  • extend tests for Qt5 client

Spec used for testing client and server

---
# This is a sample Swagger spec, describing a simple API as a starting point.
swagger: "2.0"
info:
  description: Template Description
  version: 1.0.0
  title: Testspec


host: 0.0.0.0:8080
basePath: /api
schemes:
- http

paths:
  /v1.0/testintenum:
    get:
      description: ""
      operationId: testintenum
      responses:
        200:
          description: "Successful response"
          schema:
            $ref: '#/definitions/intEnum'
        400:
          description: "The request was not successfully executed."

  /v1.0/teststringenum:
    get:
      description: ""
      operationId: teststringenum
      responses:
        200:
          description: "Successful response"
          schema:
            $ref: '#/definitions/stringEnum'
        400:
          description: "The request was not successfully executed."

  /v1.0/testintenum1:
    get:
      description: ""
      operationId: testintenum1
      responses:
        200:
          description: "Successful response"
          schema:
            type: object
            additionalProperties:            
              $ref: '#/definitions/intEnum'
        400:
          description: "The request was not successfully executed."

  /v1.0/teststringenum1:
    get:
      description: ""
      operationId: teststringenum1
      responses:
        200:
          description: "Successful response"
          schema:
            type: array
            items:
              $ref: '#/definitions/stringEnum'
        400:
          description: "The request was not successfully executed."          

  /v1.0/test:
    get:
      description: ""
      operationId: test
      responses:
        200:
          description: "Successful response"
          schema:
            $ref: '#/definitions/enumeration'
        400:
          description: "The request was not successfully executed."

definitions:
  stringEnum:
    description: "string enum"
    enum:
      - abc
      - def
      - ghi
    type: string

  intEnum:
    description: "integer enum"
    enum:
      - 1
      - 2
      - 3
    type: integer

  enumeration:
    type: object
    description: "string enum"
    properties:
      enint:
        $ref: '#/definitions/intEnum'
      enstr:
        $ref: '#/definitions/stringEnum'
      enarr:
        type: array
        items:
          $ref: '#/definitions/stringEnum'
      enaobj:
        type: object
        additionalProperties:
          $ref: '#/definitions/intEnum'     

cc:
@stkrwork @MartinDelille @fvarose @ravinikam

Copy link
Contributor

@MartinDelille MartinDelille left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I looked at your PR by executing the openapi 3 script
locally and I wondered why the petstore example wasn't updated accordingly since it declare enum like here: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml#L74-L77

@etherealjoy
Copy link
Contributor Author

etherealjoy commented Mar 16, 2019

Yes, unfortunately this enum is inside the query.
I was wondering what to do here, since support for objects in query also is not yet supported
As a next step we could add object and enum support in queries/headers

@etherealjoy
Copy link
Contributor Author

@stkrwork @MartinDelille @fvarose @ravinikam
Any objections if we go ahead with this and add improvements later?

@wing328
Copy link
Member

wing328 commented Mar 30, 2019

Any objections if we go ahead with this and add improvements later?

Let's go with this approach.

@wing328 wing328 merged commit 3bb4edf into OpenAPITools:master Mar 30, 2019
@etherealjoy etherealjoy deleted the cppqt5_enum_support branch March 30, 2019 08:46
@etherealjoy etherealjoy added this to the 4.0.0 milestone Mar 30, 2019
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Apr 1, 2019
* master: (48 commits)
  [Typescript AngularJS] fix Extra package prefix in api parameters operations (OpenAPITools#2522)
  OpenAPITools#1023 - [Scala] Use status family during response processing (OpenAPITools#1024)
  Generate setters for readonly properties in server code (OpenAPITools#1582)
  [JS] fix NPE for null string and improve Travis config file (OpenAPITools#2553)
  [elm] Update ISO 8601 library (fixes missing time zone designator) (OpenAPITools#2545)
  [csharp] update sample after OpenAPITools#2528 (OpenAPITools#2550)
  [JavaScript] fix index.js, ApiClient.js and test files generated to incorrect location (OpenAPITools#2511)
  Aspnetcore nullable support (OpenAPITools#2529)
  Csharp nullable support (OpenAPITools#2528)
  [C++] [Qt5] Add enum support for client and server (OpenAPITools#2339)
  Fixed typo in migration-from-swagger-codegen.md (OpenAPITools#2548)
  [TypeScript Client] fix install Aurelia + fix use deprecated function (OpenAPITools#2514)
  [KOTLIN] fix var name not correctly sanitized (OpenAPITools#2537)
  Update swagger-parser to '2.0.11-OpenAPITools.org-1' (OpenAPITools#2262)
  Add @karismann to Java and Kotlin technical committee (OpenAPITools#2542)
  Add GoDaddy to the list of companies using OpenAPI Generator (OpenAPITools#2541)
  [Kotlin SpringBoot Server] alternative: fix optional parameter not correctly declared in service (OpenAPITools#2539)
  improve indentation, update dependencies (OpenAPITools#2521)
  update kotlin spring samples
  [JAVA] Use specified data type in enum's fromValue instead of string (OpenAPITools#2347)
  ...
jimschubert added a commit that referenced this pull request Apr 2, 2019
* master: (133 commits)
  #2503: fix out-of-memory issue with nested objects with arrays with maxItems set by limiting to max. 5 example items (#2536)
  remove emitDefaultValue option (#2559)
  fix EmitDefaultValue default vallue with false (#2558)
  Added API Key auth to rust-server (#2459)
  remove initialCaps and replace with camelize (#2546)
  Add packageName configuration to maven (#2429)
  [Typescript AngularJS] fix Extra package prefix in api parameters operations (#2522)
  #1023 - [Scala] Use status family during response processing (#1024)
  Generate setters for readonly properties in server code (#1582)
  [JS] fix NPE for null string and improve Travis config file (#2553)
  [elm] Update ISO 8601 library (fixes missing time zone designator) (#2545)
  [csharp] update sample after #2528 (#2550)
  [JavaScript] fix index.js, ApiClient.js and test files generated to incorrect location (#2511)
  Aspnetcore nullable support (#2529)
  Csharp nullable support (#2528)
  [C++] [Qt5] Add enum support for client and server (#2339)
  Fixed typo in migration-from-swagger-codegen.md (#2548)
  [TypeScript Client] fix install Aurelia + fix use deprecated function (#2514)
  [KOTLIN] fix var name not correctly sanitized (#2537)
  Update swagger-parser to '2.0.11-OpenAPITools.org-1' (#2262)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants