Skip to content

Commit

Permalink
feat: readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
noahdurbin committed Aug 30, 2024
1 parent 63fe6e7 commit fcf5249
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -431,3 +431,22 @@ This is the backend API repository for TurLink. TurLink is a link shortener app
]
}
```
### Get Summary for a Link
- **GET** `/api/v1/summary?link={original link}`
- Description: Retrieves a summary of the content at the given link.
- Example Request: GET `https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/summary?link=www.example.com`
- Successful Response (200 OK):
```json
{
"data": {
"attributes": {
"link": "www.example.com",
"summary": "1. example 1\n2. example 2\n3. example 3"
}
}
}
```
- Notes:
- This endpoint currently returns mock data.
- In the future, it will provide an actual summary of the content at the given link.
- The summary is expected to be a string with numbered points, separated by newline characters.
Binary file modified dump.rdb
Binary file not shown.

0 comments on commit fcf5249

Please sign in to comment.