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

feat(openapi): go openapi schema + json openapi schema generation #6397

Merged
merged 1 commit into from
Oct 2, 2024

Conversation

manusa
Copy link
Member

@manusa manusa commented Oct 2, 2024

Description

The generator is capable of parsing go types to generate a zz_generated.openapi.go file containing the OpenAPI schema definitions. The file is generated using kube-openapi openapi-gen programmatically as a go-generator script.

The file is further processed to generate the openshift-generated.json file that contains the final OpenAPI schema definitions augmented with x-fabric8-info that includes the additional information to be able to infer group, version, kind, and so on.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • [x Feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change
  • Chore (non-breaking change which doesn't affect codebase;
    test, version modification, documentation, etc.)

Checklist

  • Code contributed by me aligns with current project license: Apache 2.0
  • I Added CHANGELOG entry regarding this change
  • I have implemented unit tests to cover my changes
  • I have added/updated the javadocs and other documentation accordingly
  • No new bugs, code smells, etc. in SonarCloud report
  • I tested my code in Kubernetes
  • I tested my code in OpenShift

@manusa manusa added this to the 7.0.0 milestone Oct 2, 2024 — with automated-tasks
The generator is capable of parsing go types to generate
a zz_generated.openapi.go file containing the OpenAPI schema definitions.
The file is generated using kube-openapi openapi-gen programmatically
as a go-generator script.

The file is further processed to generate the openshift-generated.json file
that contains the final OpenAPI schema definitions augmented with x-fabric8-info
that includes the additional information to be able to infer group, version, kind,
and so on.

Signed-off-by: Marc Nuri <[email protected]>
@manusa manusa force-pushed the feat/openapi-generator-from-go branch from 033ad7c to 46aecd4 Compare October 2, 2024 06:31
Copy link

sonarqubecloud bot commented Oct 2, 2024

@manusa manusa merged commit fa135b9 into fabric8io:main Oct 2, 2024
21 checks passed
@manusa manusa deleted the feat/openapi-generator-from-go branch October 2, 2024 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant