Repository navigation
Conversation
…r in jvm-retrofit2 docs
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
Follow-up to #24742. That PR fixed kotlin-client/api_doc.mustache, but the jvm-retrofit2 library ships its own copy, which still emits the parameter table header inside {{#-last}}. For operations with two or more parameters the header lands before the final parameter and every preceding row falls outside the table.
Visible on master today — samples/client/petstore/kotlin-jvm-retrofit2-coroutines/docs/PetApi.md (deletePet): the petId row sits above the header.
Fix
{{#-last}} → {{#-first}} on the header block, matching #24742.
Samples
Regenerated bin/configs/kotlin*.yaml. 21 files, 68 insertions / 68 deletions — every change is a parameter row moving below the header. No non-doc output affected.
I checked every api_doc.mustache in the tree structurally; this was the last one with the header nested inside the row loop.
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 Kotlin
jvm-retrofit2API docs to emit the parameter table header before the first parameter. Previously the header rendered on the last parameter, leaving earlier rows outside the table; now the header renders on the first parameter and all rows appear inside the table.Review notes
modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-retrofit2/api_doc.mustache: switch{{#-last}}to{{#-first}}for the header block.bin/configs/kotlin*.yaml; diffs move parameter rows below the header (e.g.,samples/client/petstore/kotlin-jvm-retrofit2-coroutines/docs/PetApi.md).Written for commit 09c6500. Summary will update on new commits.