Skip to content
v1.0.0

OpenAPI Plant Store

A sample API that uses a plant store as an example to demonstrate features in the OpenAPI specification

License

MIT

Servers

http://sandbox.mintlify.com

Default


GET /plants

GET
/plants

Returns all plants from the system that the user has access to

Authorizations

bearerAuth
TypeHTTP (bearer)

Parameters

Query Parameters

limit

The maximum number of results to return

Typeinteger
formatint32

Responses

Plant response
application/json
JSON
[
{
"name": "string",
"tag": "string"
}
]

Playground

Authorization
Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

POST /plants

POST
/plants

Creates a new plant in the store

Authorizations

bearerAuth
TypeHTTP (bearer)

Request Body

JSON
{
"name": "string",
"tag": "string",
"id": 0
}

Responses

plant response
application/json
JSON
{
"name": "string",
"tag": "string"
}

Playground

Authorization
Body
JSON

Samples

cURL
JavaScript
PHP
Python

DELETE /plants/{id}

DELETE
/plants/{id}

Deletes a single plant based on the ID supplied

Authorizations

bearerAuth
TypeHTTP (bearer)

Parameters

Path Parameters

id*

ID of plant to delete

Typeinteger
Required
formatint64

Responses

Plant deleted

Playground

Authorization
Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

Powered by VitePress OpenAPI