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

Linearized composed api #50

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

andreaTP
Copy link
Contributor

Flattened out the OpenAPI description, now anything that starts "With" contains properties, and everything else is a composition of those things.

Description

This change makes it easier for code generators to deal with the spec, both Kiota and OpenApi generator (Go server) are now behaving well.
Like before, even in this solution, there is no repetition of properties.
Please note that the Go Server generated code is completely compatible with the previous one.

How Has This Been Tested?

Tests in CI.

Merge criteria:

  • The commits and have meaningful messages; the author will squash them after approval or will ask to merge with squash.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has manually tested the changes and verified that the changes work

Copy link

google-cla bot commented Mar 22, 2024

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Signed-off-by: Andrea Peruffo <andrea.peruffo1982@gmail.com>
Copy link
Member

@tarilabs tarilabs left a comment

Choose a reason for hiding this comment

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

I have contributed coordination with team and @andreaTP on this topic, this linearization of the openapi as Andrea mentions not only make it easier to be consumed by code-generators, but in the experience it's also easy to manage, while preserving the original principle of DRY: as can be seen in the generated Go model files, structure is preserved.

/lgtm

I only wish there was a prow command for special appreciation too :)

@google-oss-prow google-oss-prow bot added the lgtm label Mar 22, 2024
@andreaTP andreaTP changed the title Final composed api Linearized composed api Mar 22, 2024
@google-oss-prow google-oss-prow bot removed the lgtm label Mar 25, 2024
Copy link

New changes are detected. LGTM label has been removed.

Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: andreaTP
Once this PR has been reviewed and has the lgtm label, please ask for approval from tarilabs. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Signed-off-by: Andrea Peruffo <andrea.peruffo1982@gmail.com>
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
@tarilabs tarilabs mentioned this pull request Apr 11, 2024
3 tasks
@tarilabs
Copy link
Member

I'm going to hold this one a bit more as I've requested specific feedback, also in relation to:

/hold

rkubis pushed a commit to rkubis/model-registry that referenced this pull request Apr 23, 2024
[pull] main from kubeflow:main
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants