You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-1Lines changed: 16 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,21 @@ $ grunt serve
18
18
```
19
19
---
20
20
21
+
## Changing the API
22
+
23
+
You should be using the faker for local development, not staging data.
24
+
25
+
If you need to a make a change to the API, complete the following steps:
26
+
1. Update webApiFaker to produce the type of output that you expect.
27
+
1. In the same commit, update the JSON in the README to match what webApiFaker now returns
28
+
1. Add a ticket to pivotal tracker assigned to the backend team and labeled with 'api'
29
+
1. Include a link to the README (perhaps the diff as well) with the version of the API you need
30
+
1. When the API team finishes the change and marks the ticket as 'delivered' determine if the output matches your expectations (check this by running grunt serve:staging)
31
+
1. If the output is as expected, accept the ticket
32
+
1. The the output is incorrect, reject the ticket (possibly ping the person on the backend team as well)
33
+
34
+
Once the API has been successfully updated, any code that relies on the new data can be merged to master.
0 commit comments