Add request examples to Foundry OpenAPI spec#19
Conversation
Populate requestBody media-type examples from schema examples so the compute module function UI shows realistic sample payloads instead of generic string placeholders.
|
🚅 Deployed to the dspy-reference-examples-pr-19 environment in dspy-reference-example
|
WalkthroughThis pull request enhances OpenAPI documentation by adding example payloads to three request types (AEPCRequest, AECategoryRequest, PCCategoryRequest) and implements automatic example propagation in the deployment script to copy schema-level examples into request media when inline examples are absent. Changes
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 Comment |
Why\nFoundry's compute module function UI currently generates a generic placeholder payload (e.g.
"complaint": "value") even though our Pydantic schemas include realistic examples.\n\n## What changed\n- When generating the Foundry-constrained OpenAPI spec, copy schema-levelexampleintorequestBody.content.application/json.examplewhen the request schema is a .\n- This improves the default sample request shown for functions registered from the OpenAPI label.Summary by CodeRabbit
Release Notes