+35 -1

docs/openapi-ts/plugins/valibot.md

reviewed

··· 178 178 179 179 ## Metadata 180 180 181 181 - It's often useful to associate a schema with some additional [metadata](https://valibot.dev/api/metadata/) for documentation, code generation, AI structured outputs, form validation, and other purposes. If this is your use case, you can set `metadata` to `true` to generate additional metadata about schemas. 181 181 + It's often useful to associate a schema with some additional [metadata](https://valibot.dev/api/metadata/) for documentation, code generation, AI structured outputs, form validation, and other purposes. You can set `metadata` to `true` to attach descriptions to schemas when available. 182 182 183 183 ::: code-group 184 184 ··· 200 200 { 201 201 name: 'valibot', 202 202 metadata: true, // [!code ++] 203 203 + }, 204 204 + ], 205 205 + }; 206 206 + ``` 207 207 + 208 208 + ::: 209 209 + 210 210 + For more control over metadata, you can provide your own function. It receives the source `schema`, the target `node` object, and the `$` builder for populating metadata. 211 211 + 212 212 + ::: code-group 213 213 + 214 214 + ```ts [example] 215 215 + export const vFoo = v.pipe( 216 216 + v.string(), 217 217 + v.metadata({ 218 218 + hasTitle: false, 219 219 + createdAt: 1735732800000, 220 220 + }), 221 221 + ); 222 222 + ``` 223 223 + 224 224 + ```js [config] 225 225 + export default { 226 226 + input: 'hey-api/backend', // sign up at app.heyapi.dev 227 227 + output: 'src/client', 228 228 + plugins: [ 229 229 + // ...other plugins 230 230 + { 231 231 + name: 'valibot', 232 232 + metadata({ $, node, schema }) { 233 233 + // [!code ++] 234 234 + node.prop('hasTitle', $.literal(Boolean(schema.title))); // [!code ++] 235 235 + node.prop('createdAt', $.literal(Date.now())); // [!code ++] 236 236 + }, // [!code ++] 203 237 }, 204 238 ], 205 239 };

+32 -1

docs/openapi-ts/plugins/zod.md

reviewed

··· 238 238 239 239 ## Metadata 240 240 241 241 - It's often useful to associate a schema with some additional [metadata](https://zod.dev/metadata) for documentation, code generation, AI structured outputs, form validation, and other purposes. If this is your use case, you can set `metadata` to `true` to generate additional metadata about schemas. 241 241 + It's often useful to associate a schema with some additional [metadata](https://zod.dev/metadata) for documentation, code generation, AI structured outputs, form validation, and other purposes. You can set `metadata` to `true` to attach descriptions to schemas when available. 242 242 243 243 ::: code-group 244 244 ··· 257 257 { 258 258 name: 'zod', 259 259 metadata: true, // [!code ++] 260 260 + }, 261 261 + ], 262 262 + }; 263 263 + ``` 264 264 + 265 265 + ::: 266 266 + 267 267 + For more control over metadata, you can provide your own function. It receives the source `schema`, the target `node` object, and the `$` builder for populating metadata. 268 268 + 269 269 + ::: code-group 270 270 + 271 271 + ```ts [example] 272 272 + export const zFoo = z.string().register(z.globalRegistry, { 273 273 + hasTitle: true, 274 274 + createdAt: 1735732800000, 275 275 + }); 276 276 + ``` 277 277 + 278 278 + ```js [config] 279 279 + export default { 280 280 + input: 'hey-api/backend', // sign up at app.heyapi.dev 281 281 + output: 'src/client', 282 282 + plugins: [ 283 283 + // ...other plugins 284 284 + { 285 285 + name: 'zod', 286 286 + metadata({ $, node, schema }) { 287 287 + // [!code ++] 288 288 + node.prop('hasTitle', $.literal(Boolean(schema.title))); // [!code ++] 289 289 + node.prop('createdAt', $.literal(Date.now())); // [!code ++] 290 290 + }, // [!code ++] 260 291 }, 261 292 ], 262 293 };

+33 -1

docs/openapi-ts/plugins/zod/mini.md

reviewed

··· 249 249 250 250 ## Metadata 251 251 252 252 - It's often useful to associate a schema with some additional [metadata](https://zod.dev/metadata) for documentation, code generation, AI structured outputs, form validation, and other purposes. If this is your use case, you can set `metadata` to `true` to generate additional metadata about schemas. 252 252 + It's often useful to associate a schema with some additional [metadata](https://zod.dev/metadata) for documentation, code generation, AI structured outputs, form validation, and other purposes. You can set `metadata` to `true` to attach descriptions to schemas when available. 253 253 254 254 ::: code-group 255 255 ··· 269 269 name: 'zod', 270 270 compatibilityVersion: 'mini', 271 271 metadata: true, // [!code ++] 272 272 + }, 273 273 + ], 274 274 + }; 275 275 + ``` 276 276 + 277 277 + ::: 278 278 + 279 279 + For more control over metadata, you can provide your own function. It receives the source `schema`, the target `node` object, and the `$` builder for populating metadata. 280 280 + 281 281 + ::: code-group 282 282 + 283 283 + ```ts [example] 284 284 + export const zFoo = z.string().register(z.globalRegistry, { 285 285 + hasTitle: true, 286 286 + createdAt: 1735732800000, 287 287 + }); 288 288 + ``` 289 289 + 290 290 + ```js [config] 291 291 + export default { 292 292 + input: 'hey-api/backend', // sign up at app.heyapi.dev 293 293 + output: 'src/client', 294 294 + plugins: [ 295 295 + // ...other plugins 296 296 + { 297 297 + name: 'zod', 298 298 + compatibilityVersion: 'mini', 299 299 + metadata({ $, node, schema }) { 300 300 + // [!code ++] 301 301 + node.prop('hasTitle', $.literal(Boolean(schema.title))); // [!code ++] 302 302 + node.prop('createdAt', $.literal(Date.now())); // [!code ++] 303 303 + }, // [!code ++] 272 304 }, 273 305 ], 274 306 };