Add basic docs around the current kbapi generation #1178
Merged
Conversation
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
wandergeek
approved these changes
Jul 4, 2025
|
|
||
| ## Updating the generated Kibana client. | ||
|
|
||
| If you're work involved the Kibana API, the endpoints may or may not be included in the generated client. |
There was a problem hiding this comment.
Suggested change
| If you're work involved the Kibana API, the endpoints may or may not be included in the generated client. | |
| If your work involves the Kibana API, the endpoints may or may not be included in the generated client. |
| [Example](https://github.com/elastic/terraform-provider-elasticstack/commit/be866ebc918184e843dc1dd2f6e2e1b963da386d). | ||
|
|
||
| * Once the PR merged, the release CI pipeline can be started by pushing a new release tag to `main` branch. | ||
| * Once the PR merged, the release CI pipeline can be started by pushing a new release tag to `main` branch. |
There was a problem hiding this comment.
Suggested change
| * Once the PR merged, the release CI pipeline can be started by pushing a new release tag to `main` branch. | |
| * Once the PR is merged, the release CI pipeline can be started by pushing a new release tag to the `main` branch. |
dimuon
reviewed
Jul 4, 2025
|
|
||
| `make transform` downloads the schema in kibana/main, and passes it through `transform_schema.go`. This transform step aims to patch over: | ||
| * Issues with the Kibana schema, any issues we encounter should also be raised in the Kibana repo. | ||
| * Issues with oapi-codegen, similarly we should ensure there's a corresponding issue in the oapi-codegen repo. |
There was a problem hiding this comment.
Does it make sense to try another tool, e.g. ogen?
There was a problem hiding this comment.
Yep, it's definitely worth investigating. I've tried a bunch of these previously (I can't remember if that includes ogen) and there bugs in every generator I tried. It's worth checking if ogen works better with the current Kibana spec though.
There was a problem hiding this comment.
ogen-go/ogen#1480 sounds like we might run into similar issues, still worth a try though.
tobio
added a commit
that referenced
this pull request
Jul 5, 2025
tobio
added a commit
that referenced
this pull request
Jul 8, 2025
* Addressing feedback on #1178 * Update CONTRIBUTING.md Co-authored-by: Julian Gernun <[email protected]> --------- Co-authored-by: Julian Gernun <[email protected]>
tobio
added a commit
to agunnerson-elastic/terraform-provider-elasticstack
that referenced
this pull request
Jul 8, 2025
* origin/main: (23 commits) Regenerate Kibana client (elastic#1189) Addressing feedback on elastic#1178 (elastic#1180) Bump github.com/getkin/kin-openapi from 0.127.0 to 0.131.0 (elastic#1190) Remove explicit misspell (elastic#1182) Move tools to go.mod managed tools (elastic#1185) fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.22.0 (elastic#1188) Bump github.com/cloudflare/circl from 1.6.0 to 1.6.1 in /tools (elastic#1187) Migrate the System User resource to the plugin framework. (elastic#1154) Bump github.com/go-viper/mapstructure/v2 from 2.2.1 to 2.3.0 in /tools (elastic#1184) Bump golang.org/x/net from 0.36.0 to 0.38.0 in /libs/go-kibana-rest (elastic#1183) chore(deps): update golang:1.24.4 docker digest to 20a022e (elastic#1177) Bump github.com/getkin/kin-openapi from 0.127.0 to 0.131.0 in /tools (elastic#1181) Add basic docs around the current kbapi generation (elastic#1178) chore(deps): update module github.com/golangci/golangci-lint to v2.2.1 (elastic#1176) chore(deps): update docker.elastic.co/elasticsearch/elasticsearch docker tag to v9.0.3 (elastic#1170) chore(deps): update docker.elastic.co/kibana/kibana docker tag to v9.0.3 (elastic#1171) chore(deps): update dependency go to v1.24.4 (elastic#1159) fix(deps): update module github.com/elastic/go-elasticsearch/v8 to v8.18.1 (elastic#1168) chore(deps): update golang docker tag to v1.24.4 (elastic#1161) fix(deps): update module github.com/goreleaser/goreleaser/v2 to v2.10.2 (elastic#1162) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Trying to make this mess a little less messy.