Skip to content

Commit 4fc812e

Browse files
authored
Merge pull request Vonage#86 from prik-k/patch-1
Update README.md
2 parents 7702632 + a80278d commit 4fc812e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

conversation/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Testing Conversation API Curl scripts
44

5-
These are some notes on testing the Conversation API using these Curl scripts.
5+
These are some notes on testing the Conversation API using these `Curl` scripts.
66

77
Eventually I would like to write an automated script to do this but for now it's manual.
88

@@ -33,18 +33,18 @@ These are used to test various objects in the Conversation API.
3333

3434
1. Create a Conversation - set the variable `CONVERSATION_ID` in your `config.local.sh` file.
3535
2. List Conversations - confirm `CONVERSATION_ID` returned is as expected.
36-
3. Get a Conversation
36+
3. Get a Conversation.
3737
4. Update a Conversation - you can change the name of the Conversation for example. Use `get-conversation.sh` to check the change.
38-
5. Delete a Conversation - then list Conversations again to make sure it has been removed
38+
5. Delete a Conversation - then list Conversations again to make sure it has been removed fully.
3939

4040
Create a new Conversation before moving on to testing User. Make sure you update `config.local.sh`.
4141

4242
### User
4343

4444
1. Create a User - set the variable `USER_ID` in your `config.local.sh` file.
45-
2. List Users
46-
3. Get a User
47-
4. Update a User - then use get-user.sh to make sure the user was updated.
45+
2. List Users .
46+
3. Get a User.
47+
4. Update a User - then use `get-user.sh` to make sure the user was updated.
4848
5. Get a User Conversations - the user has not been joined to any conversations so this will be an empty array.
4949
6. Delete a User - list users to confirm empty array is returned.
5050

@@ -72,7 +72,7 @@ to test events you will need to join the member into a conversation. To do this
7272

7373
### Leg
7474

75-
Depending on what other testing you have done on the APP_ID you might
75+
Depending on what other testing you have done on the `APP_ID` you might
7676
not have any Legs. The quickest way to create a Leg for testing
7777
purposes is as follows:
7878

@@ -81,7 +81,7 @@ purposes is as follows:
8181

8282
Now that at least one leg has been created:
8383

84-
1. List Legs - make a note of a leg UUID (part of the legs JSON object) and set in your local config.
84+
1. List Legs - make a note of a leg `UUID` (part of the legs `JSON object`) and set in your local config.
8585
2. Delete a Leg - Delete a leg and confirm deletion by listing legs.
8686

8787
---

0 commit comments

Comments
 (0)