This repository was archived by the owner on May 28, 2021. It is now read-only.
WIP: OpenAPI Spec #216
Open
WIP: OpenAPI Spec #216
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DO NOT MERGE We analyzed types.go to check its adherence to OpenAPI format. We found that it is violating OpenAPI Spec rules at certain places. This patch fixes those violations by updating types.go. After making the changes we were able to generate OpenAPI Spec correctly. Included files: - kube-openapi-violations.txt: Output showing OpenAPI Spec violations - openapispec.json: Generated OpenAPI Spec We used following tool to analyze and generate OpenAPI Spec: https://github.com/cloud-ark/kubeplus/tree/master/openapi-spec-generator The analysis was performed with the goal of checking the Operator against these guidelines: https://medium.com/@cloudark/kubernetes-operator-development-guidelines-for-improved-usability-222390b00dc4
We analyzed types.go to check its adherence to OpenAPI format. We found that it is violating OpenAPI Spec rules at certain places. This patch fixes those violations by updating types.go. After making the changes we were able to generate OpenAPI Spec correctly. Included files: kube-openapi-violations.txt: Output showing OpenAPI Spec violations openapispec.json: Generated OpenAPI Spec We used following tool to analyze and generate OpenAPI Spec: https://github.com/cloud-ark/kubeplus/tree/master/openapi-spec-generator The analysis was performed with the goal of checking the Operator against these guidelines: https://medium.com/@cloudark/kubernetes-operator-development-guidelines-for-improved-usability-222390b00dc4
owainlewis
added
the
oracle-cla: no
|
Thanks for the contribution @devdattakulkarni we'll take a look at this over the next few days. Once you're ready, would you mind rebasing your PR into a singe signed-off commit (for reference see here)? Also, if you're happy, would you mind signing the Oracle Contributor Agreement? |
|
@owainlewis 👍 Also, I will be happy to squash all the changes in a single commit and sign the contributor agreement before re-submitting. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DO NOT MERGE
We analyzed types.go to check its adherence to OpenAPI format.
We found that it is violating OpenAPI Spec rules at certain
places. This patch fixes those violations by updating types.go.
After making the changes we were able to generate OpenAPI Spec correctly.
Included files:
We used following tool to analyze and generate OpenAPI Spec:
https://github.com/cloud-ark/kubeplus/tree/master/openapi-spec-generator
The analysis was performed with the goal of checking the Operator against
these guidelines:
https://medium.com/@cloudark/kubernetes-operator-development-guidelines-for-improved-usability-222390b00dc4