Closed greensong closed 1 month ago
[APPROVALNOTIFIER] This PR is NOT APPROVED
This pull-request has been approved by:
To complete the pull request process, please assign kevin-wangzefeng after the PR has been reviewed.
You can assign the PR to them by writing /assign @kevin-wangzefeng
in a comment when ready.
The full list of commands accepted by this bot can be found here.
1. Generate OpenAPI Definitions with openapi-gen: Use the openapi-gen tool to generate Go template code containing OpenAPI definitions based on annotation information. By adding a specific annotation
+k8s:openapigen=true
in thedoc.go
file, openapi-gen scans all types under that package and generates OpenAPI definitions for them, stored in thezz_generated.openapi.go
file.2. Generate OpenAPI Specification: Write
generateswagger.go
to reference the generated OpenAPI definitions (zz_generated.openapi.go
) and generate the OpenAPI specification (swagger.json
). Theswagger.json
file contains all the OpenAPI definition information for the API server.The contents of
generateswagger.go
are as follows: