| { |
| "openapi": "3.0.1", |
| "info": { |
| "title": "Swagger Petstore", |
| "description": "This is a fork of Petstore server specification. You can find out more about Swagger at [http://swagger.io](http://swagger.io). For this sample, you can use the api key `special-key` to test the authorization filters.", |
| "termsOfService": "http://swagger.io/terms/", |
| "contact": { |
| "email": "davide.corradini@univr.it" |
| }, |
| "license": { |
| "name": "Apache 2.0", |
| "url": "http://www.apache.org/licenses/LICENSE-2.0.html" |
| }, |
| "version": "1.0.0" |
| }, |
| "externalDocs": { |
| "description": "Find out more about Swagger", |
| "url": "http://swagger.io" |
| }, |
| "servers": [ |
| { |
| "url": "http://localhost:8080/v2" |
| } |
| ], |
| "tags": [ |
| { |
| "name": "pet", |
| "description": "Everything about your Pets", |
| "externalDocs": { |
| "description": "Find out more", |
| "url": "http://swagger.io" |
| } |
| } |
| ], |
| "paths": { |
| "/pet": { |
| "get": { |
| "tags": [ |
| "pet" |
| ], |
| "x-crudOperationType": "read-multi", |
| "x-crudTargetObjectId": "pet", |
| "summary": "Get List of Pets", |
| "description": "Get List of Pets", |
| "operationId": "getPets", |
| "responses": { |
| "200": { |
| "description": "Successful operation", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "array", |
| "items": { |
| "$ref": "#/components/schemas/Pet" |
| } |
| } |
| } |
| } |
| }, |
| "400": { |
| "description": "Missing Accept field in header", |
| "content": {} |
| } |
| }, |
| "security": [ |
| { |
| "petstore_auth": [ |
| "write:pets", |
| "read:pets" |
| ] |
| } |
| ] |
| }, |
| "put": { |
| "tags": [ |
| "pet" |
| ], |
| "x-crudOperationType": "update", |
| "x-crudTargetObjectId": "pet", |
| "summary": "Update an existing pet", |
| "operationId": "updatePet", |
| "requestBody": { |
| "description": "Pet object that needs to be added to the store", |
| "content": { |
| "application/json": { |
| "schema": { |
| "$ref": "#/components/schemas/Pet" |
| } |
| } |
| }, |
| "required": true |
| }, |
| "responses": { |
| "200": { |
| "description": "Successful operation", |
| "content": { |
| "application/json": { |
| "schema": { |
| "$ref": "#/components/schemas/Pet" |
| } |
| } |
| } |
| }, |
| "400": { |
| "description": "Missing Accept field in header", |
| "content": {} |
| }, |
| "404": { |
| "description": "Pet not found", |
| "content": {} |
| }, |
| "405": { |
| "description": "Validation exception", |
| "content": {} |
| } |
| }, |
| "security": [ |
| { |
| "petstore_auth": [ |
| "write:pets", |
| "read:pets" |
| ] |
| } |
| ], |
| "x-codegen-request-body-name": "body" |
| }, |
| "post": { |
| "tags": [ |
| "pet" |
| ], |
| "x-crudOperationType": "create", |
| "x-crudTargetObjectId": "pet", |
| "summary": "Add a new pet to the store", |
| "operationId": "addPet", |
| "requestBody": { |
| "description": "Pet object that needs to be added to the store", |
| "content": { |
| "application/json": { |
| "schema": { |
| "$ref": "#/components/schemas/Pet" |
| } |
| } |
| }, |
| "required": true |
| }, |
| "responses": { |
| "200": { |
| "description": "Successful operation", |
| "content": { |
| "application/json": { |
| "schema": { |
| "$ref": "#/components/schemas/Pet" |
| } |
| } |
| } |
| }, |
| "400": { |
| "description": "Missing Accept field in header", |
| "content": {} |
| }, |
| "405": { |
| "description": "Invalid input", |
| "content": {} |
| } |
| }, |
| "security": [ |
| { |
| "petstore_auth": [ |
| "write:pets", |
| "read:pets" |
| ] |
| } |
| ], |
| "x-codegen-request-body-name": "body" |
| } |
| }, |
| "/pet/findByStatus": { |
| "get": { |
| "tags": [ |
| "pet" |
| ], |
| "x-crudOperationType": "read", |
| "x-crudTargetObjectId": "pet", |
| "summary": "Finds Pets by status", |
| "description": "Multiple status values can be provided with comma separated strings", |
| "operationId": "findPetsByStatus", |
| "parameters": [ |
| { |
| "name": "status", |
| "in": "query", |
| "description": "Status values that need to be considered for filter", |
| "required": true, |
| "style": "form", |
| "explode": true, |
| "schema": { |
| "type": "array", |
| "items": { |
| "type": "string", |
| "default": "available", |
| "enum": [ |
| "available", |
| "pending", |
| "sold" |
| ] |
| } |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successful operation", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "array", |
| "items": { |
| "$ref": "#/components/schemas/Pet" |
| } |
| } |
| } |
| } |
| }, |
| "400": { |
| "description": "Missing Accept field in header", |
| "content": {} |
| }, |
| "405": { |
| "description": "Invalid status value", |
| "content": {} |
| } |
| }, |
| "security": [ |
| { |
| "petstore_auth": [ |
| "write:pets", |
| "read:pets" |
| ] |
| } |
| ] |
| } |
| }, |
| "/pet/findByTags": { |
| "get": { |
| "tags": [ |
| "pet" |
| ], |
| "x-crudOperationType": "read", |
| "x-crudTargetObjectId": "pet", |
| "summary": "Finds Pets by tags", |
| "description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", |
| "operationId": "findPetsByTags", |
| "parameters": [ |
| { |
| "name": "tags", |
| "in": "query", |
| "description": "Tags to filter by", |
| "required": true, |
| "style": "form", |
| "explode": true, |
| "schema": { |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "successful operation", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "array", |
| "items": { |
| "$ref": "#/components/schemas/Pet" |
| } |
| } |
| } |
| } |
| }, |
| "400": { |
| "description": "Missing Accept field in header", |
| "content": {} |
| }, |
| "405": { |
| "description": "Invalid tag value", |
| "content": {} |
| } |
| }, |
| "deprecated": true, |
| "security": [ |
| { |
| "petstore_auth": [ |
| "write:pets", |
| "read:pets" |
| ] |
| } |
| ] |
| } |
| }, |
| "/pet/{petId}": { |
| "get": { |
| "tags": [ |
| "pet" |
| ], |
| "x-crudOperationType": "read", |
| "x-crudTargetObjectId": "pet", |
| "summary": "Find pet by ID", |
| "description": "Returns a single pet", |
| "operationId": "getPetById", |
| "parameters": [ |
| { |
| "name": "petId", |
| "in": "path", |
| "description": "ID of pet to return", |
| "required": true, |
| "schema": { |
| "type": "integer", |
| "format": "int64" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "successful operation", |
| "content": { |
| "application/json": { |
| "schema": { |
| "$ref": "#/components/schemas/Pet" |
| } |
| } |
| } |
| }, |
| "400": { |
| "description": "Missing Accept field in header", |
| "content": {} |
| }, |
| "404": { |
| "description": "Pet not found", |
| "content": {} |
| }, |
| "405": { |
| "description": "Invalid Id", |
| "content": {} |
| } |
| }, |
| "security": [ |
| { |
| "api_key": [] |
| } |
| ] |
| }, |
| "delete": { |
| "tags": [ |
| "pet" |
| ], |
| "x-crudOperationType": "delete", |
| "x-crudTargetObjectId": "pet", |
| "summary": "Deletes a pet", |
| "operationId": "deletePet", |
| "parameters": [ |
| { |
| "name": "api_key", |
| "in": "header", |
| "schema": { |
| "type": "string" |
| } |
| }, |
| { |
| "name": "petId", |
| "in": "path", |
| "description": "Pet id to delete", |
| "required": true, |
| "schema": { |
| "type": "integer", |
| "format": "int64" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successful operation", |
| "content": {} |
| }, |
| "404": { |
| "description": "Pet not found", |
| "content": {} |
| }, |
| "405": { |
| "description": "Invalid ID supplied", |
| "content": {} |
| } |
| }, |
| "security": [ |
| { |
| "petstore_auth": [ |
| "write:pets", |
| "read:pets" |
| ] |
| } |
| ] |
| } |
| } |
| }, |
| "components": { |
| "schemas": { |
| "Category": { |
| "type": "object", |
| "properties": { |
| "id": { |
| "type": "integer", |
| "format": "int64" |
| }, |
| "name": { |
| "type": "string" |
| } |
| }, |
| "xml": { |
| "name": "Category" |
| } |
| }, |
| "Tag": { |
| "type": "object", |
| "properties": { |
| "id": { |
| "type": "integer", |
| "format": "int64" |
| }, |
| "name": { |
| "type": "string" |
| } |
| }, |
| "xml": { |
| "name": "Tag" |
| } |
| }, |
| "Pet": { |
| "required": [ |
| "name", |
| "photoUrls" |
| ], |
| "type": "object", |
| "properties": { |
| "id": { |
| "type": "integer", |
| "format": "int64" |
| }, |
| "category": { |
| "$ref": "#/components/schemas/Category" |
| }, |
| "name": { |
| "type": "string", |
| "example": "doggie" |
| }, |
| "photoUrls": { |
| "type": "array", |
| "xml": { |
| "name": "photoUrl", |
| "wrapped": true |
| }, |
| "items": { |
| "type": "string" |
| } |
| }, |
| "tags": { |
| "type": "array", |
| "xml": { |
| "name": "tag", |
| "wrapped": true |
| }, |
| "items": { |
| "$ref": "#/components/schemas/Tag" |
| } |
| }, |
| "status": { |
| "type": "string", |
| "description": "pet status in the store", |
| "enum": [ |
| "available", |
| "pending", |
| "sold" |
| ] |
| } |
| }, |
| "xml": { |
| "name": "Pet" |
| } |
| } |
| }, |
| "securitySchemes": { |
| "petstore_auth": { |
| "type": "oauth2", |
| "flows": { |
| "implicit": { |
| "authorizationUrl": "https://petstore.swagger.io/oauth/authorize", |
| "scopes": { |
| "write:pets": "modify pets in your account", |
| "read:pets": "read your pets" |
| } |
| } |
| } |
| }, |
| "api_key": { |
| "type": "apiKey", |
| "name": "api_key", |
| "in": "header" |
| } |
| } |
| } |
| } |
