We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
I'm thinking of creating a pet store example with the following setup and endpoints.
Common Setup:
Pet
Endpoints:
{ "components": { "schemas": { "PetIn": { "properties": { "category": { "enum": [ "dog", "cat" ], "type": "string" }, "name": { "maxLength": 10, "minLength": 0, "type": "string" } }, "required": [ "category", "name" ], "type": "object" }, "PetInUpdate": { "properties": { "category": { "enum": [ "dog", "cat" ], "type": "string" }, "name": { "maxLength": 10, "minLength": 0, "type": "string" } }, "type": "object" }, "PetOut": { "properties": { "category": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "ValidationError": { "properties": { "detail": { "properties": { "<location>": { "properties": { "<field_name>": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "type": "object" }, "message": { "type": "string" }, "status_code": { "type": "integer" } }, "type": "object" } } }, "info": { "title": "APIFlask", "version": "0.1.0" }, "openapi": "3.0.3", "paths": { "/": { "get": { "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful response" } }, "summary": "Say Hello" } }, "/pets": { "get": { "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PetOut" }, "type": "array" } } }, "description": "Successful response" } }, "summary": "Get Pets" }, "post": { "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetIn" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetOut" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } }, "description": "Validation error" } }, "summary": "Create Pet" } }, "/pets/{pet_id}": { "delete": { "parameters": [ { "in": "path", "name": "pet_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful response" } }, "summary": "Delete Pet" }, "get": { "parameters": [ { "in": "path", "name": "pet_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetOut" } } }, "description": "Successful response" } }, "summary": "Get Pet" }, "patch": { "parameters": [ { "in": "path", "name": "pet_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetInUpdate" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetOut" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } }, "description": "Validation error" } }, "summary": "Update Pet" } } }, "tags": [] }
The text was updated successfully, but these errors were encountered:
No branches or pull requests
I'm thinking of creating a pet store example with the following setup and endpoints.
Common Setup:
Petmodel.Endpoints:
The example OpenAPI spec:
{ "components": { "schemas": { "PetIn": { "properties": { "category": { "enum": [ "dog", "cat" ], "type": "string" }, "name": { "maxLength": 10, "minLength": 0, "type": "string" } }, "required": [ "category", "name" ], "type": "object" }, "PetInUpdate": { "properties": { "category": { "enum": [ "dog", "cat" ], "type": "string" }, "name": { "maxLength": 10, "minLength": 0, "type": "string" } }, "type": "object" }, "PetOut": { "properties": { "category": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "ValidationError": { "properties": { "detail": { "properties": { "<location>": { "properties": { "<field_name>": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "type": "object" }, "message": { "type": "string" }, "status_code": { "type": "integer" } }, "type": "object" } } }, "info": { "title": "APIFlask", "version": "0.1.0" }, "openapi": "3.0.3", "paths": { "/": { "get": { "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful response" } }, "summary": "Say Hello" } }, "/pets": { "get": { "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PetOut" }, "type": "array" } } }, "description": "Successful response" } }, "summary": "Get Pets" }, "post": { "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetIn" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetOut" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } }, "description": "Validation error" } }, "summary": "Create Pet" } }, "/pets/{pet_id}": { "delete": { "parameters": [ { "in": "path", "name": "pet_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful response" } }, "summary": "Delete Pet" }, "get": { "parameters": [ { "in": "path", "name": "pet_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetOut" } } }, "description": "Successful response" } }, "summary": "Get Pet" }, "patch": { "parameters": [ { "in": "path", "name": "pet_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetInUpdate" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetOut" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } }, "description": "Validation error" } }, "summary": "Update Pet" } } }, "tags": [] }The text was updated successfully, but these errors were encountered: