Comments (5)
@jpincas there is no switch you can flip to make everything optional by default. You can add ,omitempty
to all the fields and that will mark them as optional, or like you already mentioned using required:"false"
.
Another alternative is to provide a custom schema or use the newly released SchemaTransformer
functionality to set s.Required = []string{}
to undo all the required fields, see https://github.com/danielgtaylor/huma/releases/tag/v2.18.0.
If you don't want to do this for each input struct then you can also just write a function which goes over api.OpenAPI().Components.Schemas.Map()
and modifies each one to set the Required
slice to be empty. Hope this helps!
from huma.
Thanks Daniel. I'll experiment with those options.
from huma.
@danielgtaylor Using the api.OpenAPI().Components.Schemas.Map()
iteration technique - the documentation does indeed change and none of the fields are showing as required
(the effect I want to achieve), but requests are still rejected with the full list of missing required fields. Is there something else I'm missing?
from huma.
@jpincas sorry I think you may be running into https://github.com/danielgtaylor/huma/blob/main/schema.go#L280. There is some caching of required property info that should probably get recomputed after you modify s.Required
. We'll need a bug fix for that.
from huma.
OK understood - thanks for your help.
from huma.
Related Issues (20)
- custom validation tags with constraints specified in the spec.
- Handling of custom types for List inputs of query params
- Suggestion: groups and sub-routing
- Discussion: option to make all APIs registered with security scheme by default HOT 1
- SSE Error with gin adapter: "warning: unable to set write deadline"
- Validation for nested to array primitive types. HOT 2
- Required HTTP headers set via `huma.Param` are neither enforced nor validated HOT 1
- Example File Structure HOT 1
- Add clientId for OAuth 2.0 in code and redeem OAuth 2.0 bearer token through Swagger UI or Stoplight UI HOT 2
- Docs UI bug: mailto: with prefix `#/` HOT 1
- Docs UI bug: when setting contact with both email and url then email is not linked anywhere HOT 1
- [Question] Length validation sptits out unicode charactors. Is there any way to avoid that? HOT 1
- [Bug?]: Inconsistent schemas generation. HOT 2
- Question: How to influence huma response code and error from router specific middleware? HOT 1
- Bug? Hidden Body field is not recognized by validation
- Missed schema description on generation.
- `ErrorModel` schema improvements. HOT 3
- Question: Is is possible for field order in documentation to reflect struct field order? HOT 2
- 500 errors with "cannot read request body" HOT 2
- Enable global additional properties HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from huma.