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​

cURL
curl http://sandbox.mintlify.com/plants \
  --header 'Authorization: Bearer bearerAuth' \
  --header 'Content-Type: application/json'
JavaScript
fetch('http://sandbox.mintlify.com/plants', {
  headers: {
    Authorization: 'Bearer bearerAuth',
    'Content-Type': 'application/json'
  }
})
PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://sandbox.mintlify.com/plants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer bearerAuth",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Python
import requests

url = "http://sandbox.mintlify.com/plants"

headers = {
    "Authorization": "Bearer bearerAuth",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)

print(response.json())
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​

cURL
curl http://sandbox.mintlify.com/plants \
  --request POST \
  --header 'Authorization: Bearer bearerAuth' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "tag": "string",
  "id": 0
}'
JavaScript
fetch('http://sandbox.mintlify.com/plants', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer bearerAuth',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'string',
    tag: 'string',
    id: 0
  })
})
PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://sandbox.mintlify.com/plants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'string',
    'tag' => 'string',
    'id' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer bearerAuth",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Python
import requests

url = "http://sandbox.mintlify.com/plants"

payload = {
    "name": "string",
    "tag": "string",
    "id": 0
}
headers = {
    "Authorization": "Bearer bearerAuth",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
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​

cURL
curl 'http://sandbox.mintlify.com/plants/%7Bid%7D' \
  --request DELETE \
  --header 'Authorization: Bearer bearerAuth' \
  --header 'Content-Type: application/json'
JavaScript
fetch('http://sandbox.mintlify.com/plants/%7Bid%7D', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer bearerAuth',
    'Content-Type': 'application/json'
  }
})
PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://sandbox.mintlify.com/plants/%7Bid%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer bearerAuth",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Python
import requests

url = "http://sandbox.mintlify.com/plants/%7Bid%7D"

headers = {
    "Authorization": "Bearer bearerAuth",
    "Content-Type": "application/json"
}

response = requests.delete(url, headers=headers)

print(response.json())
Powered by VitePress OpenAPI