openapi: 3.0.1
info:
title: OpenAPI Plant Store Plants API
description: A sample API that uses a plant store as an example to demonstrate features in the OpenAPI specification
license:
name: MIT
version: 1.0.0
servers:
- url: http://sandbox.mintlify.com
security:
- bearerAuth: []
tags:
- name: Plants
paths:
/plants:
get:
description: Returns all plants from the system that the user has access to
parameters:
- name: limit
in: query
description: The maximum number of results to return
schema:
type: integer
format: int32
responses:
'200':
description: Plant response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Plant'
'400':
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Plants
post:
description: Creates a new plant in the store
requestBody:
description: Plant to add to the store
content:
application/json:
schema:
$ref: '#/components/schemas/NewPlant'
required: true
responses:
'200':
description: plant response
content:
application/json:
schema:
$ref: '#/components/schemas/Plant'
'400':
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Plants
/plants/{id}:
delete:
description: Deletes a single plant based on the ID supplied
parameters:
- name: id
in: path
description: ID of plant to delete
required: true
schema:
type: integer
format: int64
responses:
'204':
description: Plant deleted
content: {}
'400':
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Plants
components:
schemas:
NewPlant:
allOf:
- $ref: '#/components/schemas/Plant'
- required:
- id
type: object
properties:
id:
description: Identification number of the plant
type: integer
format: int64
Plant:
required:
- name
type: object
properties:
name:
description: The name of the plant
type: string
tag:
description: Tag to specify the type
type: string
Error:
required:
- error
- message
type: object
properties:
error:
type: integer
format: int32
message:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer