OpenApiRequestBody

Request Body schema:

Pet object that needs to be added to the store

object

Categories this pet belongs to

name
required
string

The name given to a pet

photoUrls
required
Array of strings <url> <= 20 items

The list of URL to a cute photos featuring pet

friend
object Recursive
Array of objects (Tag) non-empty

Tags attached to the pet

status
string

Pet status in the store

Enum: "available" "pending" "sold"
petType
string

Type of a pet

huntingSkill
required
string
Default: "lazy"

The measured skill for hunting

Enum: "clueless" "lazy" "adventurous" "aggressive"
{
  • "category": {
    },
  • "name": "Guru",
  • "photoUrls": [
    ],
  • "friend": { },
  • "tags": [
    ],
  • "status": "available",
  • "petType": "cat",
  • "huntingSkill": "adventurous"
}
Request Body schema:

Pet object that needs to be added to the store

object

Categories this pet belongs to

name
required
string

The name given to a pet

photoUrls
required
Array of strings <url> <= 20 items

The list of URL to a cute photos featuring pet

friend
object Recursive
Array of objects (Tag) non-empty

Tags attached to the pet

status
string

Pet status in the store

Enum: "available" "pending" "sold"
petType
string

Type of a pet

huntingSkill
required
string
Default: "lazy"

The measured skill for hunting

Enum: "clueless" "lazy" "adventurous" "aggressive"
<OpenApiRequestBody definitionId="petstore" pointer="#/components/requestBodies/Pet" />
<OpenApiRequestBody
  definitionId="petstore"
  pointer="#/components/requestBodies/Pet"
  hideSamples={true}
/>

Props

NameTypeDefaultDescription
definitionId*stringDefinition ID as defined in siteConfig.yaml
pointer*stringJSON Pointer to the Response Object inside the definition
hideSamplesbooleanfalseHide dark right panel