fix: regenerate OpenAPI specs from Go types, add jobConfig/jobScript and correct HTTP methods #499
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,3 +36,4 @@ examples/sidecar/templates/python/__pycache__/* | |
| .settings | ||
| CLAUDE.md | ||
| .dagger | ||
| openapi-gen | ||
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,99 +0,0 @@ | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -14,41 +14,42 @@ | |||||
| ) | ||||||
|
|
||||||
| func main() { | ||||||
| version := flag.String("version", "0.6.0", "generate API spec for this version") | ||||||
| flag.Parse() | ||||||
|
|
||||||
| generateInterlinkSpec(*version) | ||||||
| generatePluginSpec(*version) | ||||||
| } | ||||||
|
|
||||||
| // generateInterlinkSpec generates the OpenAPI spec for the Virtual Kubelet to interLink API | ||||||
| // server communication and writes it to ./docs/openapi/interlink-openapi.json. | ||||||
| func generateInterlinkSpec(version string) { | ||||||
| reflector := openapi3.Reflector{} | ||||||
| reflector.Spec = &openapi3.Spec{Openapi: "3.0.3"} | ||||||
|
There was a problem hiding this comment. OpenAPI 3.0.3 is a poor fit for this API because several endpoints use JSON request bodies with GET/DELETE. Many OpenAPI 3.0 consumers omit/ignore request bodies for those methods, and the regenerated specs end up dropping the request schema for
Suggested change
|
||||||
| reflector.Spec.Info. | ||||||
| WithTitle("interLink server API"). | ||||||
| WithVersion(version). | ||||||
| WithDescription("This is the API spec for the Virtual Kubelet to interLink API server communication") | ||||||
|
|
||||||
| // CREATE: VK sends PodCreateRequests; interLink proxies back the plugin's CreateStruct response. | ||||||
| createOp, err := reflector.NewOperationContext(http.MethodPost, "/create") | ||||||
| if err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
| createOp.AddReqStructure(new(interlink.PodCreateRequests), withRequiredBody) | ||||||
| createOp.AddRespStructure(new(interlink.CreateStruct), func(cu *openapi.ContentUnit) { cu.HTTPStatus = http.StatusOK }) | ||||||
| if err = reflector.AddOperation(createOp); err != nil { | ||||||
|
dciangot marked this conversation as resolved.
|
||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
| // DELETE: VK sends DELETE to interLink. | ||||||
| deleteOp, err := reflector.NewOperationContext(http.MethodDelete, "/delete") | ||||||
| if err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
| deleteOp.AddReqStructure(new(corev1.Pod)) | ||||||
| deleteOp.AddRespStructure(nil, func(cu *openapi.ContentUnit) { cu.HTTPStatus = http.StatusOK }) | ||||||
| if err = reflector.AddOperation(deleteOp); err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
|
|
@@ -57,60 +58,127 @@ | |||||
| if err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
| pingOp.AddReqStructure(nil) | ||||||
| pingOp.AddRespStructure(nil, func(cu *openapi.ContentUnit) { cu.HTTPStatus = http.StatusOK }) | ||||||
| if err = reflector.AddOperation(pingOp); err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
| // Status: VK uses GET with a JSON body. | ||||||
| statusOp, err := reflector.NewOperationContext(http.MethodGet, "/status") | ||||||
| if err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
| statusOp.AddReqStructure(new([]corev1.Pod)) | ||||||
| statusOp.AddRespStructure(new([]interlink.PodStatus), func(cu *openapi.ContentUnit) { cu.HTTPStatus = http.StatusOK }) | ||||||
| if err = reflector.AddOperation(statusOp); err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
| // Logs: VK uses GET with a JSON body; response is streamed plain text. | ||||||
| logsOp, err := reflector.NewOperationContext(http.MethodGet, "/getLogs") | ||||||
| if err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
| logsOp.AddReqStructure(new(interlink.LogStruct)) | ||||||
| logsOp.AddRespStructure(nil, func(cu *openapi.ContentUnit) { | ||||||
| cu.HTTPStatus = http.StatusOK | ||||||
| cu.ContentType = "text/plain" | ||||||
| }) | ||||||
| if err = reflector.AddOperation(logsOp); err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
| writeSpec(reflector, "./docs/openapi/interlink-openapi.json") | ||||||
| } | ||||||
|
|
||||||
| // generatePluginSpec generates the OpenAPI spec for the interLink API server to plugin | ||||||
| // (sidecar) communication and writes it to ./docs/openapi/plugin-openapi.json. | ||||||
| func generatePluginSpec(version string) { | ||||||
| reflector := openapi3.Reflector{} | ||||||
| reflector.Spec = &openapi3.Spec{Openapi: "3.0.3"} | ||||||
| reflector.Spec.Info. | ||||||
| WithTitle("interLink Plugin API"). | ||||||
|
Comment on lines
+98
to
+101
There was a problem hiding this comment. Same OpenAPI version issue for the plugin spec: with |
||||||
| WithVersion(version). | ||||||
| WithDescription("This is the API spec for the interLink API server to plugin (sidecar) communication") | ||||||
|
|
||||||
| // CREATE: interLink sends RetrievedPodData (including jobConfig and jobScript); plugin returns CreateStruct. | ||||||
| createOp, err := reflector.NewOperationContext(http.MethodPost, "/create") | ||||||
| if err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
| createOp.AddReqStructure(new(interlink.RetrievedPodData), withRequiredBody) | ||||||
| createOp.AddRespStructure(new(interlink.CreateStruct), func(cu *openapi.ContentUnit) { cu.HTTPStatus = http.StatusOK }) | ||||||
| if err = reflector.AddOperation(createOp); err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
| // DELETE | ||||||
| deleteOp, err := reflector.NewOperationContext(http.MethodPost, "/delete") | ||||||
| if err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
| deleteOp.AddReqStructure(new(corev1.Pod), withRequiredBody) | ||||||
| deleteOp.AddRespStructure(nil, func(cu *openapi.ContentUnit) { cu.HTTPStatus = http.StatusOK }) | ||||||
| if err = reflector.AddOperation(deleteOp); err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
| // Status: interLink calls the plugin with GET and a JSON body. | ||||||
| statusOp, err := reflector.NewOperationContext(http.MethodGet, "/status") | ||||||
| if err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
| statusOp.AddReqStructure(new([]corev1.Pod)) | ||||||
| statusOp.AddRespStructure(new([]interlink.PodStatus), func(cu *openapi.ContentUnit) { cu.HTTPStatus = http.StatusOK }) | ||||||
| if err = reflector.AddOperation(statusOp); err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
| // Logs: interLink calls the plugin with GET; response is streamed plain text. | ||||||
| logsOp, err := reflector.NewOperationContext(http.MethodGet, "/getLogs") | ||||||
| if err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
| logsOp.AddReqStructure(new(interlink.LogStruct)) | ||||||
| logsOp.AddRespStructure(nil, func(cu *openapi.ContentUnit) { | ||||||
| cu.HTTPStatus = http.StatusOK | ||||||
| cu.ContentType = "text/plain" | ||||||
| }) | ||||||
| if err = reflector.AddOperation(logsOp); err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
| writeSpec(reflector, "./docs/openapi/plugin-openapi.json") | ||||||
| } | ||||||
|
|
||||||
| // withRequiredBody is a ContentOption that marks a request body as required in the OpenAPI spec. | ||||||
| // Handlers that unmarshal from the request body will fail on empty bodies, so the spec should | ||||||
| // reflect that the body is mandatory. | ||||||
| func withRequiredBody(cu *openapi.ContentUnit) { | ||||||
| cu.Customize = func(cor openapi.ContentOrReference) { | ||||||
| if rbr, ok := cor.(*openapi3.RequestBodyOrRef); ok { | ||||||
| rbr.RequestBodyEns().WithRequired(true) | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| // writeSpec marshals the reflector's spec to JSON and writes it to the given file path. | ||||||
| func writeSpec(reflector openapi3.Reflector, path string) { | ||||||
| schema, err := reflector.Spec.MarshalJSON() | ||||||
| if err != nil { | ||||||
| log.Fatal(err) | ||||||
| } | ||||||
|
|
||||||
| file, err := os.Create(path) | ||||||
| if err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
| defer file.Close() | ||||||
|
|
||||||
| if _, err = file.Write(schema); err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
| fmt.Printf("Successfully wrote to %s\n", path) | ||||||
| } | ||||||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ci/go.modnow has onlyreplacedirectives and norequireblock, andci/go.sumis empty. Since this module depends on generated Dagger Go SDK code (ci/.gitignoreignoresinternal/dagger, etc.), builds can become non-reproducible or fail under-mod=readonlyonce the generated code imports external modules. Consider regenerating the Dagger SDK and committing the resultinggo.mod/go.sumrequirements (or documenting why deps should be unpinned).