fix(schema): schema example not work in Parameter

[fourcels]

type GreetingType int

func (*GreetingType) Schema(r huma.Registry) *huma.Schema {
	schema := &huma.Schema{
		Type:     huma.TypeInteger,
		Examples: []any{1},
	}
	return schema
}

Summary by CodeRabbit

• New Features
  • Enhanced example generation logic for improved flexibility and usability in the application.
  • Default examples are now utilized when no explicit examples are defined, enriching the user experience.
  • Introduced a new integer type with an example value, improving API documentation clarity.
• Tests
  • Added a test to validate the new integer type's behavior within the API context.

[coderabbitai]

Walkthrough

The update enhances the findParams function in huma.go by refining how the example variable is assigned. It now pulls a default example from pfi.Schema.Examples when none is explicitly defined. Additionally, a new type SchemaWithExample is introduced in huma_test.go, complete with a method and a test to ensure correct API behavior. These changes improve the flexibility and usability of parameter examples within the API.

Changes

Files	Change Summary
huma.go	Enhanced findParams function to assign a default example from pfi.Schema.Examples if no explicit example is defined.
huma_test.go	Introduced new type SchemaWithExample, added Schema method, and implemented TestSchemaWithExample to validate its usage in the API.

Poem

In the fields where examples play,
A new logic hops in, hooray!
If none are found, don’t dismay,
A default blooms, bright and gay.
With every change, we leap and sway! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.69%. Comparing base (9eae273) to head (40d5603).
Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #532   +/-   ##
=======================================
  Coverage   92.68%   92.69%           
=======================================
  Files          22       22           
  Lines        3844     3847    +3     
=======================================
+ Hits         3563     3566    +3     
  Misses        236      236           
  Partials       45       45           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9eae273 and a94871d.

Files selected for processing (1)

• huma.go (1 hunks)

Additional context used

GitHub Check: codecov/patch

huma.go

[warning] 171-171: huma.go#L171
Added line #L171 was not covered by tests

Additional comments not posted (1)

huma.go (1)

170-172: Enhancement: Assign default example from schema examples.

The new logic improves the function by assigning a default example from pfi.Schema.Examples if no specific example is provided. This enhances the flexibility and usability of the function.

Tools

GitHub Check: codecov/patch

[warning] 171-171: huma.go#L171
Added line #L171 was not covered by tests

[danielgtaylor]

@fourcels this looks great, but can you add a test to cover this use case? Thanks!

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a94871d and 40d5603.

Files selected for processing (1)

• huma_test.go (1 hunks)

Additional comments not posted (2)

huma_test.go (2)

2137-2145: LGTM!

The type SchemaWithExample and its method Schema are correctly defined. The schema specifies the type as huma.TypeInteger and includes an example value of 1.

---

2147-2161: LGTM!

The test function TestSchemaWithExample correctly validates the behavior of the SchemaWithExample type within an API context. The example value for the query parameter is correctly asserted to be 1.