Repository navigation
fix(kotlin-client): emit parameter table header before first parameter - #24742
Merged
wing328 merged 1 commit intoAug 20, 2026
Merged
Conversation
Member
|
thanks for the PR cc @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10) |
This was referenced Aug 20, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
kotlin-client/api_doc.mustache emits the parameter table header inside {{#-last}}, so for any operation with two or more parameters the header lands immediately before the final parameter. Every preceding row falls outside the table and GitHub renders it as stray text. Single-parameter operations work by accident, since -first and -last coincide.
Visible on master today — samples/client/petstore/kotlin/docs/PetApi.md lines 94–98 (deletePet), plus two other malformed tables in that same file.
Fix
{{#-last}} → {{#-first}} on the header block.
Samples
Regenerated bin/configs/kotlin*.yaml. 76 files, 249 insertions / 249 deletions — every change is a parameter row moving from above the header to below the separator. No non-doc output affected.
Note
typescript-fetch/api_doc.mustache has the same bug. Every other generator I checked emits the header outside the loop. Left out of this PR to keep it scoped to kotlin-client.
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
Summary by cubic
Fixes malformed Markdown parameter tables in Kotlin client API docs by emitting the header before the first parameter. Previously the header appeared before the last parameter, leaving earlier rows outside the table; now all rows render inside the table.
{{#-last}}to{{#-first}}for the header block inmodules/openapi-generator/src/main/resources/kotlin-client/api_doc.mustache.typescript-fetch/api_doc.mustache; excluded to keep scope focused.Written for commit 3e6c797. Summary will update on new commits.