Add support for remote OpenAPI schema

[mvgmb]

Change how the OpenAPI schema is loaded by letting the Loader handle the given path.

In addition to the path attribute being able to reference a remote schema, it will continue to support a local schema.

Closes #4566

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: mvgmb / name: Mário Bezerra (5996ab0)

[k8s-ci-robot]

Welcome @mvgmb!

It looks like this is your first PR to kubernetes-sigs/kustomize 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kustomize has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @mvgmb. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[natasha41575]

/ok-to-test

[natasha41575]

The lint failure will likely be fixed by #4564, which I think will go in soon.

[mvgmb]

Hi, Natasha!

I just noticed that when referencing a kustomization with the openapi attribute, it also tried to read from a local path.

Fixed by editing the api/internal/target/kusttarget.go file.

[natasha41575]

Closed and reopening to retrigger the CI

[natasha41575]

Could you add a few tests as a sanity check to https://github.com/kubernetes-sigs/kustomize/blob/master/api/krusty/openapicustomschema_test.go?

1. the openapi path is a remote file in the top-level kustomization directory. I think you should be able to copy TestCustomOpenApiFieldBasicUsage, but just change the path to reference this schema here, and it should be good to go

2. the openapi path is a remote file in a base directory. For this one you can copy TestCustomOpenApiFieldFromBase, and similarly change the openapi path to point to this schema.

If there are any other cases that you found gave you trouble and you had to debug, please add them as well.

[k8s-ci-robot]

@mvgmb: This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[mvgmb]

Hey @natasha41575,

I just added the tests you requested. Would you be able to trigger the CI again?

[mvgmb]

@natasha41575, could you re-run the CI?

[natasha41575]

I just added the tests you requested. Would you be able to trigger the CI again?

Apologies, this must have gotten lost in my inbox. Rerunning now.

[natasha41575]

Could you please update the docs as well, with some details about what types of URLs are supported? The docs live here https://github.com/kubernetes-sigs/cli-experimental/tree/master/site/content/en/references/kustomize/kustomization/openapi

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mvgmb, natasha41575

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

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [natasha41575]

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