fix(openapi): handles nil schema & schema values

[dwisiswant0]

Proposed changes

Fixes #6217

Checklist

• Pull request is created against the dev branch
• All checks passed (lint, unit/integration/regression tests etc.) with my changes
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of missing or incomplete schema information when generating request body content, preventing potential errors.
• New Features
  • Added support for generating default empty schema values tailored to different content types when schema details are unavailable.

[coderabbitai]

Walkthrough

A new function was introduced to generate default empty schema values for various MIME content types. The request body content generation logic was updated to use this function when schema information is missing, adding nil checks to prevent runtime errors. No existing exported interfaces were changed.

Changes

File(s)	Change Summary
pkg/input/formats/openapi/examples.go	Added generateEmptySchemaValue function to create default empty schemas based on content type.
pkg/input/formats/openapi/generator.go	Modified request body generation: added nil checks for schemas, used new function for missing schemas, updated logic to use safe value.

Sequence Diagram(s)

sequenceDiagram
    participant Generator as generateRequestsFromOp
    participant Schema as openapi3.Schema
    participant ExampleGen as generateExampleFromSchema
    participant EmptyGen as generateEmptySchemaValue

    Generator->>Schema: Retrieve schema for content type
    alt Schema is nil
        Generator->>EmptyGen: generateEmptySchemaValue(contentType)
        EmptyGen-->>Generator: Return default empty schema
        Generator->>Generator: Use default value for request body
    else Schema exists
        Generator->>ExampleGen: generateExampleFromSchema(schema)
        ExampleGen-->>Generator: Return example or error
        alt Example generation fails
            Generator->>Generator: Continue to next content type
        else
            Generator->>Generator: Use generated example for request body
        end
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Prevent SIGSEGV when OpenAPI spec contains empty content schemas (e.g., application/json: {}) (#6217)	✅
Treat empty content as empty in request generation (#6217)	✅

Poem

A schema so empty, a bug in the air,
Now rabbits have patched it with careful repair.
No more will it crash on a blank JSON call,
For empty means empty—no panic at all!
Hippity-hop, the code runs anew,
With schemas and rabbits, and bugs bid adieu! 🐇

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 40e29f1 and 34ca920.

📒 Files selected for processing (2)

• pkg/input/formats/openapi/examples.go (1 hunks)
• pkg/input/formats/openapi/generator.go (4 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Tests (macOS-latest)
• GitHub Check: Tests (windows-latest)
• GitHub Check: Tests (ubuntu-latest)

🔇 Additional comments (3)

pkg/input/formats/openapi/examples.go (1)

292-320: Well-implemented fallback schema generator.

This new function addresses the core issue in #6217 by providing appropriate empty schema values based on content types. The implementation correctly handles all the MIME types used in the generator and follows a consistent pattern.

pkg/input/formats/openapi/generator.go (2)

271-282: Good defensive programming with nil checks.

The addition of proper nil checks for value.Schema and value.Schema.Value prevents potential nil pointer dereferences. Using the new generateEmptySchemaValue function as a fallback ensures the code can handle missing schema information gracefully.

---

287-288: Consistent variable usage across all content types.

You've consistently replaced all references to the example variable with the new val variable throughout all content type cases. This ensures the code remains consistent and uses the properly initialized value in all cases.

Also applies to: 294-295, 305-306, 317-318, 337-338, 343-344

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.