From 7afdbc1f5bd6501af1a1d993bd95e88ed47424c1 Mon Sep 17 00:00:00 2001 From: angie pinilla Date: Sat, 4 Jun 2022 23:09:54 -0400 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4a2539e..ca35936 100644 --- a/README.md +++ b/README.md @@ -19,16 +19,14 @@ Currently used for: https://angie44.github.io/theOffice **Required:** - `season=[integer] // season number [1-9], inclusive` + * `season=[integer] // season number [1-9], inclusive` - `format=[string] // "quotes" or "connections"` + * `format=[string] // "quotes" or "connections"` * **Success Response:** - * **Code:** 200
- - **Content [Quotes]:** [{ "season": _seasonNumber, "episode" : _episodeNumber, "scene": _sceneNumber,_"episode_name": _episodeName, "character": _character,_"quote" : _quote_}] - - **Content [Connections]:** { "data" : [{ "episode": _episodeNumber_, "name": _episodeName_, "links" : [{ "source" : _characterName_, "target": _characterName_, "value" : _numberOfCoOccurencesInEpisode_ }], "nodes" : [{ "id" : _characterName_ }]} + * **Code:** 200 + * **Content [Quotes]:** `[{ "season": seasonNumber, "episode" : episodeNumber, "scene": sceneNumber, "episode_name": episodeName, "character": character, "quote" : quote}]` + * **Content [Connections]:** `{ "data" : [{ "episode": episodeNumber, "name": episodeName, "links" : [{ "source" : characterName, "target": characterName, "value" : numberOfCoOccurencesInEpisode }], "nodes" : [{ "id" : characterName }]}` * Get quotes for a specific season and episode @@ -38,11 +36,11 @@ Currently used for: https://angie44.github.io/theOffice **Required:** - `season=[integer] // season number [1-9], inclusive` + * `season=[integer] // season number [1-9], inclusive` - `episode=[integer] // episode number within season (indexing begins at 1)` + * `episode=[integer] // episode number within season (indexing begins at 1)` * **Success Response:** - * **Code:** 200
- **Content:** [{ "season": _seasonNumber,_"episode" : _episodeNumber, "scene": _sceneNumber,_"episode_name": _episodeName, "character": _character,_"quote" : _quote_}] + * **Code:** 200 + * **Content:** `[{ "season": seasonNumber, "episode" : episodeNumber, "scene": sceneNumber, "episode_name": episodeName, "character": character, "quote" : quote }]`