-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapiary.apib
148 lines (105 loc) · 3.6 KB
/
apiary.apib
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
FORMAT: 1A
# cucumberly
Cucumberly is a gherkin editor for muggles, but it's still in its early stages. Show some love and contribute :)
# Group Features
## Features [/api/features]
### List All Features [GET]
+ Response 200 (application/json)
[
{
"items": [
{
"name": "Addition",
"id": "79aed2e7-a5b1-4b46-93d5-e481575692c5"
"description": {
"beneficiary": "math idiot",
"motivation": "avoid silly mistakes",
"expectedBehaviour": "to be told the sum of two numbers"
}
}
]
}
]
### Create a New Feature [POST]
+ Request (application/json)
{
"name": "Addition",
"description": {
"beneficiary": "math idiot",
"motivation": "avoid silly mistakes",
"expectedBehaviour": "to be told the sum of two numbers"
}
}
+ Response 201 (application/json)
+ Body
{
"id": "79aed2e7-a5b1-4b46-93d5-e481575692c5"
}
## Modify a feature [/api/features/{featureId}]
### Update a features [PUT]
Just submit the fields you want to update
+ Request (application/json)
{
"name": "Addition",
"description": {
"motivation": "avoid silly mistakes"
}
}
+ Response 201 (application/json)
+ Response 200 (application/json)
## Scenarios [/api/features/{featureId}/scenarios]
### List All Scenarios [GET]
+ Response 200 (application/json)
+ Body
{
"items": [
{
"name": "Add two numbers",
"id": "79aed2e7-a5b1-4b46-93d5-e481575692c5",
"description": "addition of two numbers",
"steps": {
"given": [
"I have forgotten all about math",
"I have entered 2 and 3"
],
"when": [
"I press calculate"
],
"then": [
"the result is 5"
]
}
}
]
}
### Create a new scenario [POST]
+ Request (application/json)
{
"name": "Add two numbers",
"description": "addition of two numbers",
"steps": {
"given": [
"I have forgotten all about math",
"I have entered 2 and 3"
],
"when": [
"I press calculate"
],
"then": [
"the result is 5"
]
}
}
+ Response 201 (application/json)
+ Body
{
"id": "79aed2e7-a5b1-4b46-93d5-e481575692c5"
}
## Modify an existing scenario [/api/features/{featureId}/scenarios/{scenarioId}]
### Modify a scenario [PUT]
+ Request (application/json)
{
"name": "Addition"
}
+ Response 201 (application/json)
+ Response 200 (application/json)