[Rust] Add support for discriminator by gferon · Pull Request #3895 · OpenAPITools/openapi-generator

gferon · 2019-09-16T15:17:07Z

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 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\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
Filed the PR against the correct branch: master, 4.1.x, 5.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 the discriminator feature of OpenAPI 3, and implement it with enum in Rust
Add all missing explicit dyn to trait types to remove warnings
Add missing re-export for properties that are enum (was missing from Add enum support to rust and skip none option serialization in clients #2244).

Example

A schema that looks like:

components:
  schemas:
    Pet:
      type: object
      required:
      - pet_type
      properties:
        pet_type:
          type: string
      discriminator:
        propertyName: pet_type
        mapping:
          cachorro: Dog
          reptilian: Lizard
    Cat:
      allOf:
      - $ref: '#/components/schemas/Pet'
      - type: object
        # all other properties specific to a `Cat`
        properties:
          name:
            type: string
    Dog:
      allOf:
      - $ref: '#/components/schemas/Pet'
      - type: object
        # all other properties specific to a `Dog`
        properties:
          bark:
            type: string
    Lizard:
      allOf:
      - $ref: '#/components/schemas/Pet'
      - type: object
        # all other properties specific to a `Lizard`
        properties:
          lovesRocks:
            type: boolean

would generate a Rust enum like:

#[derive(Debug, PartialEq, Serialize, Deserialize)]
#[serde(tag = "pet_type")]
pub enum Pet {
    #[serde(rename="cachorro")]
    Dog {
        #[serde(rename = "bark", skip_serializing_if = "Option::is_none")]
        bark: Option<String>,
    },
    #[serde(rename="reptilian")]
    Lizard {
        #[serde(rename = "lovesRocks", skip_serializing_if = "Option::is_none")]
        loves_rocks: Option<bool>,
    },
}

Co-authored-by: Adi Ritman <55248441+ritmanadi@users.noreply.github.com>

wing328 · 2019-09-16T16:59:14Z

Errors reported by the Travis CI:

   Checking tokio-threadpool v0.1.15
    Checking tokio-udp v0.1.5
    Checking tokio-uds v0.2.5
    Checking tokio-tcp v0.1.3
    Checking tokio-fs v0.1.6
    Checking tokio v0.1.22
    Checking tokio-core v0.1.17
   Compiling serde_derive v1.0.101
    Checking tokio-proto v0.1.1
    Checking hyper v0.11.27
    Checking petstore_client v1.0.0 (/home/travis/build/OpenAPITools/openapi-generator/samples/client/petstore/rust)
error[E0252]: the name `Status` is defined multiple times
  --> src/models/mod.rs:10:9
   |
7  | pub use self::order::Status;
   |         ------------------- previous import of the type `Status` here
...
10 | pub use self::pet::Status;
   |         ^^^^^^^^^^^^^^^^^ `Status` reimported here
   |
   = note: `Status` must be defined only once in the type namespace of this module
help: you can use `as` to change the binding name of the import
   |
10 | pub use self::pet::Status as OtherStatus;
   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
warning: unreachable expression
   --> src/apis/pet_api.rs:107:9
    |
107 | /         __internal_request::Request::new(hyper::Method::Post, "/pet/{petId}/uploadImage".to_string())
108 | |             .with_auth(__internal_request::Auth::Oauth)
109 | |             .with_path_param("petId".to_string(), pet_id.to_string())
110 | |             .with_form_param("additionalMetadata".to_string(), additional_metadata.to_string())
111 | |             .with_form_param("file".to_string(), unimplemented!())
    | |__________________________________________________________________^
    |
    = note: #[warn(unreachable_code)] on by default
error: aborting due to previous error
For more information about this error, try `rustc --explain E0252`.
error: Could not compile `petstore_client`.

ref: https://travis-ci.org/OpenAPITools/openapi-generator/builds/585652775

We can't re-export those types because their name is derived from the property name, which might be duplicated.

gferon · 2019-09-16T18:41:08Z

Errors reported by the Travis CI:

   Checking tokio-threadpool v0.1.15
    Checking tokio-udp v0.1.5
    Checking tokio-uds v0.2.5
    Checking tokio-tcp v0.1.3
    Checking tokio-fs v0.1.6
    Checking tokio v0.1.22
    Checking tokio-core v0.1.17
   Compiling serde_derive v1.0.101
    Checking tokio-proto v0.1.1
    Checking hyper v0.11.27
    Checking petstore_client v1.0.0 (/home/travis/build/OpenAPITools/openapi-generator/samples/client/petstore/rust)
error[E0252]: the name `Status` is defined multiple times
  --> src/models/mod.rs:10:9
   |
7  | pub use self::order::Status;
   |         ------------------- previous import of the type `Status` here
...
10 | pub use self::pet::Status;
   |         ^^^^^^^^^^^^^^^^^ `Status` reimported here
   |
   = note: `Status` must be defined only once in the type namespace of this module
help: you can use `as` to change the binding name of the import
   |
10 | pub use self::pet::Status as OtherStatus;
   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
warning: unreachable expression
   --> src/apis/pet_api.rs:107:9
    |
107 | /         __internal_request::Request::new(hyper::Method::Post, "/pet/{petId}/uploadImage".to_string())
108 | |             .with_auth(__internal_request::Auth::Oauth)
109 | |             .with_path_param("petId".to_string(), pet_id.to_string())
110 | |             .with_form_param("additionalMetadata".to_string(), additional_metadata.to_string())
111 | |             .with_form_param("file".to_string(), unimplemented!())
    | |__________________________________________________________________^
    |
    = note: #[warn(unreachable_code)] on by default
error: aborting due to previous error
For more information about this error, try `rustc --explain E0252`.
error: Could not compile `petstore_client`.

ref: https://travis-ci.org/OpenAPITools/openapi-generator/builds/585652775

good catch, sorry for that. I've adapted my changes.

gferon · 2019-09-16T18:43:07Z

Pinging @bjgill and @richardwhiuk for a review

bjgill · 2019-09-17T11:54:14Z

Thanks. I'm quite busy this week, so will take a look next week unless this is urgent.

bjgill

Looks like a sensible change. Just a couple of questions.

FYI - I'm about to merge #3543, which will conflict with this. You should just need to regenerate the samples to sort out the conflicts.

samples/client/petstore/rust-reqwest/src/models/mod.rs

...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/RustClientCodegen.java

bjgill · 2019-09-27T15:28:34Z

I've just merged the conflicting PR. You should just need to rebase onto master and re-generate the samples again.

…nator

gferon · 2019-10-01T13:56:55Z

I've just merged the conflicting PR. You should just need to rebase onto master and re-generate the samples again.

Done, I added a small change to the template files to remove some clippy warnings as well.

bjgill · 2019-10-06T16:34:08Z

Thanks. I'll merge this, which should fix #4079

This patch includes: - Add all missing explicit dyn to trait types to remove warnings OpenAPITools/openapi-generator#3895 - Add missing re-export for properties that are enum OpenAPITools/openapi-generator#3895 - Handle optional parameters OpenAPITools/openapi-generator#4016 - Derive more traits borsboom/openapi-generator@4e3bc31

Built using borsboom/openapi-generator@4e3bc31 This patch includes: - Add all missing explicit dyn to trait types to remove warnings OpenAPITools/openapi-generator#3895 - Add missing re-export for properties that are enum OpenAPITools/openapi-generator#3895 - Handle optional parameters OpenAPITools/openapi-generator#4016 - Derive more traits borsboom/openapi-generator@4e3bc31

wing328 · 2019-10-31T09:25:25Z

@gferon thanks for the PR, which has been included in v4.2.0 release: https://twitter.com/oas_generator/status/1189824932345069569

Gabriel Féron and others added 3 commits September 16, 2019 17:04

Add explicit dyn to Rust rewqest client trait type

bd21ab1

Add Rust support for discriminator with enums containing a sub-structure

6b9f330

Co-authored-by: Adi Ritman <55248441+ritmanadi@users.noreply.github.com>

Regenerate Rust samples

96cca44

Make model mods pub, since we need to be able to access the enum inside.

3c1d778

We can't re-export those types because their name is derived from the property name, which might be duplicated.

gferon force-pushed the add-rust-discriminator branch from e3a81e4 to 3c1d778 Compare September 16, 2019 18:40

Fix tag name when the name is reserved

584bf53

bjgill reviewed Sep 25, 2019

View reviewed changes

samples/client/petstore/rust-reqwest/src/models/mod.rs Show resolved Hide resolved

...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/RustClientCodegen.java Show resolved Hide resolved

Gabriel Féron added 2 commits October 1, 2019 15:43

Merge remote-tracking branch 'upstream/master' into add-rust-discrimi…

0d4eb77

…nator

Regenerate rust samples and skip redundant field names

5e5a4e9

bjgill merged commit f96ed69 into OpenAPITools:master Oct 6, 2019

gferon deleted the add-rust-discriminator branch October 7, 2019 15:55

wing328 added Client: Rust Enhancement: Feature labels Oct 14, 2019

wing328 added this to the 4.2.0 milestone Oct 14, 2019

wing328 changed the title ~~Add rust discriminator~~ [Rust] Add support for discriminator Oct 30, 2019

denumerate mentioned this pull request Aug 3, 2021

[RUST] Excess structs generated when using descriminators #10089

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Rust] Add support for discriminator#3895

