fictium 0.2.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.travis.yml +9 -0
- data/CHANGELOG.md +9 -0
- data/Gemfile.lock +1 -1
- data/README.md +1 -0
- data/lib/fictium/configurations/configuration.rb +2 -1
- data/lib/fictium/configurations/postman.rb +29 -0
- data/lib/fictium/evaluators/postman_evaluator.rb +59 -0
- data/lib/fictium/exporters/postman/schemas/2.1.0.json +1174 -0
- data/lib/fictium/exporters/postman/v2_exporter/action_formatter.rb +40 -0
- data/lib/fictium/exporters/postman/v2_exporter/body_formatter.rb +15 -0
- data/lib/fictium/exporters/postman/v2_exporter/folder_formatter.rb +27 -0
- data/lib/fictium/exporters/postman/v2_exporter/header_formatter.rb +15 -0
- data/lib/fictium/exporters/postman/v2_exporter/info_formatter.rb +26 -0
- data/lib/fictium/exporters/postman/v2_exporter/item_formatter.rb +29 -0
- data/lib/fictium/exporters/postman/v2_exporter/metadata_formatter.rb +17 -0
- data/lib/fictium/exporters/postman/v2_exporter/request_formatter.rb +89 -0
- data/lib/fictium/exporters/postman/v2_exporter/response_formatter.rb +50 -0
- data/lib/fictium/exporters/postman/v2_exporter.rb +61 -0
- data/lib/fictium/loader.rb +5 -0
- data/lib/fictium/poros/model.rb +3 -0
- data/lib/fictium/poros/postman_metadata.rb +5 -0
- data/lib/fictium/rspec/autocomplete/example.rb +12 -6
- data/lib/fictium/rspec/resources.rb +5 -0
- data/lib/fictium/version.rb +1 -1
- metadata +15 -1
|
@@ -0,0 +1,1174 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
3
|
+
"id": "https://schema.getpostman.com/json/collection/v2.1.0/",
|
|
4
|
+
"type": "object",
|
|
5
|
+
"properties": {
|
|
6
|
+
"info": {
|
|
7
|
+
"$ref": "#/definitions/info"
|
|
8
|
+
},
|
|
9
|
+
"item": {
|
|
10
|
+
"type": "array",
|
|
11
|
+
"description": "Items are the basic unit for a Postman collection. You can think of them as corresponding to a single API endpoint. Each Item has one request and may have multiple API responses associated with it.",
|
|
12
|
+
"items": {
|
|
13
|
+
"title": "Items",
|
|
14
|
+
"oneOf": [
|
|
15
|
+
{
|
|
16
|
+
"$ref": "#/definitions/item"
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
"$ref": "#/definitions/item-group"
|
|
20
|
+
}
|
|
21
|
+
]
|
|
22
|
+
}
|
|
23
|
+
},
|
|
24
|
+
"event": {
|
|
25
|
+
"$ref": "#/definitions/event-list"
|
|
26
|
+
},
|
|
27
|
+
"variable": {
|
|
28
|
+
"$ref": "#/definitions/variable-list"
|
|
29
|
+
},
|
|
30
|
+
"auth": {
|
|
31
|
+
"oneOf": [
|
|
32
|
+
{
|
|
33
|
+
"type": "null"
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"$ref": "#/definitions/auth"
|
|
37
|
+
}
|
|
38
|
+
]
|
|
39
|
+
},
|
|
40
|
+
"protocolProfileBehavior": {
|
|
41
|
+
"$ref": "#/definitions/protocol-profile-behavior"
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
"required": [
|
|
45
|
+
"info",
|
|
46
|
+
"item"
|
|
47
|
+
],
|
|
48
|
+
"definitions": {
|
|
49
|
+
"auth-attribute": {
|
|
50
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
51
|
+
"type": "object",
|
|
52
|
+
"title": "Auth",
|
|
53
|
+
"id": "#/definitions/auth-attribute",
|
|
54
|
+
"description": "Represents an attribute for any authorization method provided by Postman. For example `username` and `password` are set as auth attributes for Basic Authentication method.",
|
|
55
|
+
"properties": {
|
|
56
|
+
"key": {
|
|
57
|
+
"type": "string"
|
|
58
|
+
},
|
|
59
|
+
"value": {},
|
|
60
|
+
"type": {
|
|
61
|
+
"type": "string"
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
"required": [
|
|
65
|
+
"key"
|
|
66
|
+
]
|
|
67
|
+
},
|
|
68
|
+
"auth": {
|
|
69
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
70
|
+
"type": "object",
|
|
71
|
+
"title": "Auth",
|
|
72
|
+
"id": "#/definitions/auth",
|
|
73
|
+
"description": "Represents authentication helpers provided by Postman",
|
|
74
|
+
"properties": {
|
|
75
|
+
"type": {
|
|
76
|
+
"type": "string",
|
|
77
|
+
"enum": [
|
|
78
|
+
"apikey",
|
|
79
|
+
"awsv4",
|
|
80
|
+
"basic",
|
|
81
|
+
"bearer",
|
|
82
|
+
"digest",
|
|
83
|
+
"hawk",
|
|
84
|
+
"noauth",
|
|
85
|
+
"oauth1",
|
|
86
|
+
"oauth2",
|
|
87
|
+
"ntlm"
|
|
88
|
+
]
|
|
89
|
+
},
|
|
90
|
+
"noauth": {},
|
|
91
|
+
"apikey": {
|
|
92
|
+
"type": "array",
|
|
93
|
+
"title": "API Key Authentication",
|
|
94
|
+
"description": "The attributes for API Key Authentication.",
|
|
95
|
+
"items": {
|
|
96
|
+
"$ref": "#/definitions/auth-attribute"
|
|
97
|
+
}
|
|
98
|
+
},
|
|
99
|
+
"awsv4": {
|
|
100
|
+
"type": "array",
|
|
101
|
+
"title": "AWS Signature v4",
|
|
102
|
+
"description": "The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).",
|
|
103
|
+
"items": {
|
|
104
|
+
"$ref": "#/definitions/auth-attribute"
|
|
105
|
+
}
|
|
106
|
+
},
|
|
107
|
+
"basic": {
|
|
108
|
+
"type": "array",
|
|
109
|
+
"title": "Basic Authentication",
|
|
110
|
+
"description": "The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).",
|
|
111
|
+
"items": {
|
|
112
|
+
"$ref": "#/definitions/auth-attribute"
|
|
113
|
+
}
|
|
114
|
+
},
|
|
115
|
+
"bearer": {
|
|
116
|
+
"type": "array",
|
|
117
|
+
"title": "Bearer Token Authentication",
|
|
118
|
+
"description": "The helper attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750)",
|
|
119
|
+
"items": {
|
|
120
|
+
"$ref": "#/definitions/auth-attribute"
|
|
121
|
+
}
|
|
122
|
+
},
|
|
123
|
+
"digest": {
|
|
124
|
+
"type": "array",
|
|
125
|
+
"title": "Digest Authentication",
|
|
126
|
+
"description": "The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication).",
|
|
127
|
+
"items": {
|
|
128
|
+
"$ref": "#/definitions/auth-attribute"
|
|
129
|
+
}
|
|
130
|
+
},
|
|
131
|
+
"hawk": {
|
|
132
|
+
"type": "array",
|
|
133
|
+
"title": "Hawk Authentication",
|
|
134
|
+
"description": "The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk)",
|
|
135
|
+
"items": {
|
|
136
|
+
"$ref": "#/definitions/auth-attribute"
|
|
137
|
+
}
|
|
138
|
+
},
|
|
139
|
+
"ntlm": {
|
|
140
|
+
"type": "array",
|
|
141
|
+
"title": "NTLM Authentication",
|
|
142
|
+
"description": "The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx)",
|
|
143
|
+
"items": {
|
|
144
|
+
"$ref": "#/definitions/auth-attribute"
|
|
145
|
+
}
|
|
146
|
+
},
|
|
147
|
+
"oauth1": {
|
|
148
|
+
"type": "array",
|
|
149
|
+
"title": "OAuth1",
|
|
150
|
+
"description": "The attributes for [OAuth2](https://oauth.net/1/)",
|
|
151
|
+
"items": {
|
|
152
|
+
"$ref": "#/definitions/auth-attribute"
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
"oauth2": {
|
|
156
|
+
"type": "array",
|
|
157
|
+
"title": "OAuth2",
|
|
158
|
+
"description": "Helper attributes for [OAuth2](https://oauth.net/2/)",
|
|
159
|
+
"items": {
|
|
160
|
+
"$ref": "#/definitions/auth-attribute"
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
},
|
|
164
|
+
"required": [
|
|
165
|
+
"type"
|
|
166
|
+
]
|
|
167
|
+
},
|
|
168
|
+
"certificate-list": {
|
|
169
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
170
|
+
"id": "#/definitions/certificate-list",
|
|
171
|
+
"title": "Certificate List",
|
|
172
|
+
"description": "A representation of a list of ssl certificates",
|
|
173
|
+
"type": "array",
|
|
174
|
+
"items": {
|
|
175
|
+
"$ref": "#/definitions/certificate"
|
|
176
|
+
}
|
|
177
|
+
},
|
|
178
|
+
"certificate": {
|
|
179
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
180
|
+
"id": "#/definitions/certificate",
|
|
181
|
+
"title": "Certificate",
|
|
182
|
+
"description": "A representation of an ssl certificate",
|
|
183
|
+
"type": "object",
|
|
184
|
+
"properties": {
|
|
185
|
+
"name": {
|
|
186
|
+
"description": "A name for the certificate for user reference",
|
|
187
|
+
"type": "string"
|
|
188
|
+
},
|
|
189
|
+
"matches": {
|
|
190
|
+
"description": "A list of Url match pattern strings, to identify Urls this certificate can be used for.",
|
|
191
|
+
"type": "array",
|
|
192
|
+
"item": {
|
|
193
|
+
"type": "string",
|
|
194
|
+
"description": "An Url match pattern string"
|
|
195
|
+
}
|
|
196
|
+
},
|
|
197
|
+
"key": {
|
|
198
|
+
"description": "An object containing path to file containing private key, on the file system",
|
|
199
|
+
"type": "object",
|
|
200
|
+
"properties": {
|
|
201
|
+
"src": {
|
|
202
|
+
"description": "The path to file containing key for certificate, on the file system"
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
},
|
|
206
|
+
"cert": {
|
|
207
|
+
"description": "An object containing path to file certificate, on the file system",
|
|
208
|
+
"type": "object",
|
|
209
|
+
"properties": {
|
|
210
|
+
"src": {
|
|
211
|
+
"description": "The path to file containing key for certificate, on the file system"
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
},
|
|
215
|
+
"passphrase": {
|
|
216
|
+
"description": "The passphrase for the certificate",
|
|
217
|
+
"type": "string"
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
},
|
|
221
|
+
"cookie-list": {
|
|
222
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
223
|
+
"id": "#/definitions/cookie-list",
|
|
224
|
+
"title": "Certificate List",
|
|
225
|
+
"description": "A representation of a list of cookies",
|
|
226
|
+
"type": "array",
|
|
227
|
+
"items": {
|
|
228
|
+
"$ref": "#/definitions/cookie"
|
|
229
|
+
}
|
|
230
|
+
},
|
|
231
|
+
"cookie": {
|
|
232
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
233
|
+
"type": "object",
|
|
234
|
+
"title": "Cookie",
|
|
235
|
+
"id": "#/definitions/cookie",
|
|
236
|
+
"description": "A Cookie, that follows the [Google Chrome format](https://developer.chrome.com/extensions/cookies)",
|
|
237
|
+
"properties": {
|
|
238
|
+
"domain": {
|
|
239
|
+
"type": "string",
|
|
240
|
+
"description": "The domain for which this cookie is valid."
|
|
241
|
+
},
|
|
242
|
+
"expires": {
|
|
243
|
+
"oneOf": [
|
|
244
|
+
{
|
|
245
|
+
"type": "string"
|
|
246
|
+
},
|
|
247
|
+
{
|
|
248
|
+
"type": "number"
|
|
249
|
+
}
|
|
250
|
+
],
|
|
251
|
+
"description": "When the cookie expires."
|
|
252
|
+
},
|
|
253
|
+
"maxAge": {
|
|
254
|
+
"type": "string"
|
|
255
|
+
},
|
|
256
|
+
"hostOnly": {
|
|
257
|
+
"type": "boolean",
|
|
258
|
+
"description": "True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie)."
|
|
259
|
+
},
|
|
260
|
+
"httpOnly": {
|
|
261
|
+
"type": "boolean",
|
|
262
|
+
"description": "Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts)"
|
|
263
|
+
},
|
|
264
|
+
"name": {
|
|
265
|
+
"type": "string",
|
|
266
|
+
"description": "This is the name of the Cookie."
|
|
267
|
+
},
|
|
268
|
+
"path": {
|
|
269
|
+
"type": "string",
|
|
270
|
+
"description": "The path associated with the Cookie."
|
|
271
|
+
},
|
|
272
|
+
"secure": {
|
|
273
|
+
"type": "boolean",
|
|
274
|
+
"description": "Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS)"
|
|
275
|
+
},
|
|
276
|
+
"session": {
|
|
277
|
+
"type": "boolean",
|
|
278
|
+
"description": "True if the cookie is a session cookie."
|
|
279
|
+
},
|
|
280
|
+
"value": {
|
|
281
|
+
"type": "string",
|
|
282
|
+
"description": "The value of the Cookie."
|
|
283
|
+
},
|
|
284
|
+
"extensions": {
|
|
285
|
+
"type": "array",
|
|
286
|
+
"description": "Custom attributes for a cookie go here, such as the [Priority Field](https://code.google.com/p/chromium/issues/detail?id=232693)"
|
|
287
|
+
}
|
|
288
|
+
},
|
|
289
|
+
"required": [
|
|
290
|
+
"domain",
|
|
291
|
+
"path"
|
|
292
|
+
]
|
|
293
|
+
},
|
|
294
|
+
"description": {
|
|
295
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
296
|
+
"id": "#/definitions/description",
|
|
297
|
+
"description": "A Description can be a raw text, or be an object, which holds the description along with its format.",
|
|
298
|
+
"oneOf": [
|
|
299
|
+
{
|
|
300
|
+
"type": "object",
|
|
301
|
+
"title": "Description",
|
|
302
|
+
"properties": {
|
|
303
|
+
"content": {
|
|
304
|
+
"type": "string",
|
|
305
|
+
"description": "The content of the description goes here, as a raw string."
|
|
306
|
+
},
|
|
307
|
+
"type": {
|
|
308
|
+
"type": "string",
|
|
309
|
+
"description": "Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.\nThe type is used to correctly render the description when generating documentation, or in the Postman app."
|
|
310
|
+
},
|
|
311
|
+
"version": {
|
|
312
|
+
"description": "Description can have versions associated with it, which should be put in this property."
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
},
|
|
316
|
+
{
|
|
317
|
+
"type": "string"
|
|
318
|
+
},
|
|
319
|
+
{
|
|
320
|
+
"type": "null"
|
|
321
|
+
}
|
|
322
|
+
]
|
|
323
|
+
},
|
|
324
|
+
"event-list": {
|
|
325
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
326
|
+
"id": "#/definitions/event-list",
|
|
327
|
+
"title": "Event List",
|
|
328
|
+
"type": "array",
|
|
329
|
+
"description": "Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID.",
|
|
330
|
+
"items": {
|
|
331
|
+
"$ref": "#/definitions/event"
|
|
332
|
+
}
|
|
333
|
+
},
|
|
334
|
+
"event": {
|
|
335
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
336
|
+
"id": "#/definitions/event",
|
|
337
|
+
"title": "Event",
|
|
338
|
+
"description": "Defines a script associated with an associated event name",
|
|
339
|
+
"type": "object",
|
|
340
|
+
"properties": {
|
|
341
|
+
"id": {
|
|
342
|
+
"type": "string",
|
|
343
|
+
"description": "A unique identifier for the enclosing event."
|
|
344
|
+
},
|
|
345
|
+
"listen": {
|
|
346
|
+
"type": "string",
|
|
347
|
+
"description": "Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively."
|
|
348
|
+
},
|
|
349
|
+
"script": {
|
|
350
|
+
"$ref": "#/definitions/script"
|
|
351
|
+
},
|
|
352
|
+
"disabled": {
|
|
353
|
+
"type": "boolean",
|
|
354
|
+
"default": false,
|
|
355
|
+
"description": "Indicates whether the event is disabled. If absent, the event is assumed to be enabled."
|
|
356
|
+
}
|
|
357
|
+
},
|
|
358
|
+
"required": [
|
|
359
|
+
"listen"
|
|
360
|
+
]
|
|
361
|
+
},
|
|
362
|
+
"header-list": {
|
|
363
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
364
|
+
"id": "#/definitions/header-list",
|
|
365
|
+
"title": "Header List",
|
|
366
|
+
"description": "A representation for a list of headers",
|
|
367
|
+
"type": "array",
|
|
368
|
+
"items": {
|
|
369
|
+
"$ref": "#/definitions/header"
|
|
370
|
+
}
|
|
371
|
+
},
|
|
372
|
+
"header": {
|
|
373
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
374
|
+
"type": "object",
|
|
375
|
+
"title": "Header",
|
|
376
|
+
"id": "#/definitions/header",
|
|
377
|
+
"description": "Represents a single HTTP Header",
|
|
378
|
+
"properties": {
|
|
379
|
+
"key": {
|
|
380
|
+
"description": "This holds the LHS of the HTTP Header, e.g ``Content-Type`` or ``X-Custom-Header``",
|
|
381
|
+
"type": "string"
|
|
382
|
+
},
|
|
383
|
+
"value": {
|
|
384
|
+
"type": "string",
|
|
385
|
+
"description": "The value (or the RHS) of the Header is stored in this field."
|
|
386
|
+
},
|
|
387
|
+
"disabled": {
|
|
388
|
+
"type": "boolean",
|
|
389
|
+
"default": false,
|
|
390
|
+
"description": "If set to true, the current header will not be sent with requests."
|
|
391
|
+
},
|
|
392
|
+
"description": {
|
|
393
|
+
"$ref": "#/definitions/description"
|
|
394
|
+
}
|
|
395
|
+
},
|
|
396
|
+
"required": [
|
|
397
|
+
"key",
|
|
398
|
+
"value"
|
|
399
|
+
]
|
|
400
|
+
},
|
|
401
|
+
"info": {
|
|
402
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
403
|
+
"id": "#/definitions/info",
|
|
404
|
+
"title": "Information",
|
|
405
|
+
"description": "Detailed description of the info block",
|
|
406
|
+
"type": "object",
|
|
407
|
+
"properties": {
|
|
408
|
+
"name": {
|
|
409
|
+
"type": "string",
|
|
410
|
+
"title": "Name of the collection",
|
|
411
|
+
"description": "A collection's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this collection among a bunch of other collections, as such outlining its usage or content."
|
|
412
|
+
},
|
|
413
|
+
"_postman_id": {
|
|
414
|
+
"type": "string",
|
|
415
|
+
"description": "Every collection is identified by the unique value of this field. The value of this field is usually easiest to generate using a UID generator function. If you already have a collection, it is recommended that you maintain the same id since changing the id usually implies that is a different collection than it was originally.\n *Note: This field exists for compatibility reasons with Collection Format V1.*"
|
|
416
|
+
},
|
|
417
|
+
"description": {
|
|
418
|
+
"$ref": "#/definitions/description"
|
|
419
|
+
},
|
|
420
|
+
"version": {
|
|
421
|
+
"$ref": "#/definitions/version"
|
|
422
|
+
},
|
|
423
|
+
"schema": {
|
|
424
|
+
"description": "This should ideally hold a link to the Postman schema that is used to validate this collection. E.g: https://schema.getpostman.com/collection/v1",
|
|
425
|
+
"type": "string"
|
|
426
|
+
}
|
|
427
|
+
},
|
|
428
|
+
"required": [
|
|
429
|
+
"name",
|
|
430
|
+
"schema"
|
|
431
|
+
]
|
|
432
|
+
},
|
|
433
|
+
"item-group": {
|
|
434
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
435
|
+
"title": "Folder",
|
|
436
|
+
"id": "#/definitions/item-group",
|
|
437
|
+
"description": "One of the primary goals of Postman is to organize the development of APIs. To this end, it is necessary to be able to group requests together. This can be achived using 'Folders'. A folder just is an ordered set of requests.",
|
|
438
|
+
"type": "object",
|
|
439
|
+
"properties": {
|
|
440
|
+
"name": {
|
|
441
|
+
"type": "string",
|
|
442
|
+
"description": "A folder's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this folder."
|
|
443
|
+
},
|
|
444
|
+
"description": {
|
|
445
|
+
"$ref": "#/definitions/description"
|
|
446
|
+
},
|
|
447
|
+
"variable": {
|
|
448
|
+
"$ref": "#/definitions/variable-list"
|
|
449
|
+
},
|
|
450
|
+
"item": {
|
|
451
|
+
"description": "Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items.",
|
|
452
|
+
"type": "array",
|
|
453
|
+
"items": {
|
|
454
|
+
"title": "Items",
|
|
455
|
+
"anyOf": [
|
|
456
|
+
{
|
|
457
|
+
"$ref": "#/definitions/item"
|
|
458
|
+
},
|
|
459
|
+
{
|
|
460
|
+
"$ref": "#/definitions/item-group"
|
|
461
|
+
}
|
|
462
|
+
]
|
|
463
|
+
}
|
|
464
|
+
},
|
|
465
|
+
"event": {
|
|
466
|
+
"$ref": "#/definitions/event-list"
|
|
467
|
+
},
|
|
468
|
+
"auth": {
|
|
469
|
+
"oneOf": [
|
|
470
|
+
{
|
|
471
|
+
"type": "null"
|
|
472
|
+
},
|
|
473
|
+
{
|
|
474
|
+
"$ref": "#/definitions/auth"
|
|
475
|
+
}
|
|
476
|
+
]
|
|
477
|
+
},
|
|
478
|
+
"protocolProfileBehavior": {
|
|
479
|
+
"$ref": "#/definitions/protocol-profile-behavior"
|
|
480
|
+
}
|
|
481
|
+
},
|
|
482
|
+
"required": [
|
|
483
|
+
"item"
|
|
484
|
+
]
|
|
485
|
+
},
|
|
486
|
+
"item": {
|
|
487
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
488
|
+
"type": "object",
|
|
489
|
+
"title": "Item",
|
|
490
|
+
"id": "#/definitions/item",
|
|
491
|
+
"description": "Items are entities which contain an actual HTTP request, and sample responses attached to it.",
|
|
492
|
+
"properties": {
|
|
493
|
+
"id": {
|
|
494
|
+
"type": "string",
|
|
495
|
+
"description": "A unique ID that is used to identify collections internally"
|
|
496
|
+
},
|
|
497
|
+
"name": {
|
|
498
|
+
"type": "string",
|
|
499
|
+
"description": "A human readable identifier for the current item."
|
|
500
|
+
},
|
|
501
|
+
"description": {
|
|
502
|
+
"$ref": "#/definitions/description"
|
|
503
|
+
},
|
|
504
|
+
"variable": {
|
|
505
|
+
"$ref": "#/definitions/variable-list"
|
|
506
|
+
},
|
|
507
|
+
"event": {
|
|
508
|
+
"$ref": "#/definitions/event-list"
|
|
509
|
+
},
|
|
510
|
+
"request": {
|
|
511
|
+
"$ref": "#/definitions/request"
|
|
512
|
+
},
|
|
513
|
+
"response": {
|
|
514
|
+
"type": "array",
|
|
515
|
+
"title": "Responses",
|
|
516
|
+
"items": {
|
|
517
|
+
"$ref": "#/definitions/response"
|
|
518
|
+
}
|
|
519
|
+
},
|
|
520
|
+
"protocolProfileBehavior": {
|
|
521
|
+
"$ref": "#/definitions/protocol-profile-behavior"
|
|
522
|
+
}
|
|
523
|
+
},
|
|
524
|
+
"required": [
|
|
525
|
+
"request"
|
|
526
|
+
]
|
|
527
|
+
},
|
|
528
|
+
"protocol-profile-behavior": {
|
|
529
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
530
|
+
"type": "object",
|
|
531
|
+
"title": "Protocol Profile Behavior",
|
|
532
|
+
"id": "#/definitions/protocol-profile-behavior",
|
|
533
|
+
"description": "Set of configurations used to alter the usual behavior of sending the request"
|
|
534
|
+
},
|
|
535
|
+
"proxy-config": {
|
|
536
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
537
|
+
"id": "#/definitions/proxy-config",
|
|
538
|
+
"title": "Proxy Config",
|
|
539
|
+
"description": "Using the Proxy, you can configure your custom proxy into the postman for particular url match",
|
|
540
|
+
"type": "object",
|
|
541
|
+
"properties": {
|
|
542
|
+
"match": {
|
|
543
|
+
"default": "http+https://*/*",
|
|
544
|
+
"description": "The Url match for which the proxy config is defined",
|
|
545
|
+
"type": "string"
|
|
546
|
+
},
|
|
547
|
+
"host": {
|
|
548
|
+
"type": "string",
|
|
549
|
+
"description": "The proxy server host"
|
|
550
|
+
},
|
|
551
|
+
"port": {
|
|
552
|
+
"type": "integer",
|
|
553
|
+
"minimum": 0,
|
|
554
|
+
"default": 8080,
|
|
555
|
+
"description": "The proxy server port"
|
|
556
|
+
},
|
|
557
|
+
"tunnel": {
|
|
558
|
+
"description": "The tunneling details for the proxy config",
|
|
559
|
+
"default": false,
|
|
560
|
+
"type": "boolean"
|
|
561
|
+
},
|
|
562
|
+
"disabled": {
|
|
563
|
+
"type": "boolean",
|
|
564
|
+
"default": false,
|
|
565
|
+
"description": "When set to true, ignores this proxy configuration entity"
|
|
566
|
+
}
|
|
567
|
+
}
|
|
568
|
+
},
|
|
569
|
+
"request": {
|
|
570
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
571
|
+
"id": "#/definitions/request",
|
|
572
|
+
"title": "Request",
|
|
573
|
+
"description": "A request represents an HTTP request. If a string, the string is assumed to be the request URL and the method is assumed to be 'GET'.",
|
|
574
|
+
"oneOf": [
|
|
575
|
+
{
|
|
576
|
+
"type": "object",
|
|
577
|
+
"title": "Request",
|
|
578
|
+
"properties": {
|
|
579
|
+
"url": {
|
|
580
|
+
"$ref": "#/definitions/url"
|
|
581
|
+
},
|
|
582
|
+
"auth": {
|
|
583
|
+
"oneOf": [
|
|
584
|
+
{
|
|
585
|
+
"type": "null"
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
"$ref": "#/definitions/auth"
|
|
589
|
+
}
|
|
590
|
+
]
|
|
591
|
+
},
|
|
592
|
+
"proxy": {
|
|
593
|
+
"$ref": "#/definitions/proxy-config"
|
|
594
|
+
},
|
|
595
|
+
"certificate": {
|
|
596
|
+
"$ref": "#/definitions/certificate"
|
|
597
|
+
},
|
|
598
|
+
"method": {
|
|
599
|
+
"anyOf": [
|
|
600
|
+
{
|
|
601
|
+
"description": "The Standard HTTP method associated with this request.",
|
|
602
|
+
"type": "string",
|
|
603
|
+
"enum": [
|
|
604
|
+
"GET",
|
|
605
|
+
"PUT",
|
|
606
|
+
"POST",
|
|
607
|
+
"PATCH",
|
|
608
|
+
"DELETE",
|
|
609
|
+
"COPY",
|
|
610
|
+
"HEAD",
|
|
611
|
+
"OPTIONS",
|
|
612
|
+
"LINK",
|
|
613
|
+
"UNLINK",
|
|
614
|
+
"PURGE",
|
|
615
|
+
"LOCK",
|
|
616
|
+
"UNLOCK",
|
|
617
|
+
"PROPFIND",
|
|
618
|
+
"VIEW"
|
|
619
|
+
]
|
|
620
|
+
},
|
|
621
|
+
{
|
|
622
|
+
"description": "The Custom HTTP method associated with this request.",
|
|
623
|
+
"type": "string"
|
|
624
|
+
}
|
|
625
|
+
]
|
|
626
|
+
},
|
|
627
|
+
"description": {
|
|
628
|
+
"$ref": "#/definitions/description"
|
|
629
|
+
},
|
|
630
|
+
"header": {
|
|
631
|
+
"oneOf": [
|
|
632
|
+
{
|
|
633
|
+
"$ref": "#/definitions/header-list"
|
|
634
|
+
},
|
|
635
|
+
{
|
|
636
|
+
"type": "string"
|
|
637
|
+
}
|
|
638
|
+
]
|
|
639
|
+
},
|
|
640
|
+
"body": {
|
|
641
|
+
"oneOf": [
|
|
642
|
+
{
|
|
643
|
+
"type": "object",
|
|
644
|
+
"description": "This field contains the data usually contained in the request body.",
|
|
645
|
+
"properties": {
|
|
646
|
+
"mode": {
|
|
647
|
+
"description": "Postman stores the type of data associated with this request in this field.",
|
|
648
|
+
"enum": [
|
|
649
|
+
"raw",
|
|
650
|
+
"urlencoded",
|
|
651
|
+
"formdata",
|
|
652
|
+
"file",
|
|
653
|
+
"graphql"
|
|
654
|
+
]
|
|
655
|
+
},
|
|
656
|
+
"raw": {
|
|
657
|
+
"type": "string"
|
|
658
|
+
},
|
|
659
|
+
"urlencoded": {
|
|
660
|
+
"type": "array",
|
|
661
|
+
"items": {
|
|
662
|
+
"type": "object",
|
|
663
|
+
"title": "UrlEncodedParameter",
|
|
664
|
+
"properties": {
|
|
665
|
+
"key": {
|
|
666
|
+
"type": "string"
|
|
667
|
+
},
|
|
668
|
+
"value": {
|
|
669
|
+
"type": "string"
|
|
670
|
+
},
|
|
671
|
+
"disabled": {
|
|
672
|
+
"type": "boolean",
|
|
673
|
+
"default": false
|
|
674
|
+
},
|
|
675
|
+
"description": {
|
|
676
|
+
"$ref": "#/definitions/description"
|
|
677
|
+
}
|
|
678
|
+
},
|
|
679
|
+
"required": [
|
|
680
|
+
"key"
|
|
681
|
+
]
|
|
682
|
+
}
|
|
683
|
+
},
|
|
684
|
+
"formdata": {
|
|
685
|
+
"type": "array",
|
|
686
|
+
"items": {
|
|
687
|
+
"type": "object",
|
|
688
|
+
"title": "FormParameter",
|
|
689
|
+
"oneOf": [
|
|
690
|
+
{
|
|
691
|
+
"properties": {
|
|
692
|
+
"key": {
|
|
693
|
+
"type": "string"
|
|
694
|
+
},
|
|
695
|
+
"value": {
|
|
696
|
+
"type": "string"
|
|
697
|
+
},
|
|
698
|
+
"disabled": {
|
|
699
|
+
"type": "boolean",
|
|
700
|
+
"default": false,
|
|
701
|
+
"description": "When set to true, prevents this form data entity from being sent."
|
|
702
|
+
},
|
|
703
|
+
"type": {
|
|
704
|
+
"type": "string",
|
|
705
|
+
"enum": [
|
|
706
|
+
"text"
|
|
707
|
+
]
|
|
708
|
+
},
|
|
709
|
+
"contentType": {
|
|
710
|
+
"type": "string",
|
|
711
|
+
"description": "Override Content-Type header of this form data entity."
|
|
712
|
+
},
|
|
713
|
+
"description": {
|
|
714
|
+
"$ref": "#/definitions/description"
|
|
715
|
+
}
|
|
716
|
+
},
|
|
717
|
+
"required": [
|
|
718
|
+
"key"
|
|
719
|
+
]
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
"properties": {
|
|
723
|
+
"key": {
|
|
724
|
+
"type": "string"
|
|
725
|
+
},
|
|
726
|
+
"src": {
|
|
727
|
+
"oneOf": [
|
|
728
|
+
{
|
|
729
|
+
"type": "string"
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
"type": "null"
|
|
733
|
+
},
|
|
734
|
+
{
|
|
735
|
+
"type": "array"
|
|
736
|
+
}
|
|
737
|
+
]
|
|
738
|
+
},
|
|
739
|
+
"disabled": {
|
|
740
|
+
"type": "boolean",
|
|
741
|
+
"default": false,
|
|
742
|
+
"description": "When set to true, prevents this form data entity from being sent."
|
|
743
|
+
},
|
|
744
|
+
"type": {
|
|
745
|
+
"type": "string",
|
|
746
|
+
"enum": [
|
|
747
|
+
"file"
|
|
748
|
+
]
|
|
749
|
+
},
|
|
750
|
+
"contentType": {
|
|
751
|
+
"type": "string",
|
|
752
|
+
"description": "Override Content-Type header of this form data entity."
|
|
753
|
+
},
|
|
754
|
+
"description": {
|
|
755
|
+
"$ref": "#/definitions/description"
|
|
756
|
+
}
|
|
757
|
+
},
|
|
758
|
+
"required": [
|
|
759
|
+
"key"
|
|
760
|
+
]
|
|
761
|
+
}
|
|
762
|
+
]
|
|
763
|
+
}
|
|
764
|
+
},
|
|
765
|
+
"file": {
|
|
766
|
+
"type": "object",
|
|
767
|
+
"properties": {
|
|
768
|
+
"src": {
|
|
769
|
+
"oneOf": [
|
|
770
|
+
{
|
|
771
|
+
"type": "string",
|
|
772
|
+
"description": "Contains the name of the file to upload. _Not the path_."
|
|
773
|
+
},
|
|
774
|
+
{
|
|
775
|
+
"type": "null",
|
|
776
|
+
"description": "A null src indicates that no file has been selected as a part of the request body"
|
|
777
|
+
}
|
|
778
|
+
]
|
|
779
|
+
},
|
|
780
|
+
"content": {
|
|
781
|
+
"type": "string"
|
|
782
|
+
}
|
|
783
|
+
}
|
|
784
|
+
},
|
|
785
|
+
"graphql": {
|
|
786
|
+
"type": "object"
|
|
787
|
+
},
|
|
788
|
+
"disabled": {
|
|
789
|
+
"type": "boolean",
|
|
790
|
+
"default": false,
|
|
791
|
+
"description": "When set to true, prevents request body from being sent."
|
|
792
|
+
}
|
|
793
|
+
}
|
|
794
|
+
},
|
|
795
|
+
{
|
|
796
|
+
"type": "null"
|
|
797
|
+
}
|
|
798
|
+
]
|
|
799
|
+
}
|
|
800
|
+
}
|
|
801
|
+
},
|
|
802
|
+
{
|
|
803
|
+
"type": "string"
|
|
804
|
+
}
|
|
805
|
+
]
|
|
806
|
+
},
|
|
807
|
+
"response": {
|
|
808
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
809
|
+
"id": "#/definitions/response",
|
|
810
|
+
"title": "Response",
|
|
811
|
+
"description": "A response represents an HTTP response.",
|
|
812
|
+
"properties": {
|
|
813
|
+
"id": {
|
|
814
|
+
"description": "A unique, user defined identifier that can be used to refer to this response from requests.",
|
|
815
|
+
"type": "string"
|
|
816
|
+
},
|
|
817
|
+
"originalRequest": {
|
|
818
|
+
"$ref": "#/definitions/request"
|
|
819
|
+
},
|
|
820
|
+
"responseTime": {
|
|
821
|
+
"title": "ResponseTime",
|
|
822
|
+
"oneOf": [
|
|
823
|
+
{
|
|
824
|
+
"type": "null"
|
|
825
|
+
},
|
|
826
|
+
{
|
|
827
|
+
"type": "string"
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
"type": "number"
|
|
831
|
+
}
|
|
832
|
+
],
|
|
833
|
+
"description": "The time taken by the request to complete. If a number, the unit is milliseconds. If the response is manually created, this can be set to `null`."
|
|
834
|
+
},
|
|
835
|
+
"timings": {
|
|
836
|
+
"title": "Response Timings",
|
|
837
|
+
"description": "Set of timing information related to request and response in milliseconds",
|
|
838
|
+
"oneOf": [
|
|
839
|
+
{
|
|
840
|
+
"type": "object"
|
|
841
|
+
},
|
|
842
|
+
{
|
|
843
|
+
"type": "null"
|
|
844
|
+
}
|
|
845
|
+
]
|
|
846
|
+
},
|
|
847
|
+
"header": {
|
|
848
|
+
"title": "Headers",
|
|
849
|
+
"oneOf": [
|
|
850
|
+
{
|
|
851
|
+
"type": "array",
|
|
852
|
+
"title": "Header",
|
|
853
|
+
"description": "No HTTP request is complete without its headers, and the same is true for a Postman request. This field is an array containing all the headers.",
|
|
854
|
+
"items": {
|
|
855
|
+
"oneOf": [
|
|
856
|
+
{
|
|
857
|
+
"$ref": "#/definitions/header"
|
|
858
|
+
},
|
|
859
|
+
{
|
|
860
|
+
"title": "Header",
|
|
861
|
+
"type": "string"
|
|
862
|
+
}
|
|
863
|
+
]
|
|
864
|
+
}
|
|
865
|
+
},
|
|
866
|
+
{
|
|
867
|
+
"type": "string"
|
|
868
|
+
},
|
|
869
|
+
{
|
|
870
|
+
"type": "null"
|
|
871
|
+
}
|
|
872
|
+
]
|
|
873
|
+
},
|
|
874
|
+
"cookie": {
|
|
875
|
+
"type": "array",
|
|
876
|
+
"items": {
|
|
877
|
+
"$ref": "#/definitions/cookie"
|
|
878
|
+
}
|
|
879
|
+
},
|
|
880
|
+
"body": {
|
|
881
|
+
"type": [
|
|
882
|
+
"null",
|
|
883
|
+
"string"
|
|
884
|
+
],
|
|
885
|
+
"description": "The raw text of the response."
|
|
886
|
+
},
|
|
887
|
+
"status": {
|
|
888
|
+
"type": "string",
|
|
889
|
+
"description": "The response status, e.g: '200 OK'"
|
|
890
|
+
},
|
|
891
|
+
"code": {
|
|
892
|
+
"type": "integer",
|
|
893
|
+
"description": "The numerical response code, example: 200, 201, 404, etc."
|
|
894
|
+
}
|
|
895
|
+
}
|
|
896
|
+
},
|
|
897
|
+
"script": {
|
|
898
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
899
|
+
"id": "#/definitions/script",
|
|
900
|
+
"title": "Script",
|
|
901
|
+
"type": "object",
|
|
902
|
+
"description": "A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response.",
|
|
903
|
+
"properties": {
|
|
904
|
+
"id": {
|
|
905
|
+
"description": "A unique, user defined identifier that can be used to refer to this script from requests.",
|
|
906
|
+
"type": "string"
|
|
907
|
+
},
|
|
908
|
+
"type": {
|
|
909
|
+
"description": "Type of the script. E.g: 'text/javascript'",
|
|
910
|
+
"type": "string"
|
|
911
|
+
},
|
|
912
|
+
"exec": {
|
|
913
|
+
"oneOf": [
|
|
914
|
+
{
|
|
915
|
+
"type": "array",
|
|
916
|
+
"description": "This is an array of strings, where each line represents a single line of code. Having lines separate makes it possible to easily track changes made to scripts.",
|
|
917
|
+
"items": {
|
|
918
|
+
"type": "string"
|
|
919
|
+
}
|
|
920
|
+
},
|
|
921
|
+
{
|
|
922
|
+
"type": "string"
|
|
923
|
+
}
|
|
924
|
+
]
|
|
925
|
+
},
|
|
926
|
+
"src": {
|
|
927
|
+
"$ref": "#/definitions/url"
|
|
928
|
+
},
|
|
929
|
+
"name": {
|
|
930
|
+
"type": "string",
|
|
931
|
+
"description": "Script name"
|
|
932
|
+
}
|
|
933
|
+
}
|
|
934
|
+
},
|
|
935
|
+
"url": {
|
|
936
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
937
|
+
"description": "If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.",
|
|
938
|
+
"id": "#/definitions/url",
|
|
939
|
+
"title": "Url",
|
|
940
|
+
"oneOf": [
|
|
941
|
+
{
|
|
942
|
+
"type": "object",
|
|
943
|
+
"properties": {
|
|
944
|
+
"raw": {
|
|
945
|
+
"type": "string",
|
|
946
|
+
"description": "The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s)."
|
|
947
|
+
},
|
|
948
|
+
"protocol": {
|
|
949
|
+
"type": "string",
|
|
950
|
+
"description": "The protocol associated with the request, E.g: 'http'"
|
|
951
|
+
},
|
|
952
|
+
"host": {
|
|
953
|
+
"title": "Host",
|
|
954
|
+
"description": "The host for the URL, E.g: api.yourdomain.com. Can be stored as a string or as an array of strings.",
|
|
955
|
+
"oneOf": [
|
|
956
|
+
{
|
|
957
|
+
"type": "string"
|
|
958
|
+
},
|
|
959
|
+
{
|
|
960
|
+
"type": "array",
|
|
961
|
+
"items": {
|
|
962
|
+
"type": "string"
|
|
963
|
+
},
|
|
964
|
+
"description": "The host, split into subdomain strings."
|
|
965
|
+
}
|
|
966
|
+
]
|
|
967
|
+
},
|
|
968
|
+
"path": {
|
|
969
|
+
"oneOf": [
|
|
970
|
+
{
|
|
971
|
+
"type": "string"
|
|
972
|
+
},
|
|
973
|
+
{
|
|
974
|
+
"type": "array",
|
|
975
|
+
"description": "The complete path of the current url, broken down into segments. A segment could be a string, or a path variable.",
|
|
976
|
+
"items": {
|
|
977
|
+
"oneOf": [
|
|
978
|
+
{
|
|
979
|
+
"type": "string"
|
|
980
|
+
},
|
|
981
|
+
{
|
|
982
|
+
"type": "object",
|
|
983
|
+
"properties": {
|
|
984
|
+
"type": {
|
|
985
|
+
"type": "string"
|
|
986
|
+
},
|
|
987
|
+
"value": {
|
|
988
|
+
"type": "string"
|
|
989
|
+
}
|
|
990
|
+
}
|
|
991
|
+
}
|
|
992
|
+
]
|
|
993
|
+
}
|
|
994
|
+
}
|
|
995
|
+
]
|
|
996
|
+
},
|
|
997
|
+
"port": {
|
|
998
|
+
"type": "string",
|
|
999
|
+
"description": "The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https."
|
|
1000
|
+
},
|
|
1001
|
+
"query": {
|
|
1002
|
+
"type": "array",
|
|
1003
|
+
"description": "An array of QueryParams, which is basically the query string part of the URL, parsed into separate variables",
|
|
1004
|
+
"items": {
|
|
1005
|
+
"type": "object",
|
|
1006
|
+
"title": "QueryParam",
|
|
1007
|
+
"properties": {
|
|
1008
|
+
"key": {
|
|
1009
|
+
"oneOf": [
|
|
1010
|
+
{
|
|
1011
|
+
"type": "string"
|
|
1012
|
+
},
|
|
1013
|
+
{
|
|
1014
|
+
"type": "null"
|
|
1015
|
+
}
|
|
1016
|
+
]
|
|
1017
|
+
},
|
|
1018
|
+
"value": {
|
|
1019
|
+
"oneOf": [
|
|
1020
|
+
{
|
|
1021
|
+
"type": "string"
|
|
1022
|
+
},
|
|
1023
|
+
{
|
|
1024
|
+
"type": "null"
|
|
1025
|
+
}
|
|
1026
|
+
]
|
|
1027
|
+
},
|
|
1028
|
+
"disabled": {
|
|
1029
|
+
"type": "boolean",
|
|
1030
|
+
"default": false,
|
|
1031
|
+
"description": "If set to true, the current query parameter will not be sent with the request."
|
|
1032
|
+
},
|
|
1033
|
+
"description": {
|
|
1034
|
+
"$ref": "#/definitions/description"
|
|
1035
|
+
}
|
|
1036
|
+
}
|
|
1037
|
+
}
|
|
1038
|
+
},
|
|
1039
|
+
"hash": {
|
|
1040
|
+
"description": "Contains the URL fragment (if any). Usually this is not transmitted over the network, but it could be useful to store this in some cases.",
|
|
1041
|
+
"type": "string"
|
|
1042
|
+
},
|
|
1043
|
+
"variable": {
|
|
1044
|
+
"type": "array",
|
|
1045
|
+
"description": "Postman supports path variables with the syntax `/path/:variableName/to/somewhere`. These variables are stored in this field.",
|
|
1046
|
+
"items": {
|
|
1047
|
+
"$ref": "#/definitions/variable"
|
|
1048
|
+
}
|
|
1049
|
+
}
|
|
1050
|
+
}
|
|
1051
|
+
},
|
|
1052
|
+
{
|
|
1053
|
+
"type": "string"
|
|
1054
|
+
}
|
|
1055
|
+
]
|
|
1056
|
+
},
|
|
1057
|
+
"variable-list": {
|
|
1058
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
1059
|
+
"id": "#/definitions/variable-list",
|
|
1060
|
+
"title": "Variable List",
|
|
1061
|
+
"description": "Collection variables allow you to define a set of variables, that are a *part of the collection*, as opposed to environments, which are separate entities.\n*Note: Collection variables must not contain any sensitive information.*",
|
|
1062
|
+
"type": "array",
|
|
1063
|
+
"items": {
|
|
1064
|
+
"$ref": "#/definitions/variable"
|
|
1065
|
+
}
|
|
1066
|
+
},
|
|
1067
|
+
"variable": {
|
|
1068
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
1069
|
+
"id": "#/definitions/variable",
|
|
1070
|
+
"title": "Variable",
|
|
1071
|
+
"description": "Using variables in your Postman requests eliminates the need to duplicate requests, which can save a lot of time. Variables can be defined, and referenced to from any part of a request.",
|
|
1072
|
+
"type": "object",
|
|
1073
|
+
"properties": {
|
|
1074
|
+
"id": {
|
|
1075
|
+
"description": "A variable ID is a unique user-defined value that identifies the variable within a collection. In traditional terms, this would be a variable name.",
|
|
1076
|
+
"type": "string"
|
|
1077
|
+
},
|
|
1078
|
+
"key": {
|
|
1079
|
+
"description": "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name.",
|
|
1080
|
+
"type": "string"
|
|
1081
|
+
},
|
|
1082
|
+
"value": {
|
|
1083
|
+
"description": "The value that a variable holds in this collection. Ultimately, the variables will be replaced by this value, when say running a set of requests from a collection"
|
|
1084
|
+
},
|
|
1085
|
+
"type": {
|
|
1086
|
+
"description": "A variable may have multiple types. This field specifies the type of the variable.",
|
|
1087
|
+
"type": "string",
|
|
1088
|
+
"enum": [
|
|
1089
|
+
"string",
|
|
1090
|
+
"boolean",
|
|
1091
|
+
"any",
|
|
1092
|
+
"number"
|
|
1093
|
+
]
|
|
1094
|
+
},
|
|
1095
|
+
"name": {
|
|
1096
|
+
"type": "string",
|
|
1097
|
+
"description": "Variable name"
|
|
1098
|
+
},
|
|
1099
|
+
"description": {
|
|
1100
|
+
"$ref": "#/definitions/description"
|
|
1101
|
+
},
|
|
1102
|
+
"system": {
|
|
1103
|
+
"type": "boolean",
|
|
1104
|
+
"default": false,
|
|
1105
|
+
"description": "When set to true, indicates that this variable has been set by Postman"
|
|
1106
|
+
},
|
|
1107
|
+
"disabled": {
|
|
1108
|
+
"type": "boolean",
|
|
1109
|
+
"default": false
|
|
1110
|
+
}
|
|
1111
|
+
},
|
|
1112
|
+
"anyOf": [
|
|
1113
|
+
{
|
|
1114
|
+
"required": [
|
|
1115
|
+
"id"
|
|
1116
|
+
]
|
|
1117
|
+
},
|
|
1118
|
+
{
|
|
1119
|
+
"required": [
|
|
1120
|
+
"key"
|
|
1121
|
+
]
|
|
1122
|
+
},
|
|
1123
|
+
{
|
|
1124
|
+
"required": [
|
|
1125
|
+
"id",
|
|
1126
|
+
"key"
|
|
1127
|
+
]
|
|
1128
|
+
}
|
|
1129
|
+
]
|
|
1130
|
+
},
|
|
1131
|
+
"version": {
|
|
1132
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
1133
|
+
"id": "#/definitions/version",
|
|
1134
|
+
"title": "Collection Version",
|
|
1135
|
+
"description": "Postman allows you to version your collections as they grow, and this field holds the version number. While optional, it is recommended that you use this field to its fullest extent!",
|
|
1136
|
+
"oneOf": [
|
|
1137
|
+
{
|
|
1138
|
+
"type": "object",
|
|
1139
|
+
"properties": {
|
|
1140
|
+
"major": {
|
|
1141
|
+
"description": "Increment this number if you make changes to the collection that changes its behaviour. E.g: Removing or adding new test scripts. (partly or completely).",
|
|
1142
|
+
"minimum": 0,
|
|
1143
|
+
"type": "integer"
|
|
1144
|
+
},
|
|
1145
|
+
"minor": {
|
|
1146
|
+
"description": "You should increment this number if you make changes that will not break anything that uses the collection. E.g: removing a folder.",
|
|
1147
|
+
"minimum": 0,
|
|
1148
|
+
"type": "integer"
|
|
1149
|
+
},
|
|
1150
|
+
"patch": {
|
|
1151
|
+
"description": "Ideally, minor changes to a collection should result in the increment of this number.",
|
|
1152
|
+
"minimum": 0,
|
|
1153
|
+
"type": "integer"
|
|
1154
|
+
},
|
|
1155
|
+
"identifier": {
|
|
1156
|
+
"description": "A human friendly identifier to make sense of the version numbers. E.g: 'beta-3'",
|
|
1157
|
+
"type": "string",
|
|
1158
|
+
"maxLength": 10
|
|
1159
|
+
},
|
|
1160
|
+
"meta": {}
|
|
1161
|
+
},
|
|
1162
|
+
"required": [
|
|
1163
|
+
"major",
|
|
1164
|
+
"minor",
|
|
1165
|
+
"patch"
|
|
1166
|
+
]
|
|
1167
|
+
},
|
|
1168
|
+
{
|
|
1169
|
+
"type": "string"
|
|
1170
|
+
}
|
|
1171
|
+
]
|
|
1172
|
+
}
|
|
1173
|
+
}
|
|
1174
|
+
}
|