search

danielgtaylor / huma

Huma REST/HTTP API Framework for Golang with OpenAPI 3.1
https://huma.rocks/
MIT License
1.95k stars 144 forks source link

fix: schema enum validation #464

Closed fourcels closed 4 months ago

fourcels commented 4 months ago 
type LockType uint

const (
    NFC LockType = iota + 1
    Bluetooth
)

func (*LockType) Schema(r huma.Registry) *huma.Schema {
    schema := huma.SchemaFromType(r, reflect.TypeOf(0))
    schema.Enum = []any{NFC, Bluetooth}
    return schema
}
{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "validation failed",
  "errors": [
    {
      "message": "expected value to be one of \"1, 2\"",
      "location": "body.type",
      "value": 1
    }
  ]
}

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The change in the validate.go file involves updating the comparison logic within a loop that checks for the presence of a value in a list of enums. The enhancement ensures that the enum value is converted to a string before performing the comparison, improving the accuracy and reliability of the validation process.

Changes

File Change Summary
validate.go Modified comparison logic within the loop to convert the enum value to a string before comparison.

Poem

In the code where enums play, A string conversion saves the day. Validation now more true, Ensures the values pass on through. 🎉 Hooray for changes, hip-hip-hooray! 🎉

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.84%. Comparing base (158b076) to head (355b230).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #464 +/- ## ======================================= Coverage 92.84% 92.84% ======================================= Files 22 22 Lines 3761 3762 +1 ======================================= + Hits 3492 3493 +1 Misses 225 225 Partials 44 44 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

ross96D commented 4 months ago

@danielgtaylor i think this issue relates to #438. A good solution on #438 solves the problem here and avoids the use of a fmt.Sprint which allocates and seems a bit hacky

codercms commented 1 month ago

@danielgtaylor is there any chances to get support for enum types?

type VehicleType string

const (
    VehicleTypeCar     VehicleType = "car"
    VehicleTypeTruck   VehicleType = "truck"
    VehicleTypeSpecial VehicleType = "special"
)

func (*VehicleType) Schema(r huma.Registry) *huma.Schema {
    schema := huma.SchemaFromType(r, reflect.TypeFor[string]()) // always complains that the validation failed
    schema.Enum = []any{VehicleTypeCar, VehicleTypeTruck, VehicleTypeSpecial}
    return schema
}
func (*VehicleType) Schema(r huma.Registry) *huma.Schema {
    schema := huma.SchemaFromType(r, reflect.TypeFor[VehicleType]()) // panics
    schema.Enum = []any{VehicleTypeCar, VehicleTypeTruck, VehicleTypeSpecial}
    return schema
}

Actually enums are quite common in API schemas

fourcels commented 1 month ago

@codercms have a try

func (*VehicleType) Schema(r huma.Registry) *huma.Schema {
    schema := huma.SchemaFromType(r, reflect.TypeFor[string]()) // always complains that the validation failed
    schema.Enum = []any{string(VehicleTypeCar), string(VehicleTypeTruck), string(VehicleTypeSpecial)}
    return schema
}
codercms commented 1 month ago

@fourcels it works, thanks :)