[Rust] Add support for discriminator#3895
bjgill merged 7 commits intoOpenAPITools:masterfrom
gferon:add-rust-discriminator

gferon commented Sep 16, 2019 •

edited

Loading

Uh oh!

wing328 commented Sep 16, 2019

Uh oh!

gferon commented Sep 16, 2019

Uh oh!

gferon commented Sep 16, 2019

Uh oh!

bjgill commented Sep 17, 2019

Uh oh!

bjgill left a comment

Uh oh!

Uh oh!

Uh oh!

bjgill commented Sep 27, 2019

Uh oh!

gferon commented Oct 1, 2019

Uh oh!

bjgill commented Oct 6, 2019

Uh oh!

wing328 commented Oct 31, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

gferon commented Sep 16, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR checklist

Description of the PR

Example

Uh oh!

wing328 commented Sep 16, 2019

Uh oh!

gferon commented Sep 16, 2019

Uh oh!

gferon commented Sep 16, 2019

Uh oh!

bjgill commented Sep 17, 2019

Uh oh!

bjgill left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bjgill commented Sep 27, 2019

Uh oh!

gferon commented Oct 1, 2019

Uh oh!

bjgill commented Oct 6, 2019

Uh oh!

wing328 commented Oct 31, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gferon commented Sep 16, 2019 •

edited

Loading