Skip to content

Commit

Permalink
Experimenting with diagrams in README
Browse files Browse the repository at this point in the history
  • Loading branch information
gotha committed Jul 8, 2019
1 parent 0bb3e1f commit 6c00469
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,20 @@ To run the service locally, you will need to run the following commands first to
Endpoint | Description
--- | ---
`/content` | Calls **Content-Public-Read** service to expand main images, alternative images and body embedded images + dynamic content

```chart
sequenceDiagram
Client -> contentEndpoint: request
contentEndpoint -> handler: Article in ReqBody
handler -> service_UnrollContent: UnrollEvent
service_UnrollContent -> reader: UUIDs (ImageSetType,DynamicContentType)
reader -> content_public_read: UUIDs of images
content_public_read --> reader: content of images
reader --> service_UnrollContent: list of documents
service_UnrollContent --> handler: UnrollResult
handler --> contentEndpoint: JSON
```

`/internalcontent` | Calls **Content-Public-Read** service to expand lead images and body embedded dynamic content
`/content-preview` | Calls **Content-Public-Read** service to expand main images, alternative images and body embedded images. Calls **Content-Public-Read-Preview** service to expand body embedded dynamic content
`/internalcontent-preview` | Calls **Content-Public-Read** service to expand lead images. Calls **Content-Public-Read-Preview** service to expand body embedded dynamic content
Expand Down Expand Up @@ -408,4 +422,4 @@ Response:
"topper": null,
"uuid": "5010e2e4-09bd-11e7-97d1-5e720a26771b"
}
```
```

0 comments on commit 6c00469

Please sign in to comment.