forked from loafle/openapi-generator-original
157 lines
3.5 KiB
YAML
157 lines
3.5 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
|
|
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
|
|
- application/xml
|
|
components:
|
|
requestBodies:
|
|
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:
|
|
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
|
|
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
|
|
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
|
|
|