FilesExpand file tree

 main

/

openapi.json

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

217 lines (217 loc) · 5.05 KB

 main

/

openapi.json

Copy path

Top

File metadata and controls

• Code
• Blame

217 lines (217 loc) · 5.05 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

{

"openapi": "3.1.0",

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

}

}

}

}

}

}

}

},

"webhooks": {

"/plant/webhook": {

"post": {

"description": "Information about a new plant added to the store",

"requestBody": {

"description": "Plant added to the store",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/NewPlant"

}

}

}

},

"responses": {

"200": {

"description": "Return a 200 status to indicate that the data was received successfully"

}

}

}

}

},

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

}

}

}

}