Replies: 1 comment 1 reply
-
|
@marclave if it makes sense, I will be stoked to work on it this week! |
Beta Was this translation helpful? Give feedback.
1 reply
-
|
would love for you to work on it @Amorim33 ! |
Beta Was this translation helpful? Give feedback.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Description
Currently, when defining a restriction to a field of
type string, such asminLength : 1, the generated example does not respect the restrictions.In the example below, body string cannot be empty, but the generated example is empty.
OpenAPI specs
{ "info": { "title": "Example", "description": "The `@scalar/hono-api-reference` middleware renders a beautiful API reference based on your OpenAPI specification.", "version": "v1" }, "openapi": "3.1.0", "components": { "schemas": { }, "parameters": { } }, "paths": { "/hello-world": { "get": { "description": "Respond a message", "tags": [ "basic example" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } } } }, "/posts": { "get": { "name": "Get all posts", "description": "Returns all posts", "tags": [ "posts" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "default": 123 }, "title": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "title", "body" ] } } }, "required": [ "posts" ] } } } } } }, "post": { "name": "Create post", "description": "Create a new post", "tags": [ "posts" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "default": "My Blog Post" }, "body": { "type": "string", "minLength": 1 } }, "required": [ "title", "body" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "default": 123 }, "title": { "type": "string", "default": "My Blog Post" }, "body": { "type": "string", "default": "I want to share something with you …" } }, "required": [ "id", "title", "body" ] } } } } } } }, "/posts/{id}": { "delete": { "name": "Delete Post", "description": "Delete a post", "tags": [ "posts" ], "parameters": [ { "schema": { "type": "number", "default": 123 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "default": "OK" }, "message": { "type": "string", "default": "Post deleted" } }, "required": [ "status", "message" ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "default": "ERROR" }, "message": { "type": "string", "default": "Post not found" } }, "required": [ "status", "message" ] } } } } } } } } }Beta Was this translation helpful? Give feedback.
All reactions