forked from loafle/openapi-generator-original
c2595335c3
* add useSingleRequestParameter support to java client * trigger build failure * trigger build failure * Revert "trigger build failure" This reverts commit 545e57ab8f3d943d9ad6ad114841a37d3b01a47b. * Revert "trigger build failure" This reverts commit 849f71f1f1a28659b0fd375986d7e66e9c6d04ac. * update doc
507 lines
12 KiB
YAML
507 lines
12 KiB
YAML
openapi: 3.0.0
|
|
info:
|
|
description: "This is a sample server Petstore server. For this sample, you can\
|
|
\ use the api key `special-key` to test the authorization filters."
|
|
license:
|
|
name: Apache-2.0
|
|
url: https://www.apache.org/licenses/LICENSE-2.0.html
|
|
title: OpenAPI Petstore
|
|
version: 1.0.0
|
|
externalDocs:
|
|
description: Find out more about Swagger
|
|
url: http://swagger.io
|
|
servers:
|
|
- url: http://petstore.swagger.io/v2
|
|
tags:
|
|
- description: Everything about your Pets
|
|
name: pet
|
|
- description: Access to Petstore orders
|
|
name: store
|
|
- description: Operations about user
|
|
name: user
|
|
paths:
|
|
/pet:
|
|
post:
|
|
description: ""
|
|
operationId: addPet
|
|
requestBody:
|
|
$ref: '#/components/requestBodies/Pet'
|
|
responses:
|
|
"200":
|
|
content:
|
|
application/xml:
|
|
schema:
|
|
$ref: '#/components/schemas/Pet'
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Pet'
|
|
description: successful operation
|
|
"405":
|
|
description: Invalid input
|
|
security:
|
|
- petstore_auth:
|
|
- write:pets
|
|
- read:pets
|
|
summary: Add a new pet to the store
|
|
tags:
|
|
- pet
|
|
x-content-type: application/json
|
|
x-accepts: application/json
|
|
put:
|
|
description: ""
|
|
operationId: updatePet
|
|
requestBody:
|
|
$ref: '#/components/requestBodies/Pet'
|
|
responses:
|
|
"200":
|
|
content:
|
|
application/xml:
|
|
schema:
|
|
$ref: '#/components/schemas/Pet'
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Pet'
|
|
description: successful operation
|
|
"400":
|
|
description: Invalid ID supplied
|
|
"404":
|
|
description: Pet not found
|
|
"405":
|
|
description: Validation exception
|
|
security:
|
|
- petstore_auth:
|
|
- write:pets
|
|
- read:pets
|
|
summary: Update an existing pet
|
|
tags:
|
|
- pet
|
|
x-content-type: application/json
|
|
x-accepts: application/json
|
|
/pet/findByStatus:
|
|
get:
|
|
description: Multiple status values can be provided with comma separated strings
|
|
operationId: findPetsByStatus
|
|
parameters:
|
|
- deprecated: true
|
|
description: Status values that need to be considered for filter
|
|
explode: false
|
|
in: query
|
|
name: status
|
|
required: true
|
|
schema:
|
|
items:
|
|
default: available
|
|
enum:
|
|
- available
|
|
- pending
|
|
- sold
|
|
type: string
|
|
type: array
|
|
style: form
|
|
responses:
|
|
"200":
|
|
content:
|
|
application/xml:
|
|
schema:
|
|
items:
|
|
$ref: '#/components/schemas/Pet'
|
|
type: array
|
|
application/json:
|
|
schema:
|
|
items:
|
|
$ref: '#/components/schemas/Pet'
|
|
type: array
|
|
description: successful operation
|
|
"400":
|
|
description: Invalid status value
|
|
security:
|
|
- petstore_auth:
|
|
- read:pets
|
|
summary: Finds Pets by status
|
|
tags:
|
|
- pet
|
|
x-accepts: application/json
|
|
/pet/findByTags:
|
|
get:
|
|
deprecated: true
|
|
description: "Multiple tags can be provided with comma separated strings. Use\
|
|
\ tag1, tag2, tag3 for testing."
|
|
operationId: findPetsByTags
|
|
parameters:
|
|
- description: Tags to filter by
|
|
explode: false
|
|
in: query
|
|
name: tags
|
|
required: true
|
|
schema:
|
|
items:
|
|
type: string
|
|
type: array
|
|
style: form
|
|
responses:
|
|
"200":
|
|
content:
|
|
application/xml:
|
|
schema:
|
|
items:
|
|
$ref: '#/components/schemas/Pet'
|
|
type: array
|
|
application/json:
|
|
schema:
|
|
items:
|
|
$ref: '#/components/schemas/Pet'
|
|
type: array
|
|
description: successful operation
|
|
"400":
|
|
description: Invalid tag value
|
|
security:
|
|
- petstore_auth:
|
|
- read:pets
|
|
summary: Finds Pets by tags
|
|
tags:
|
|
- pet
|
|
x-accepts: application/json
|
|
/pet/{petId}:
|
|
delete:
|
|
description: ""
|
|
operationId: deletePet
|
|
parameters:
|
|
- explode: false
|
|
in: header
|
|
name: api_key
|
|
required: false
|
|
schema:
|
|
type: string
|
|
style: simple
|
|
- description: Pet id to delete
|
|
explode: false
|
|
in: path
|
|
name: petId
|
|
required: true
|
|
schema:
|
|
format: int64
|
|
type: integer
|
|
style: simple
|
|
responses:
|
|
"400":
|
|
description: Invalid pet value
|
|
security:
|
|
- petstore_auth:
|
|
- write:pets
|
|
- read:pets
|
|
summary: Deletes a pet
|
|
tags:
|
|
- pet
|
|
x-accepts: application/json
|
|
get:
|
|
description: Returns a single pet
|
|
operationId: getPetById
|
|
parameters:
|
|
- description: ID of pet to return
|
|
explode: false
|
|
in: path
|
|
name: petId
|
|
required: true
|
|
schema:
|
|
format: int64
|
|
type: integer
|
|
style: simple
|
|
responses:
|
|
"200":
|
|
content:
|
|
application/xml:
|
|
schema:
|
|
$ref: '#/components/schemas/Pet'
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Pet'
|
|
description: successful operation
|
|
"400":
|
|
description: Invalid ID supplied
|
|
"404":
|
|
description: Pet not found
|
|
security:
|
|
- api_key: []
|
|
summary: Find pet by ID
|
|
tags:
|
|
- pet
|
|
x-accepts: application/json
|
|
post:
|
|
description: ""
|
|
operationId: updatePetWithForm
|
|
parameters:
|
|
- description: ID of pet that needs to be updated
|
|
explode: false
|
|
in: path
|
|
name: petId
|
|
required: true
|
|
schema:
|
|
format: int64
|
|
type: integer
|
|
style: simple
|
|
requestBody:
|
|
content:
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/updatePetWithForm_request'
|
|
responses:
|
|
"405":
|
|
description: Invalid input
|
|
security:
|
|
- petstore_auth:
|
|
- write:pets
|
|
- read:pets
|
|
summary: Updates a pet in the store with form data
|
|
tags:
|
|
- pet
|
|
x-group-parameters: false
|
|
x-content-type: application/x-www-form-urlencoded
|
|
x-accepts: application/json
|
|
/pet/{petId}/uploadImage:
|
|
post:
|
|
description: ""
|
|
operationId: uploadFile
|
|
parameters:
|
|
- description: ID of pet to update
|
|
explode: false
|
|
in: path
|
|
name: petId
|
|
required: true
|
|
schema:
|
|
format: int64
|
|
type: integer
|
|
style: simple
|
|
requestBody:
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/uploadFile_request'
|
|
responses:
|
|
"200":
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ApiResponse'
|
|
description: successful operation
|
|
security:
|
|
- petstore_auth:
|
|
- write:pets
|
|
- read:pets
|
|
summary: uploads an image
|
|
tags:
|
|
- pet
|
|
x-content-type: multipart/form-data
|
|
x-accepts: application/json
|
|
components:
|
|
requestBodies:
|
|
UserArray:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
items:
|
|
$ref: '#/components/schemas/User'
|
|
type: array
|
|
description: List of user object
|
|
required: true
|
|
Pet:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Pet'
|
|
application/xml:
|
|
schema:
|
|
$ref: '#/components/schemas/Pet'
|
|
description: Pet object that needs to be added to the store
|
|
required: true
|
|
schemas:
|
|
Order:
|
|
description: An order for a pets from the pet store
|
|
properties:
|
|
id:
|
|
format: int64
|
|
type: integer
|
|
petId:
|
|
format: int64
|
|
type: integer
|
|
quantity:
|
|
format: int32
|
|
type: integer
|
|
shipDate:
|
|
format: date-time
|
|
type: string
|
|
status:
|
|
description: Order Status
|
|
enum:
|
|
- placed
|
|
- approved
|
|
- delivered
|
|
type: string
|
|
complete:
|
|
default: false
|
|
type: boolean
|
|
title: Pet Order
|
|
type: object
|
|
xml:
|
|
name: Order
|
|
Category:
|
|
description: A category for a pet
|
|
example:
|
|
name: name
|
|
id: 6
|
|
properties:
|
|
id:
|
|
format: int64
|
|
type: integer
|
|
name:
|
|
pattern: "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$"
|
|
type: string
|
|
title: Pet category
|
|
type: object
|
|
xml:
|
|
name: Category
|
|
User:
|
|
description: A User who is purchasing from the pet store
|
|
properties:
|
|
id:
|
|
format: int64
|
|
type: integer
|
|
username:
|
|
type: string
|
|
firstName:
|
|
type: string
|
|
lastName:
|
|
type: string
|
|
email:
|
|
type: string
|
|
password:
|
|
type: string
|
|
phone:
|
|
type: string
|
|
userStatus:
|
|
description: User Status
|
|
format: int32
|
|
type: integer
|
|
title: a User
|
|
type: object
|
|
xml:
|
|
name: User
|
|
Tag:
|
|
description: A tag for a pet
|
|
example:
|
|
name: name
|
|
id: 1
|
|
properties:
|
|
id:
|
|
format: int64
|
|
type: integer
|
|
name:
|
|
type: string
|
|
title: Pet Tag
|
|
type: object
|
|
xml:
|
|
name: Tag
|
|
Pet:
|
|
description: A pet for sale in the pet store
|
|
example:
|
|
photoUrls:
|
|
- photoUrls
|
|
- photoUrls
|
|
name: doggie
|
|
id: 0
|
|
category:
|
|
name: name
|
|
id: 6
|
|
tags:
|
|
- name: name
|
|
id: 1
|
|
- name: name
|
|
id: 1
|
|
status: available
|
|
properties:
|
|
id:
|
|
format: int64
|
|
type: integer
|
|
category:
|
|
$ref: '#/components/schemas/Category'
|
|
name:
|
|
example: doggie
|
|
type: string
|
|
photoUrls:
|
|
items:
|
|
type: string
|
|
type: array
|
|
xml:
|
|
name: photoUrl
|
|
wrapped: true
|
|
tags:
|
|
items:
|
|
$ref: '#/components/schemas/Tag'
|
|
type: array
|
|
xml:
|
|
name: tag
|
|
wrapped: true
|
|
status:
|
|
deprecated: true
|
|
description: pet status in the store
|
|
enum:
|
|
- available
|
|
- pending
|
|
- sold
|
|
type: string
|
|
required:
|
|
- name
|
|
- photoUrls
|
|
title: a Pet
|
|
type: object
|
|
xml:
|
|
name: Pet
|
|
ApiResponse:
|
|
description: Describes the result of uploading an image resource
|
|
example:
|
|
code: 0
|
|
type: type
|
|
message: message
|
|
properties:
|
|
code:
|
|
format: int32
|
|
type: integer
|
|
type:
|
|
type: string
|
|
message:
|
|
type: string
|
|
title: An uploaded response
|
|
type: object
|
|
updatePetWithForm_request:
|
|
properties:
|
|
name:
|
|
description: Updated name of the pet
|
|
type: string
|
|
status:
|
|
description: Updated status of the pet
|
|
type: string
|
|
type: object
|
|
uploadFile_request:
|
|
properties:
|
|
additionalMetadata:
|
|
description: Additional data to pass to server
|
|
type: string
|
|
file:
|
|
description: file to upload
|
|
format: binary
|
|
type: string
|
|
type: object
|
|
securitySchemes:
|
|
petstore_auth:
|
|
flows:
|
|
implicit:
|
|
authorizationUrl: http://petstore.swagger.io/api/oauth/dialog
|
|
scopes:
|
|
write:pets: modify pets in your account
|
|
read:pets: read your pets
|
|
type: oauth2
|
|
api_key:
|
|
in: header
|
|
name: api_key
|
|
type: apiKey
|
|
|