-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
198 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,195 @@ | ||
{ | ||
"openapi": "3.0.1", | ||
"info": { | ||
"title": "OpenAPI Plant Store", | ||
"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": [] | ||
} | ||
], | ||
"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" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"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" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"/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" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"components": { | ||
"schemas": { | ||
"Plant": { | ||
"required": [ | ||
"name" | ||
], | ||
"type": "object", | ||
"properties": { | ||
"name": { | ||
"description": "The name of the plant", | ||
"type": "string" | ||
}, | ||
"tag": { | ||
"description": "Tag to specify the type", | ||
"type": "string" | ||
} | ||
} | ||
}, | ||
"NewPlant": { | ||
"allOf": [ | ||
{ | ||
"$ref": "#/components/schemas/Plant" | ||
}, | ||
{ | ||
"required": [ | ||
"id" | ||
], | ||
"type": "object", | ||
"properties": { | ||
"id": { | ||
"description": "Identification number of the plant", | ||
"type": "integer", | ||
"format": "int64" | ||
} | ||
} | ||
} | ||
] | ||
}, | ||
"Error": { | ||
"required": [ | ||
"error", | ||
"message" | ||
], | ||
"type": "object", | ||
"properties": { | ||
"error": { | ||
"type": "integer", | ||
"format": "int32" | ||
}, | ||
"message": { | ||
"type": "string" | ||
} | ||
} | ||
} | ||
}, | ||
"securitySchemes": { | ||
"bearerAuth": { | ||
"type": "http", | ||
"scheme": "bearer" | ||
} | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters