OpenApiResponse

User response

Response Schema: application/json
id
integer <int64> (Id)
Pet (object) or Tag (object)
username
string >= 4 characters

User supplied username

firstName
string non-empty

User first name

lastName
string non-empty

User last name

email
string <email>

User email address

password
string <password> >= 8 characters /(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])/

User password, MUST contain a mix of upper and lower case letters, as well as digits

phone
string/^\+(?:[0-9]-?){6,14}[0-9]$/

User phone number in international format

userStatus
integer <int32>

User status

Content type
application/json
{
  • "id": 0,
  • "pet": {
    },
  • "username": "John78",
  • "firstName": "John",
  • "lastName": "Smith",
  • "email": "john.smith@example.com",
  • "password": "drowssaP123",
  • "phone": "+1-202-555-0192",
  • "userStatus": 0
}

User response

Response Schema: application/json
id
integer <int64> (Id)
Pet (object) or Tag (object)
username
string >= 4 characters

User supplied username

firstName
string non-empty

User first name

lastName
string non-empty

User last name

email
string <email>

User email address

password
string <password> >= 8 characters /(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])/

User password, MUST contain a mix of upper and lower case letters, as well as digits

phone
string/^\+(?:[0-9]-?){6,14}[0-9]$/

User phone number in international format

userStatus
integer <int32>

User status

<OpenApiResponse definitionId="petstore" pointer="#/components/responses/UserResponse" />
<OpenApiResponse
  definitionId="petstore"
  pointer="#/components/responses/UserResponse"
  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