Skip to content

Commit 29316d7

Browse files
author
Nicholas Thomson
committed
Update README.md
Add steps required for changing the API data.
1 parent 608d1fe commit 29316d7

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,21 @@ $ grunt serve
1818
```
1919
---
2020

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.
35+
2136
## Endpoint Schemas
2237

2338
### Companies
@@ -94,4 +109,4 @@ $ grunt serve
94109
]
95110
}
96111
]
97-
}
112+
}

0 commit comments

Comments
 (0)