Skip to main content

Try It Now Dialog

create_pet

Creates a new pet in the store. Duplicates are allowed

Method​

  • JSON-RPC method name: create_pet
  • JSON-RPC version: 2.0

Parameters​

NameTypeRequiredDescription
newPetobjectnoPet to add to the store.

Parameter schema​

{
  "newPet": {
    "description": "Pet to add to the store.",
    "required": false,
    "schema": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "tag": {
          "type": "string"
        }
      }
    }
  }
}

Result​

  • Name: pet
  • Description: the newly created pet
  • Type: allOf

Result schema​

{
  "allOf": [
    {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "tag": {
          "type": "string"
        }
      }
    },
    {
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "integer"
        }
      }
    }
  ]
}

Positional parameters​

Parameter order:

  1. newPet

Errors​

This method may return JSON-RPC standard errors (e.g. -32600, -32601, -32602, -32603) as well as application-specific errors.

TODO: Document method-specific error codes and conditions.

Named Parameters
{
  "jsonrpc": "2.0",
  "method": "create_pet",
  "params": {
    "newPet": {
      "name": "string",
      "tag": "string"
    }
  },
  "id": 1
}
Successful Response
{
  "jsonrpc": "2.0",
  "result": "example",
  "id": 1
}
Positional Parameters
{
  "jsonrpc": "2.0",
  "method": "create_pet",
  "params": [
    {
      "name": "string",
      "tag": "string"
    }
  ],
  "id": 2
}
Successful Response
{
  "jsonrpc": "2.0",
  "result": "example",
  "id": 2
}