Merge pull request #50 from PortoCode/update-docs

Update Documentation

Author: PortoCode

README.md

@@ -3,7 +3,7 @@
 [![CI-iOS](https://github.com/PortoCode/essential-feed/actions/workflows/CI-iOS.yml/badge.svg)](https://github.com/PortoCode/essential-feed/actions/workflows/CI-iOS.yml)
 [![CI-macOS](https://github.com/PortoCode/essential-feed/actions/workflows/CI-macOS.yml/badge.svg)](https://github.com/PortoCode/essential-feed/actions/workflows/CI-macOS.yml)
 
-## BDD Specs
+## Image Feed Feature Specs
 
 ### Story: Customer requests to see their image feed
 
@@ -19,9 +19,9 @@ So I can always enjoy the newest images of my friends
 
 ```
 Given the customer has connectivity
-When the customer requests to see their feed
-Then the app should display the latest feed from remote
-And replace the cache with the new feed
+ When the customer requests to see their feed
+ Then the app should display the latest feed from remote
+  And replace the cache with the new feed
 ```
 
 ### Narrative #2
@@ -36,21 +36,21 @@ So I can always enjoy images of my friends
 
 ```
 Given the customer doesn't have connectivity
-And there’s a cached version of the feed
-And the cache is less than seven days old
-When the customer requests to see the feed
-Then the app should display the latest feed saved
+  And there’s a cached version of the feed
+  And the cache is less than seven days old
+ When the customer requests to see the feed
+ Then the app should display the latest feed saved
 
 Given the customer doesn't have connectivity
-And there’s a cached version of the feed
-And the cache is seven days old or more
-When the customer requests to see the feed
-Then the app should display an error message
+  And there’s a cached version of the feed
+  And the cache is seven days old or more
+ When the customer requests to see the feed
+ Then the app should display an error message
 
 Given the customer doesn't have connectivity
-And the cache is empty
-When the customer requests to see the feed
-Then the app should display an error message
+  And the cache is empty
+ When the customer requests to see the feed
+ Then the app should display an error message
 ```
 
 ## Use Cases
@@ -83,8 +83,6 @@ Then the app should display an error message
 #### Primary course (happy path):
 1. Execute "Load Image Data" command with above data.
 2. System downloads data from the URL.
-
-
 3. System validates downloaded data.
 4. System delivers image data.
 
@@ -176,13 +174,24 @@ Then the app should display an error message
 
 ---
 
-## Flowchart
+### Cache Feed Image Data Use Case
 
-![Feed Loading Feature](feed_flowchart.png)
+#### Data:
+- Image Data
+
+#### Primary course (happy path):
+1. Execute "Save Image Data" command with above data.
+2. System caches image data.
+3. System delivers success message.
+
+#### Saving error course (sad path):
+1. System delivers error.
 
-## Architecture
+---
 
-![Feed Loading Feature](feed_architecture.png)
+## Flowchart
+
+![Feed Loading Feature](feed_flowchart.png)
 
 ## Model Specs
 
@@ -193,36 +202,141 @@ Then the app should display an error message
 | `id`          | `UUID`              |
 | `description` | `String` (optional) |
 | `location`    | `String` (optional) |
-| `url`    | `URL`               |
+| `url`	        | `URL`               |
 
 ### Payload contract
 
 ```
-GET *url* (TBD)
+GET /feed
+
 200 RESPONSE
+
 {
- "items": [
-  {
-   "id": "a UUID",
-   "description": "a description",
-   "location": "a location",
-   "image": "https://a-image.url",
-  },
-  {
-   "id": "another UUID",
-   "description": "another description",
-   "image": "https://another-image.url"
-  },
-  {
-   "id": "even another UUID",
-   "location": "even another location",
-   "image": "https://even-another-image.url"
-  },
-  {
-   "id": "yet another UUID",
-   "image": "https://yet-another-image.url"
-  }
-  ...
- ]
+	"items": [
+		{
+			"id": "a UUID",
+			"description": "a description",
+			"location": "a location",
+			"image": "https://a-image.url",
+		},
+		{
+			"id": "another UUID",
+			"description": "another description",
+			"image": "https://another-image.url"
+		},
+		{
+			"id": "even another UUID",
+			"location": "even another location",
+			"image": "https://even-another-image.url"
+		},
+		{
+			"id": "yet another UUID",
+			"image": "https://yet-another-image.url"
+		}
+		...
+	]
 }
 ```
+
+---
+
+## Image Comments Feature Specs
+
+### Story: Customer requests to see image comments
+
+### Narrative
+
+```
+As an online customer
+I want the app to load image commments
+So I can see how people are engaging with images in my feed
+```
+
+#### Scenarios (Acceptance criteria)
+
+```
+Given the customer has connectivity
+ When the customer requests to see comments on an image
+ Then the app should display all comments for that image
+```
+
+```
+Given the customer doesn't have connectivity
+ When the customer requests to see comments on an image
+ Then the app should display an error message
+```
+
+## Use Cases
+
+### Load Image Comments From Remote Use Case
+
+#### Data:
+- ImageID
+
+#### Primary course (happy path):
+1. Execute "Load Image Comments" command with above data.
+2. System loads data from remote service.
+3. System validates data.
+4. System creates comments from valid data.
+5. System delivers comments.
+
+#### Invalid data – error course (sad path):
+1. System delivers invalid data error.
+
+#### No connectivity – error course (sad path):
+1. System delivers connectivity error.
+
+---
+
+## Model Specs
+
+### Image Comment
+
+| Property          | Type                    |
+|-------------------|-------------------------|
+| `id`              | `UUID`                  |
+| `message` 	    | `String`			      |
+| `created_at`      | `Date` (ISO8601 String) |
+| `author` 			| `CommentAuthorObject`   |
+
+### Image Comment Author
+
+| Property          | Type                |
+|-------------------|---------------------|
+| `username` 	    | `String`			  |
+
+### Payload contract
+
+```
+GET /image/{image-id}/comments
+
+2xx RESPONSE
+
+{
+	"items": [
+		{
+			"id": "a UUID",
+			"message": "a message",
+			"created_at": "2020-05-20T11:24:59+0000",
+			"author": {
+				"username": "a username"
+			}
+		},
+		{
+			"id": "another UUID",
+			"message": "another message",
+			"created_at": "2020-05-19T14:23:53+0000",
+			"author": {
+				"username": "another username"
+			}
+		},
+		...
+	]
+}
+```
+
+---
+
+## App Architecture
+
+![](architecture.png)