Skip to content

fix(oapi): fix generating code from oapi schema (backport of #13732) #13743

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 4 commits into from
Jun 16, 2025
Merged

fix(oapi): fix generating code from oapi schema (backport of #13732) #13743

merged 4 commits into from
Jun 16, 2025

Conversation

kumahq[bot]
Copy link
Contributor

@kumahq kumahq bot commented Jun 16, 2025

Automatic cherry-pick of #13732 for branch release-2.11

Generated by action

cherry-picked commit a7c5cf9

⚠️ ⚠️ ⚠️ Conflicts happened when cherry-picking! ⚠️ ⚠️ ⚠️

On branch release-2.11
Your branch is up to date with 'origin/release-2.11'.

You are currently cherry-picking commit a7c5cf965.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	new file:   api/mesh/v1alpha1/dataplaneoverview/rest.yaml
	modified:   api/openapi/specs/api.yaml
	modified:   api/openapi/specs/common/error_schema.yaml
	modified:   api/openapi/types/common/zz_generated.error_schema.go
	modified:   api/openapi/types/zz_generated.api.go
	modified:   docs/generated/openapi.yaml
	modified:   mk/dev.mk
	modified:   mk/generate.mk

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   mk/dependencies/deps.lock

@Automaat @kumahq
fix(oapi): fix generating code from oapi schema (#13732)
e2c1302 
When we generate oapi schema from proto resource, rest schema needs to
be in the same directory as components definition. Thanks to this, we
avoid issues with schema referencing.

Previously, when we run make check, generate step was failing silently
with errors:
```
error loading swagger spec in api/openapi/specs/api.yaml
: failed to load OpenAPI specification: error resolving reference "/specs/protoresources/dataplaneoverview/schema.yaml#/components/schemas/DataplaneOverview": open /specs/protoresources/dataplaneoverview/schema.yaml: no such file or directory
```
Which caused skipping of go code generation from
`api/openapi/specs/api.yaml` file. With this change we don't reference
schema from other locations. We only combine it at the end while
generating docs.

<!--
> Changelog: skip
-->
<!--
Uncomment the above section to explicitly set a [`> Changelog:` entry
here](https://github.com/kumahq/kuma/blob/master/CONTRIBUTING.md#submitting-a-patch)?
-->

---------

Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
Automaat added 3 commits June 16, 2025 09:49
@Automaat
fix(backport): fix check
f75fb3c 
Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
@Automaat
fix(backport): fix check
2e1240f 
Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
@Automaat
fix(backport): fix check
451a327 
Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
@Automaat Automaat marked this pull request as ready for review June 16, 2025 09:54
@Automaat Automaat requested a review from a team as a code owner June 16, 2025 09:54
@Automaat Automaat requested review from jijiechen and slonka June 16, 2025 09:54
@Automaat Automaat merged commit 30a3fe2 into release-2.11 Jun 16, 2025
13 checks passed
@Automaat Automaat deleted the chore/backport-release-2.11-13732 branch June 16, 2025 10:53
@BrewTestBot BrewTestBot mentioned this pull request Jun 25, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@slonka slonka slonka approved these changes

@Automaat Automaat Automaat approved these changes

@jijiechen jijiechen Awaiting requested review from jijiechen jijiechen is a code owner automatically assigned from kumahq/kuma-maintainers

Assignees
No one assigned
Labels
conflict release-2.11
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@slonka @Automaat