Show request body examples in docs - #30
Open
kafkasl wants to merge 1 commit into
Open
Conversation
kafkasl
marked this pull request as draft
August 26, 2026 13:40
kafkasl
marked this pull request as ready for review
August 26, 2026 13:50
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.
An OpenAPI request body can carry examples in two places:
schema: named sample request bodies underexamples(or the OpenAPI 3.0 singularexample).Runpod's
POST /v2/pods, the case that prompted this PR, has both. Next to the schema:And inside
CreatePodRequest:We drop both kinds. This is made worse by the fact we only parse the top level of the schema. A nested object param comes out typed as bare
dict, and everything beneath it is discarded. For example thedoc()on this op shows:- gpu (dict, optional): GPU request for a pod create. Carries the CUDA host constraints, which live here rather than at the body's top level so they are unrepresentable on a CPU pod.The caller can't construct a valid body without going back to the raw spec.
I decided to improve this by adding the
1. Whole-payload examplesinto the docs. It is a concise fix and displaying the main payload examples should mitigate the issue in most happy-paths.Nothing changes when a spec has no examples.