VitePress OpenAPI

Appearance

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​

Operations​

GET/plantsPOST/plantsDELETE/plants/{id}
ID: get-plants

GET /plants​

Default
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"
}
]

Samples​

ID: post-plants

POST /plants​

Default
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"
}

Samples​

ID: delete-plants-{id}

DELETE /plants/{id}​

Default
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

Samples​

Powered by VitePress OpenAPI