Skip to content

chore(deps): upgrade openapi-generator to v6 APIC-502 #685

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Jun 15, 2022
Merged

chore(deps): upgrade openapi-generator to v6 APIC-502 #685

merged 7 commits into from
Jun 15, 2022

Conversation

millotp
Copy link
Collaborator

@millotp millotp commented Jun 13, 2022 •
edited
Loading

🧭 What and Why

🎟 JIRA Ticket: APIC-502

Upgrade openapi-generator to v6, this changes a lot of model name because every nested object in the spec get prefixed with Inner now, and it's very ugly so I had to rename everything with something clearer, maybe we could enforce that with eslint.
There isn't that many changes generators side, some simplification and less type casting.
The behavior of the additionalProperties: true changed from being interpreted as Object to AnyType so some of our gen broke and I had to override some method for java. Python should also be impacted by this, so let's not forget those changes.

🧪 Test

CI

@millotp millotp self-assigned this Jun 13, 2022
@netlify
Copy link

netlify bot commented Jun 13, 2022 •
edited
Loading

✅ Deploy Preview for api-clients-automation ready!

Name Link
🔨 Latest commit 6ea46f0
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/62a9b1ee5f1d9400080ca196
😎 Deploy Preview https://deploy-preview-685--api-clients-automation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@algolia-bot
Copy link
Collaborator

algolia-bot commented Jun 13, 2022 •
edited
Loading

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

@millotp millotp force-pushed the chore/openapi-generator-v6 branch from 85239e9 to 9fe5ef1 Compare June 14, 2022 15:57
@millotp millotp marked this pull request as ready for review June 14, 2022 16:29
@millotp millotp requested review from shortcuts and damcou and removed request for shortcuts June 14, 2022 16:29
shortcuts
shortcuts requested changes Jun 15, 2022
View reviewed changes
Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

Looks really clean! Some suggestions on the model name

the blocker is only here because some unwanted files are deleted, waiting for #693

specs/analytics/paths/search/getUsersCount.yml Outdated
@@ -29,6 +29,7 @@ get:
description: A list of users count with their date.
items:
type: object
title: analyticsUser
Copy link
Member

Choose a reason for hiding this comment

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

UserWithDate?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

userWithDateAndCount ? I feel like for a lot of those it doesn't bring value to say their properties in their name, that's why I choose to prefix by analytics

Copy link
Member

Choose a reason for hiding this comment

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

IMO as we are in an Analytics context, we don't need to prefix it, I'd rather see UserWithAnalaytics or descriptive like you suggested

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm fine with userWithDateAndCount

damcou
damcou reviewed Jun 15, 2022
View reviewed changes
Copy link
Contributor

@damcou damcou left a comment

Choose a reason for hiding this comment

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

Looks good. If it was me, I would be more specific for naming things (see my suggestions), but I'll let you decide if you prefer yours. Just make sure to stay consistent with the use of lowercase for the first letter.

specs/analytics/paths/click/getClickThroughRate.yml Outdated
@@ -35,6 +35,7 @@ get:
description: A list of click-through rate events with their date.
items:
type: object
title: clickEvent
Copy link
Contributor

Choose a reason for hiding this comment

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

clickThroughRateEvent ?

specs/analytics/paths/search/getSearchesCount.yml
@@ -29,6 +29,7 @@ get:
description: A list of search events with their date and count.
items:
type: object
title: searchEvent
Copy link
Contributor

Choose a reason for hiding this comment

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

searchCountEvent ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

we say A list of search events in the description, not sure what search count event mean

specs/analytics/paths/search/getUsersCount.yml Outdated
@@ -29,6 +29,7 @@ get:
description: A list of users count with their date.
items:
type: object
title: analyticsUser
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm fine with userWithDateAndCount

shortcuts
shortcuts approved these changes Jun 15, 2022
View reviewed changes
Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

love it!

@millotp millotp merged commit 1e27a28 into main Jun 15, 2022
@millotp millotp deleted the chore/openapi-generator-v6 branch June 15, 2022 12:02
@damcou damcou mentioned this pull request Jun 20, 2022
Closed
This was referenced Jun 20, 2022
Closed
Closed
@damcou damcou mentioned this pull request Jun 21, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@damcou damcou damcou left review comments

@shortcuts shortcuts shortcuts approved these changes

Assignees

@millotp millotp

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@millotp @algolia-bot @damcou @shortcuts