API docs by Redocly

User API (1.0.0)

Download OpenAPI specification:Download

lydia: comeevery@gmail.com URL: https://www.notion.so/lydia-log/PERSON-LIKE-A-SPONGE-5d3b7544b8a24c7a9c1617a363af8213?pvs=4 License: Apache 2.0 Terms of Service

API for managing users

Find out more about Swagger

user

Everything about your Users

Find out more

Get all users

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new user

Request Body schema: application/json

The user to create.

id
string
name
string
email
string
age
integer

Responses

Request samples

Content type
application/json
{
  • "id": "12345",
  • "name": "John Doe",
  • "email": "john.doe@example.com",
  • "age": 30
}

Response samples

Content type
application/json
{
  • "id": "12345",
  • "name": "John Doe",
  • "email": "john.doe@example.com",
  • "age": 30
}

Get a user by ID

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "12345",
  • "name": "John Doe",
  • "email": "john.doe@example.com",
  • "age": 30
}

Update a user

path Parameters
userId
required
string
Request Body schema: application/json

The user to update.

id
string
name
string
email
string
age
integer

Responses

Request samples

Content type
application/json
{
  • "id": "12345",
  • "name": "John Doe",
  • "email": "john.doe@example.com",
  • "age": 30
}

Response samples

Content type
application/json
{
  • "id": "12345",
  • "name": "John Doe",
  • "email": "john.doe@example.com",
  • "age": 30
}

Delete a user

path Parameters
userId
required
string

Responses

Members

회원 전체 조회

Responses

회원 상세 조회

path Parameters
memberId
required
string
Example: member1

회원 아이디

Responses

Common

Summary

Description

Responses

pet

Update an existing pet

Update an existing pet by Id

Authorizations:
petstore_auth
Request Body schema:

Update an existent pet in the store

id
integer <int64>
name
required
string
object (Category)
photoUrls
required
Array of strings
Array of objects (Tag)
status
string
Enum: "available" "pending" "sold"

pet status in the store

Responses

Request samples

Content type
{
  • "id": 10,
  • "name": "doggie",
  • "category": {
    },
  • "photoUrls": [
    ],
  • "tags": [
    ],
  • "status": "available"
}

Response samples

Content type
{
  • "id": 10,
  • "name": "doggie",
  • "category": {
    },
  • "photoUrls": [
    ],
  • "tags": [
    ],
  • "status": "available"
}

Add a new pet to the store

Add a new pet to the store

Authorizations:
petstore_auth
Request Body schema:

Create a new pet in the store

id
integer <int64>
name
required
string
object (Category)
photoUrls
required
Array of strings
Array of objects (Tag)
status
string
Enum: "available" "pending" "sold"

pet status in the store

Responses

Request samples

Content type
{
  • "id": 10,
  • "name": "doggie",
  • "category": {
    },
  • "photoUrls": [
    ],
  • "tags": [
    ],
  • "status": "available"
}

Response samples

Content type
{
  • "id": 10,
  • "name": "doggie",
  • "category": {
    },
  • "photoUrls": [
    ],
  • "tags": [
    ],
  • "status": "available"
}

Finds Pets by status

Multiple status values can be provided with comma separated strings

Authorizations:
petstore_auth
query Parameters
status
string
Default: "available"
Enum: "available" "pending" "sold"

Status values that need to be considered for filter

Responses

Response samples

Content type
[
  • {
    }
]

Finds Pets by tags

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Authorizations:
petstore_auth
query Parameters
tags
Array of strings

Tags to filter by

Responses

Response samples

Content type
[
  • {
    }
]

Find pet by ID

Returns a single pet

Authorizations:
api_keypetstore_auth
path Parameters
petId
required
integer <int64>

ID of pet to return

Responses

Response samples

Content type
{
  • "id": 10,
  • "name": "doggie",
  • "category": {
    },
  • "photoUrls": [
    ],
  • "tags": [
    ],
  • "status": "available"
}

Updates a pet in the store with form data

Authorizations:
petstore_auth
path Parameters
petId
required
integer <int64>

ID of pet that needs to be updated

query Parameters
name
string

Name of pet that needs to be updated

status
string

Status of pet that needs to be updated

Responses

Deletes a pet

delete a pet

Authorizations:
petstore_auth
path Parameters
petId
required
integer <int64>

Pet id to delete

header Parameters
api_key
string

Responses

uploads an image

Authorizations:
petstore_auth
path Parameters
petId
required
integer <int64>

ID of pet to update

query Parameters
additionalMetadata
string

Additional Metadata

Request Body schema: application/octet-stream
string <binary>

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "type": "string",
  • "message": "string"
}

store

Returns pet inventories by status

Returns a map of status codes to quantities

Authorizations:
api_key

Responses

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

Place an order for a pet

Place a new order in the store

Request Body schema:
id
integer <int64>
petId
integer <int64>
quantity
integer <int32>
shipDate
string <date-time>
status
string
Enum: "placed" "approved" "delivered"

Order Status

complete
boolean

Responses

Request samples

Content type
{
  • "id": 10,
  • "petId": 198772,
  • "quantity": 7,
  • "shipDate": "2019-08-24T14:15:22Z",
  • "status": "approved",
  • "complete": true
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "petId": 198772,
  • "quantity": 7,
  • "shipDate": "2019-08-24T14:15:22Z",
  • "status": "approved",
  • "complete": true
}

Find purchase order by ID

For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.

path Parameters
orderId
required
integer <int64>

ID of order that needs to be fetched

Responses

Response samples

Content type
{
  • "id": 10,
  • "petId": 198772,
  • "quantity": 7,
  • "shipDate": "2019-08-24T14:15:22Z",
  • "status": "approved",
  • "complete": true
}

Delete purchase order by ID

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

path Parameters
orderId
required
integer <int64>

ID of the order that needs to be deleted

Responses