Skip to content

fix(kotlin-client): emit parameter table header before first parameter - #24742

Merged
wing328 merged 1 commit into
OpenAPITools:masterfrom
raunak2007:fix/kotlin-api-doc-param-table
Aug 20, 2026
Merged

wing328 merged 1 commit into
OpenAPITools:masterfrom
raunak2007:fix/kotlin-api-doc-param-table

Conversation

@raunak2007

@raunak2007 raunak2007 commented Aug 19, 2026 •

Copy link
Copy Markdown
Contributor

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

  • Read the contribution guidelines.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    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.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

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.

  • Change {{#-last}} to {{#-first}} for the header block in modules/openapi-generator/src/main/resources/kotlin-client/api_doc.mustache.
  • Regenerates Kotlin samples; diffs are docs-only (rows moved under the header). No generator behavior or non-doc outputs changed.
  • Single-parameter operations are unchanged; multi-parameter tables now render correctly on GitHub.
  • Related bug exists in typescript-fetch/api_doc.mustache; excluded to keep scope focused.

Written for commit 3e6c797. Summary will update on new commits.

Review in cubic

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 76 files

Re-trigger cubic

@wing328

wing328 commented Aug 20, 2026

Copy link
Copy Markdown
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)

@wing328
wing328 merged commit eb040a6 into OpenAPITools:master Aug 20, 2026
75 checks passed
@wing328 wing328 added this to the 7.25.0 milestone Aug 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants