Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
UKnowWhoIm committed Jan 19, 2021
1 parent be4e445 commit d1dc43f
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,19 @@ An Open API containing all information regarding student licenses for popular pr
| /category/ | GET | [Get all categories](#get-all-categories) |
| /category/<PK> | GET | [Fetch Category by PK](#fetch-category-by-pk) |

### Benefit Data

| Arguments | Type | Details |
| ----- | ----- | ----- |
| id | Integer | Primary Key |
| title | String | Title of the benefit |
| description | String | A small description of the benefit |
| link | String | Link to the website of the benefit |
| category | Integer | The category of the benefit |
| img_link | String | The link to the image of the benefit |
| highlights | JSON String | JSON List of Strings containing important features of the benefit |


### Get All Benefits

Get all the verified benefits stored in this API.<br/>
Expand Down

0 comments on commit d1dc43f

Please sign in to comment.