OpenAPI Specification

Pets

Gets a paginated list of pets

get
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Query parameters
namestringOptional

The name of the pet

Example: Scooby-Doo
petTypestring · enumOptional

The type of the pet

Example: DogPossible values:
pageIndexinteger · int32Optional

Page index, starts from 1

Example: 1
pageSizeinteger · int32Optional

Amount of records per page

Example: 20
sortstringOptional

Field used for sorting

Example: id
orderstringOptional

Order used for sorting (asc or desc)

Example: asc
searchstringOptional

Full-text search clause that can match multiple fields

Example: %foo%
idsstring · uuid[]Optional

Optional list of IDs to filter the records

Responses
200

Success

get
/v1/pets

Gets a single pet by ID

get
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Path parameters
idstring · uuidRequired

Pet ID

Responses
200

Success

get
/v1/pets/{id}

Creates a new pet

post
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Body
idstring · uuidOptional

The object's unique identifier

createdAtstring · date-timeRead-onlyOptional

When the object was created

createdBystring | nullableRead-onlyOptional

Who created the object

Example: [email protected]
modifiedAtstring · date-timeRead-onlyOptional

When the object was last modified

modifiedBystring | nullableRead-onlyOptional

Who modified the object last time

Example: [email protected]
ownerIdstring | nullableRead-onlyOptional

The object's owner

Example: [email protected]
namestring · min: 1Required

The name of the pet

Example: Scooby-Doo
petTypestring · min: 1Required

The type of the pet

Example: Dog
Responses
post
/v1/pets

Updates an existing pet

put
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Path parameters
idstring · uuidRequired

Pet ID

Body
idstring · uuidOptional

The object's unique identifier

createdAtstring · date-timeRead-onlyOptional

When the object was created

createdBystring | nullableRead-onlyOptional

Who created the object

Example: [email protected]
modifiedAtstring · date-timeRead-onlyOptional

When the object was last modified

modifiedBystring | nullableRead-onlyOptional

Who modified the object last time

Example: [email protected]
ownerIdstring | nullableRead-onlyOptional

The object's owner

Example: [email protected]
namestring · min: 1Required

The name of the pet

Example: Scooby-Doo
petTypestring · min: 1Required

The type of the pet

Example: Dog
Responses
200

Success

put
/v1/pets/{id}

Deletes an existing pet

delete
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Path parameters
idstring · uuidRequired

Pet ID

Responses
200

Success

delete
/v1/pets/{id}

Vaccines

Gets a paginated list of vaccines

get
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Query parameters
namestringOptional

The name of the vaccine

Example: Acme
descriptionstringOptional

The description of the vaccine

Example: %prevents from madness%
petTypestring · enumOptional

The pet type which the vaccine applies to

Example: DogPossible values:
durationMininteger · int32Optional

The minimum duration of the vaccine in days

Example: 30
durationMaxinteger · int32Optional

The maximum duration of the vaccine in days

Example: 90
pageIndexinteger · int32Optional

Page index, starts from 1

Example: 1
pageSizeinteger · int32Optional

Amount of records per page

Example: 20
sortstringOptional

Field used for sorting

Example: id
orderstringOptional

Order used for sorting (asc or desc)

Example: asc
searchstringOptional

Full-text search clause that can match multiple fields

Example: %foo%
idsstring · uuid[]Optional

Optional list of IDs to filter the records

Responses
200

Success

get
/v1/vaccines

Gets a single vaccine by ID

get
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Path parameters
idstring · uuidRequired

Vaccine ID

Responses
200

Success

get
/v1/vaccines/{id}

Creates a new vaccine

post
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Body
idstring · uuidOptional

The object's unique identifier

createdAtstring · date-timeRead-onlyOptional

When the object was created

createdBystring | nullableRead-onlyOptional

Who created the object

Example: [email protected]
modifiedAtstring · date-timeRead-onlyOptional

When the object was last modified

modifiedBystring | nullableRead-onlyOptional

Who modified the object last time

Example: [email protected]
namestring · min: 1Required

The name of the vaccine

Example: Acme
descriptionstring | nullableOptional

The description of the vaccine

