Skip to content

fix(extensions): use the x-order from next to $ref, if present #1700

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
jamietanna merged 4 commits into from
Jul 24, 2024
Merged

fix(extensions): use the x-order from next to $ref, if present #1700

jamietanna merged 4 commits into from
Jul 24, 2024

Conversation

@paulmach
Copy link
Contributor

@paulmach paulmach commented Jul 13, 2024

This is part 2 of the fix for #1611.

The issues is that something like the below doesn't work.

type: object
properties:
 start_port:
   $ref: "#/components/schemas/port"
   x-order: 1
 end_port:
   $ref: "#/components/schemas/port"
   x-order: 2

First problem was the kin-openapi does not actually capture these values from the yaml/json. This fixed in getkin/kin-openapi#901, release in v0.126.0 and pulled in here in #1689

This is the second part which actually considers this value in the sort and officially fixes #1611. It first checks for "next to $ref" then if there is an x-order in the schema referenced.

@paulmach paulmach requested a review from a team as a code owner July 13, 2024 06:08
@paulmach paulmach mentioned this pull request Jul 13, 2024
Closed
@jamietanna jamietanna self-assigned this Jul 14, 2024
@AndrewCopeland
Copy link

AndrewCopeland commented Jul 23, 2024

I made a comment on the original issue that was closed #1611.

Seems like we are waiting on this PR to be merged to resolve this bug.

jamietanna
jamietanna reviewed Jul 24, 2024
View reviewed changes
Jamie Tanna added 3 commits July 24, 2024 09:35
@jamietanna jamietanna changed the title use the x-order from next to $ref if present fix(extensions): use the x-order from next to $ref if present Jul 24, 2024
@jamietanna jamietanna changed the title fix(extensions): use the x-order from next to $ref if present fix(extensions): use the x-order from next to $ref, if present Jul 24, 2024
@jamietanna jamietanna added bug Something isn't working area:extensions labels Jul 24, 2024
@jamietanna jamietanna enabled auto-merge (squash) July 24, 2024 08:48
jamietanna
jamietanna approved these changes Jul 24, 2024
View reviewed changes
Copy link
Member

@jamietanna jamietanna left a comment

Choose a reason for hiding this comment

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

Thank you for this! Added in an additional case, and a couple of comments :)

@jamietanna jamietanna merged commit 08bd55b into oapi-codegen:main Jul 24, 2024
This was referenced Sep 28, 2024
Merged
Merged
@paulmach paulmach mentioned this pull request Jan 9, 2025
Open
@jamietanna jamietanna mentioned this pull request Feb 12, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jamietanna jamietanna jamietanna approved these changes

Assignees

@jamietanna jamietanna

Labels

area:extensions bug Something isn't working

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

x-order not respected when using $ref

3 participants

@paulmach @AndrewCopeland @jamietanna