# Pets

## Create

**post** `/pets`

Add a new pet to the store.

### Body Parameters

- `name: string`

- `photoUrls: array of string`

- `id: optional number`

- `category: optional Category`

  - `id: optional number`

  - `name: optional string`

- `status: optional "available" or "pending" or "sold"`

  pet status in the store

  - `"available"`

  - `"pending"`

  - `"sold"`

- `tags: optional array of Tag`

  - `id: optional number`

  - `name: optional string`

### Returns

- `Pet = object { name, photoUrls, id, 3 more }`

  - `name: string`

  - `photoUrls: array of string`

  - `id: optional number`

  - `category: optional Category`

    - `id: optional number`

    - `name: optional string`

  - `status: optional "available" or "pending" or "sold"`

    pet status in the store

    - `"available"`

    - `"pending"`

    - `"sold"`

  - `tags: optional array of Tag`

    - `id: optional number`

    - `name: optional string`

### Example

```http
curl http://localhost:4000/api/v3/pets \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BARKEND_BEARER_TOKEN" \
    -d '{
          "name": "doggie",
          "photoUrls": [
            "string"
          ],
          "id": 10
        }'
```

## List

**get** `/pets`

List all pets.

### Returns

- `name: string`

- `photoUrls: array of string`

- `id: optional number`

- `category: optional Category`

  - `id: optional number`

  - `name: optional string`

- `status: optional "available" or "pending" or "sold"`

  pet status in the store

  - `"available"`

  - `"pending"`

  - `"sold"`

- `tags: optional array of Tag`

  - `id: optional number`

  - `name: optional string`

### Example

```http
curl http://localhost:4000/api/v3/pets \
    -H "Authorization: Bearer $BARKEND_BEARER_TOKEN"
```

## Retrieve

**get** `/pets/{petId}`

Find pet by ID.

### Path Parameters

- `petId: number`

### Returns

- `Pet = object { name, photoUrls, id, 3 more }`

  - `name: string`

  - `photoUrls: array of string`

  - `id: optional number`

  - `category: optional Category`

    - `id: optional number`

    - `name: optional string`

  - `status: optional "available" or "pending" or "sold"`

    pet status in the store

    - `"available"`

    - `"pending"`

    - `"sold"`

  - `tags: optional array of Tag`

    - `id: optional number`

    - `name: optional string`

### Example

```http
curl http://localhost:4000/api/v3/pets/$PET_ID \
    -H "Authorization: Bearer $BARKEND_BEARER_TOKEN"
```

## Delete

**delete** `/pets/{petId}`

Deletes a pet.

### Path Parameters

- `petId: number`

### Example

```http
curl http://localhost:4000/api/v3/pets/$PET_ID \
    -X DELETE \
    -H "Authorization: Bearer $BARKEND_BEARER_TOKEN"
```

## Domain Types

### Category

- `Category = object { id, name }`

  - `id: optional number`

  - `name: optional string`

### Error

- `Error = object { id, message }`

  - `id: string`

    Machine-readable error code

  - `message: string`

    Human-readable error message

### Error Response

- `ErrorResponse = object { error }`

  - `error: Error`

    - `id: string`

      Machine-readable error code

    - `message: string`

      Human-readable error message

### Pet

- `Pet = object { name, photoUrls, id, 3 more }`

  - `name: string`

  - `photoUrls: array of string`

  - `id: optional number`

  - `category: optional Category`

    - `id: optional number`

    - `name: optional string`

  - `status: optional "available" or "pending" or "sold"`

    pet status in the store

    - `"available"`

    - `"pending"`

    - `"sold"`

  - `tags: optional array of Tag`

    - `id: optional number`

    - `name: optional string`

### Tag

- `Tag = object { id, name }`

  - `id: optional number`

  - `name: optional string`