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

Move "description" out of "allOf" declaration #205

Merged

Conversation

maxl2287
Copy link
Collaborator

@maxl2287 maxl2287 commented Aug 17, 2023

What type of PR is this?

  • correction

What this PR does / why we need it:

We are currently discovering that by using an openapi generator the current version 0.9.0 of QoD causes problems by having the "description" inside of "allOf"-declaration

Which issue(s) this PR fixes:

Fixes #204

@maxl2287
Copy link
Collaborator Author

If there is a way to add it to v0.9.0 it would be quite good.

@RandyLevensalor
Copy link
Collaborator

@maxl2287 Please see comment in the issue.

Also, many of these AllOf statements were added specifically for the description and could be removed if we were to remove the description from the AllOf.

@hdamker
Copy link
Collaborator

hdamker commented Aug 25, 2023

Also, many of these AllOf statements were added specifically for the description and could be removed if we were to remove the description from the AllOf.

@RandyLevensalor @maxl2287 have you tested or can you test that the behavior of editors and tooling is then still the expected one? I thought that we needed the allof workaround to get it done.

@jlurien
Copy link
Collaborator

jlurien commented Aug 25, 2023

Also, many of these AllOf statements were added specifically for the description and could be removed if we were to remove the description from the AllOf.

@RandyLevensalor @maxl2287 have you tested or can you test that the behavior of editors and tooling is then still the expected one? I thought that we needed the allof workaround to get it done.

It works well with both Redoc and Swagger viewers. The aim of the "allOf" was to avoid having $ref as property at same level of description, but with the workaround, this is avoided.

@eric-murray
Copy link
Collaborator

Hi @maxl2287

I think you need to rebase this PR, as github is reporting a conflict. Can you do that? Thanks.

@maxl2287 maxl2287 force-pushed the fix/change-allof-misbehaviour branch from 9d2c121 to 84d7b89 Compare September 8, 2023 11:46
@maxl2287
Copy link
Collaborator Author

maxl2287 commented Sep 8, 2023

Hi @maxl2287

I think you need to rebase this PR, as github is reporting a conflict. Can you do that? Thanks.

Yep, done.

@RandyLevensalor RandyLevensalor merged commit 25858cd into camaraproject:main Sep 11, 2023
2 checks passed
@maxl2287 maxl2287 deleted the fix/change-allof-misbehaviour branch March 14, 2024 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move the "description" out of "allOf"-declaration
5 participants