github/openapi-core
1
0
Fork 0
mirror of https://github.com/correl/openapi-core.git synced 2024-11-28 11:09:52 +00:00
Code Issues Projects Releases Packages Wiki Activity
openapi-core/tests/integration/data/v3.0/petstore.yaml

300 lines
6.6 KiB
YAML
Raw Normal View History

initial version
2017-09-21 11:51:37 +00:00
openapi: "3.0.0"
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
servers:
servers with request validation
2017-09-25 11:22:55 +00:00
- url: http://petstore.swagger.io/{version}
variables:
version:
enum:
- v1
- v2
default: v1
initial version
2017-09-21 11:51:37 +00:00
paths:
/pets:
get:
summary: List all pets
operationId: listPets
tags:
- pets
parameters:
Parameter with required and allow empty value support
2017-10-18 13:42:10 +00:00
- name: page
in: query
schema:
type: integer
format: int32
default: 1
initial version
2017-09-21 11:51:37 +00:00
- name: limit
in: query
description: How many items to return at one time (max 100)
required: true
schema:
type: integer
format: int32
Schema nullable value
2017-10-17 13:02:21 +00:00
nullable: true
Allow empty value with default
2017-10-19 11:28:28 +00:00
- name: search
in: query
description: Search query
schema:
type: string
default: ""
allowEmptyValue: true
initial version
2017-09-21 11:51:37 +00:00
- name: ids
in: query
description: Filter pets with Ids
schema:
type: array
items:
type: integer
format: int32
Parameter deserializers
2017-11-14 16:05:03 +00:00
- name: tags
in: query
description: Filter pets with tags
schema:
type: array
items:
$ref: "#/components/schemas/Tag"
explode: false
initial version
2017-09-21 11:51:37 +00:00
responses:
'200':
description: An paged array of pets
headers:
x-next:
description: A link to the next page of responses
schema:
type: string
content:
application/json:
schema:
AllOf support
2017-11-06 16:50:00 +00:00
$ref: "#/components/schemas/PetsData"
initial version
2017-09-21 11:51:37 +00:00
post:
summary: Create a pet
operationId: createPets
tags:
- pets
requestBody:
Request validator
2017-11-02 16:05:25 +00:00
required: true
initial version
2017-09-21 11:51:37 +00:00
content:
application/json:
schema:
$ref: '#/components/schemas/PetCreate'
responses:
'201':
description: Null response
default:
Allow undefined schema type
2018-04-04 10:26:21 +00:00
$ref: "#/components/responses/ErrorResponse"
initial version
2017-09-21 11:51:37 +00:00
/pets/{petId}:
get:
summary: Info for a specific pet
operationId: showPetById
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to retrieve
schema:
type: integer
format: int64
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
AllOf support
2017-11-06 16:50:00 +00:00
$ref: "#/components/schemas/PetData"
Mimetype wildcards support
2018-05-30 13:46:54 +00:00
image/*:
schema:
type: string
format: binary
initial version
2017-09-21 11:51:37 +00:00
default:
Response dereference support
2017-11-06 14:57:08 +00:00
$ref: "#/components/responses/ErrorResponse"
Response JSON text as array fix
2018-04-23 18:50:29 +00:00
/tags:
get:
summary: List all tags
operationId: listTags
tags:
- tags
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: "#/components/schemas/TagList"
default:
$ref: "#/components/responses/ErrorResponse"
OneOf schema support
2018-05-25 15:32:09 +00:00
post:
summary: Create new tag
operationId: createTag
tags:
- tags
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TagCreate'
responses:
'200':
description: Null response
default:
$ref: "#/components/responses/ErrorResponse"
initial version
2017-09-21 11:51:37 +00:00
components:
schemas:
components and infos modules; schema registry; models module
2017-09-22 08:14:07 +00:00
Address:
type: object
x-model: Address
required:
- city
properties:
street:
type: string
city:
type: string
Additional enum test
2017-10-17 13:46:09 +00:00
Tag:
type: string
enum:
Schema enum
2017-11-14 13:36:05 +00:00
- cats
- dogs
- birds
Additional enum test
2017-10-17 13:46:09 +00:00
Position:
type: integer
enum:
- 1
- 2
- 3
initial version
2017-09-21 11:51:37 +00:00
Pet:
type: object
components and infos modules; schema registry; models module
2017-09-22 08:14:07 +00:00
x-model: Pet
allOf:
- $ref: "#/components/schemas/PetCreate"
initial version
2017-09-21 11:51:37 +00:00
required:
- id
properties:
id:
type: integer
format: int64
PetCreate:
components and infos modules; schema registry; models module
2017-09-22 08:14:07 +00:00
x-model: PetCreate
Fixing Subschema Required Properties Validation Currently if valid swagger syntax is used for model composition an error will be thrown due to the lack of a type property. This was corrected by making object the default type. schema_type = schema_deref.get('type', 'object') I changed the swagger definition to test for this. Now PetCreate is a composite of PetCreatePartOne and PetCreatePartTwo. However, this caused `test_post_pets_empty_body` to fail, which turned out to be a bug in the required properties. In `_unmarshal_object` the `get_all_properties` method is called to get all properties from the subschemas. However, this is not done for required properties, meaning that only top level required properties will be correctly validated. I have added a `get_all_required_properties’ to fix this. This caused `test_get_pets` to fail. In this case the bug allowed an incorrect test case to be introduced. Pet requires `id`, but it also requires name because it inherits from PetCreate. I have fixed this test case by adding the missing required property. After these changes `test_get_pet_not_found` failed due to a string formatting error (double quotes vs single quotes). I fixed this by switching to dictionary comparisons.
2018-04-04 14:15:45 +00:00
allOf:
- $ref: "#/components/schemas/PetCreatePartOne"
- $ref: "#/components/schemas/PetCreatePartTwo"
OneOf schema support
2018-05-25 15:32:09 +00:00
oneOf:
- $ref: "#/components/schemas/Cat"
- $ref: "#/components/schemas/Bird"
Fixing Subschema Required Properties Validation Currently if valid swagger syntax is used for model composition an error will be thrown due to the lack of a type property. This was corrected by making object the default type. schema_type = schema_deref.get('type', 'object') I changed the swagger definition to test for this. Now PetCreate is a composite of PetCreatePartOne and PetCreatePartTwo. However, this caused `test_post_pets_empty_body` to fail, which turned out to be a bug in the required properties. In `_unmarshal_object` the `get_all_properties` method is called to get all properties from the subschemas. However, this is not done for required properties, meaning that only top level required properties will be correctly validated. I have added a `get_all_required_properties’ to fix this. This caused `test_get_pets` to fail. In this case the bug allowed an incorrect test case to be introduced. Pet requires `id`, but it also requires name because it inherits from PetCreate. I have fixed this test case by adding the missing required property. After these changes `test_get_pet_not_found` failed due to a string formatting error (double quotes vs single quotes). I fixed this by switching to dictionary comparisons.
2018-04-04 14:15:45 +00:00
PetCreatePartOne:
type: object
x-model: PetCreatePartOne
initial version
2017-09-21 11:51:37 +00:00
required:
- name
properties:
name:
type: string
tag:
Schema enum
2017-11-14 13:36:05 +00:00
$ref: "#/components/schemas/Tag"
components and infos modules; schema registry; models module
2017-09-22 08:14:07 +00:00
address:
$ref: "#/components/schemas/Address"
Fixing Subschema Required Properties Validation Currently if valid swagger syntax is used for model composition an error will be thrown due to the lack of a type property. This was corrected by making object the default type. schema_type = schema_deref.get('type', 'object') I changed the swagger definition to test for this. Now PetCreate is a composite of PetCreatePartOne and PetCreatePartTwo. However, this caused `test_post_pets_empty_body` to fail, which turned out to be a bug in the required properties. In `_unmarshal_object` the `get_all_properties` method is called to get all properties from the subschemas. However, this is not done for required properties, meaning that only top level required properties will be correctly validated. I have added a `get_all_required_properties’ to fix this. This caused `test_get_pets` to fail. In this case the bug allowed an incorrect test case to be introduced. Pet requires `id`, but it also requires name because it inherits from PetCreate. I have fixed this test case by adding the missing required property. After these changes `test_get_pet_not_found` failed due to a string formatting error (double quotes vs single quotes). I fixed this by switching to dictionary comparisons.
2018-04-04 14:15:45 +00:00
PetCreatePartTwo:
type: object
x-model: PetCreatePartTwo
properties:
Additional enum test
2017-10-17 13:46:09 +00:00
position:
$ref: "#/components/schemas/Position"
Boolean value cast fix
2018-02-28 12:01:05 +00:00
healthy:
type: boolean
OneOf schema support
2018-05-25 15:32:09 +00:00
Bird:
type: object
x-model: Bird
required:
- wings
properties:
wings:
$ref: "#/components/schemas/Wings"
Wings:
type: object
x-model: Wings
required:
- healthy
properties:
healthy:
type: boolean
Cat:
type: object
x-model: Cat
required:
- ears
properties:
ears:
$ref: "#/components/schemas/Ears"
Ears:
type: object
x-model: Ears
required:
- healthy
properties:
healthy:
type: boolean
initial version
2017-09-21 11:51:37 +00:00
Pets:
AllOf support
2017-11-06 16:50:00 +00:00
type: array
items:
$ref: "#/components/schemas/Pet"
PetsData:
Response validator
2017-11-06 13:32:31 +00:00
type: object
AllOf support
2017-11-06 16:50:00 +00:00
required:
- data
properties:
data:
$ref: "#/components/schemas/Pets"
PetData:
type: object
required:
- data
Response validator
2017-11-06 13:32:31 +00:00
properties:
data:
AllOf support
2017-11-06 16:50:00 +00:00
$ref: "#/components/schemas/Pet"
OneOf schema support
2018-05-25 15:32:09 +00:00
TagCreate:
type: object
required:
- name
properties:
name:
type: string
Schema format accepts any value
2018-05-30 08:41:34 +00:00
format: custom
Response JSON text as array fix
2018-04-23 18:50:29 +00:00
TagList:
type: array
items:
$ref: "#/components/schemas/Tag"
initial version
2017-09-21 11:51:37 +00:00
Error:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
Response dereference support
2017-11-06 14:57:08 +00:00
type: string
Allow undefined schema type
2018-04-04 10:26:21 +00:00
ExtendedError:
allOf:
- $ref: "#/components/schemas/Error"
- type: object
required:
- rootCause
properties:
rootCause:
type: string
Schema additional properties support
2018-05-30 10:15:17 +00:00
additionalProperties:
type: string
Response dereference support
2017-11-06 14:57:08 +00:00
responses:
ErrorResponse:
description: unexpected error
content:
application/json:
schema:
Allow undefined schema type
2018-04-04 10:26:21 +00:00
$ref: "#/components/schemas/ExtendedError"
Reference in a new issue Copy permalink