This repository has been archived by the owner on Jan 19, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
apiary.json
150 lines (131 loc) · 4.12 KB
/
apiary.json
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
FORMAT: 1A
HOST: http://polls.apiblueprint.org/
# Acio-js
Polls is a simple API allowing consumers to view polls and vote in them.
## Jobs Item [/jobs/id]
### Retrieve A Job [GET]
+ Response 200 (application/json)
{
"_id": "LrFqCDoiAwXcx8j43",
"name": "t1",
"description": "t1",
"env": [
{
"key": "k1",
"value": "v1"
}
],
"template": {
"_id": "Q9kz2Sz66Z6bEcsHy",
"name": "My template",
"libraries": [
"https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.2/lodash.min.js"
],
"code": "setInterval(function() {result(_.VERSION, {reqNewJob:false} );}, 10)",
"createdAt": "2016-11-20T16:00:31.000Z"
},
"collection": {
"_id": "ZCXR9oH7hE2Ko7gYs",
"name": "my colelction",
"parameters": [
"source1",
"source2",
"source3"
],
"notes": "lol",
"createdAt": "2016-11-20T16:00:48.000Z"
},
"status": "working",
"createdAt": "2016-11-20T16:06:31.313Z"
}
## Jobs Collection [/jobs]
### List All Jobs [GET]
+ Response 200 (application/json)
{
"data": [
{
"_id": "LrFqCDoiAwXcx8j43",
"name": "t1",
"description": "t1",
"env": [
{
"key": "k1",
"value": "v1"
}
],
"template": {
"_id": "Q9kz2Sz66Z6bEcsHy",
"name": "My template",
"libraries": [
"https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.2/lodash.min.js"
],
"code": "setInterval(function() {result(_.VERSION, {reqNewJob:false} );}, 10)",
"createdAt": "2016-11-20T16:00:31.000Z"
},
"collection": {
"_id": "ZCXR9oH7hE2Ko7gYs",
"name": "my colelction",
"parameters": [
"source1",
"source2",
"source3"
],
"notes": "lol",
"createdAt": "2016-11-20T16:00:48.000Z"
},
"status": "working",
"createdAt": "2016-11-20T16:06:31.313Z"
}
],
"totalCount": 1
}
### Create a New Job [POST]
You may create your own job using this action. It takes a JSON
object containing the job settings
+ Request (application/json)
{
"name": "My JOB Name",
"description": "My job description",
"env": [
{ key: "ENV", value: "production" }
],
"template": "template id"
"collection": "collection id"
}
+ Response 201 (application/json)
+ Headers
Location: /jobs/LrFqCDoiAwXcx8j43
+ Body
{
"_id": "LrFqCDoiAwXcx8j43",
"name": "My JOB Name",
"description": "My job description",
"env": [
{
"key": "ENV",
"value": "production"
}
],
"template": {
"_id": "Q9kz2Sz66Z6bEcsHy",
"name": "My template",
"libraries": [
"https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.2/lodash.min.js"
],
"code": "result(_.VERSION, {reqNewJob:false} );}",
"createdAt": "2016-11-20T16:00:31.000Z"
},
"collection": {
"_id": "ZCXR9oH7hE2Ko7gYs",
"name": "my colelction",
"parameters": [
"source1",
"source2",
"source3"
],
"notes": "lol",
"createdAt": "2016-11-20T16:00:48.000Z"
},
"status": "working",
"createdAt": "2016-11-20T16:06:31.313Z"
}