Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

5.0 release (beta) #113

Open
vmasek opened this issue Dec 22, 2020 · 10 comments
Open

5.0 release (beta) #113

vmasek opened this issue Dec 22, 2020 · 10 comments
Labels
discussion Enhancement or issue should be discussed and validated help wanted This issue is open for contributions in form of PR or specification
Projects
Milestone

Comments

@vmasek
Copy link
Member

vmasek commented Dec 22, 2020

Beta version of the generator has been released, it brings many fixes and improvements. Please test this version and report inconsistencies/bugs so we can fix them for the final release

@vmasek vmasek added help wanted This issue is open for contributions in form of PR or specification discussion Enhancement or issue should be discussed and validated labels Dec 22, 2020
@vmasek vmasek added this to the 5.0 milestone Dec 22, 2020
@vmasek vmasek added this to To do in Main board via automation Dec 22, 2020
@vmasek vmasek pinned this issue Dec 22, 2020
@Mvrlex
Copy link

Mvrlex commented Feb 15, 2021

Is this the release that adds OpenApi 3.0 support?
Would love to test it.

@vmasek
Copy link
Member Author

vmasek commented Feb 16, 2021

Hi, OA3.0 is not part of the 5.0 release (yet), I'm preparing the codebase for it, but I'll need to broader up the test suite and also decide if we'll support both versions side by side or convert v2 to v3 before generating (2nd is preferred).

It would help if you could share what API are you planning to use the generator on (if can be shared). Feel free to reach out via email. If your definition is not sharable, my call for public OA3.0+ version API definitions is still on :shipit:

@hoebbelsB
Copy link

hoebbelsB commented Feb 23, 2021

@vmasek I have just transitioned from 4.x to beta-5. Everything seems to work fine and i got rid of circular dependencies which appeared with version 4.x.

Should I be aware of any breaking changes in behavior that I am missing right now?

@vmasek
Copy link
Member Author

vmasek commented Feb 24, 2021

@hoebbelsB only breaking change there should be at this moment are moved interfaces mentioned here https://github.com/flowup/api-client-generator/releases/tag/5.0.0-beta.0

There might be more to come but I'll try to keep it on a minimum for the final release.

@hoebbelsB
Copy link

thanks :)

@Mvrlex
Copy link

Mvrlex commented Mar 2, 2021

A hiccup I just encountered: query-param lists are now generated as ?param=value,value whereas previously he would generate ?param=value&param=value

But that's probably something that we will just change in our api.

@vmasek
Copy link
Member Author

vmasek commented Mar 3, 2021

@Mvrlex CSV format is the default in angular and we currently don't support a multiple of them. But this is something that I'd like very much for the final release as it is usual that backends don't support all of them.

It is documented in this issue #104

@vmasek
Copy link
Member Author

vmasek commented Mar 3, 2021

@Mvrlex could you have a look on your swagger file if there is collectionFormat set to multi so we know it starts autodetecting the format after the feature lands?

@Mvrlex
Copy link

Mvrlex commented Mar 3, 2021

@Mvrlex could you have a look on your swagger file if there is collectionFormat set to multi so we know it starts autodetecting the format after the feature lands?

Adding the collectionFormat unfortunately did not change the generation behaviour.

This is the input (obscured):

/v0/bla:
  get:
    operationId: getBla
    parameters:
      - name: expandables
        in: query
        type: array
        collectionFormat: multi
        items:
          type: string
          enum: [val1, val2]
        required: false

This is the output:

if ('expandables' in args) {
  options.params = options.params.set('expandables', String(args.expandables));
}

@vmasek
Copy link
Member Author

vmasek commented Mar 3, 2021

@Mvrlex thanks, I'll try to have a look at this feature soon as it is definitely needed for the release and needs to be tested in time :shipit:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Enhancement or issue should be discussed and validated help wanted This issue is open for contributions in form of PR or specification
Projects
Status: To do
Development

No branches or pull requests

3 participants