mysql-operator icon indicating copy to clipboard operation
mysql-operator copied to clipboard

WIP: OpenAPI Spec

Open devdattakulkarni opened this issue 7 years ago • 2 comments

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

devdattakulkarni avatar Sep 05 '18 19:09 devdattakulkarni

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 avatar Sep 06 '18 08:09 owainlewis

@owainlewis 👍 Will look forward to the feedback from your team.

Also, I will be happy to squash all the changes in a single commit and sign the contributor agreement before re-submitting.

devdattakulkarni avatar Sep 06 '18 14:09 devdattakulkarni