Example: Acme is a vaccine that prevents dogs from walking over water
petTypestring · min: 1Required

The pet type which the vaccine applies to

Example: Dog
durationinteger · int32Required

The duration of the vaccine in days

Example: 365
Responses
post
/v1/vaccines

Updates an existing vaccine

put
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Path parameters
idstring · uuidRequired

Vaccine ID

Body
idstring · uuidOptional

The object's unique identifier

createdAtstring · date-timeRead-onlyOptional

When the object was created

createdBystring | nullableRead-onlyOptional

Who created the object

Example: [email protected]
modifiedAtstring · date-timeRead-onlyOptional

When the object was last modified

modifiedBystring | nullableRead-onlyOptional

Who modified the object last time

Example: [email protected]
namestring · min: 1Required

The name of the vaccine

Example: Acme
descriptionstring | nullableOptional

The description of the vaccine

Example: Acme is a vaccine that prevents dogs from walking over water
petTypestring · min: 1Required

The pet type which the vaccine applies to

Example: Dog
durationinteger · int32Required

The duration of the vaccine in days

Example: 365
Responses
200

Success

put
/v1/vaccines/{id}

Deletes an existing vaccine

delete
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Path parameters
idstring · uuidRequired

Vaccine ID

Responses
200

Success

delete
/v1/vaccines/{id}

Pet Vaccination

Gets a paginated list of pet vaccinations

get
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Query parameters
petIdstring · uuidOptional

The ID of the pet

vaccineIdstring · uuidOptional

The ID of the vaccine

appliedAtstring · date-timeOptional

Exact match of when the vaccine was applied at

appliedAtMinstring · date-timeOptional

Minimum date of when the vaccine was applied at

appliedAtMaxstring · date-timeOptional

Maximum date of when the vaccine was applied at

pageIndexinteger · int32Optional

Page index, starts from 1

Example: 1
pageSizeinteger · int32Optional

Amount of records per page

Example: 20
sortstringOptional

Field used for sorting

Example: id
orderstringOptional

Order used for sorting (asc or desc)

Example: asc
searchstringOptional

Full-text search clause that can match multiple fields

Example: %foo%
idsstring · uuid[]Optional

Optional list of IDs to filter the records

Responses
200

Success

get
/v1/pet-vaccination

Gets a single pet vaccination by ID

get
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Path parameters
idstring · uuidRequired

Pet vaccination ID

Responses
200

Success

get
/v1/pet-vaccination/{id}

Creates a new pet vaccination

post
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Body
idstring · uuidOptional

The object's unique identifier

createdAtstring · date-timeRead-onlyOptional

When the object was created

createdBystring | nullableRead-onlyOptional

Who created the object

Example: [email protected]
modifiedAtstring · date-timeRead-onlyOptional

When the object was last modified

modifiedBystring | nullableRead-onlyOptional

Who modified the object last time

Example: [email protected]
petIdstring · uuidRequired

The ID of the pet

vaccineIdstring · uuidRequired

The ID of the vaccine

appliedAtstring · date-timeRequired

When the vaccine was applied at

Responses
post
/v1/pet-vaccination

Updates an existing pet vaccination

put
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Path parameters
idstring · uuidRequired

Pet vaccination ID

Body
idstring · uuidOptional

The object's unique identifier

createdAtstring · date-timeRead-onlyOptional

When the object was created

createdBystring | nullableRead-onlyOptional

Who created the object

Example: [email protected]
modifiedAtstring · date-timeRead-onlyOptional

When the object was last modified

modifiedBystring | nullableRead-onlyOptional

Who modified the object last time

Example: [email protected]
petIdstring · uuidRequired

The ID of the pet

vaccineIdstring · uuidRequired

The ID of the vaccine

appliedAtstring · date-timeRequired

When the vaccine was applied at

Responses
200

Success

put
/v1/pet-vaccination/{id}

Deletes an existing pet vaccination

delete
Authorizations
AuthorizationstringRequired

JWT Authorization header using the Bearer scheme

Path parameters
idstring · uuidRequired

Pet vaccination ID

Responses
200

Success

delete
/v1/pet-vaccination/{id}

Last updated