Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Split data column, add page parameter to get_entry, reformat #2

Merged
merged 1 commit into from
Mar 17, 2020
Merged

Split data column, add page parameter to get_entry, reformat #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 29 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,82 +45,95 @@ $ denotes a variable.
<tr>
<th>Endpoint</th>
<th>Purpose</th>
<th>Data</th>
<th>Headers</th>
<th>Method</th>
<th>Parameters/Data</th>
</tr>
</thead>
<tbody>
<tr>
<td>/token</td>
<td>Returns bearer token. This end point uses content-type: application/x-www-form-urlencoded.</td>
<td>{'grant_type': 'password', 'username': 'INSERT_USERNAME', 'password': 'INSERT_PW', 'client_secret': 'INSERT_CS_HERE'}</td>
<td>Returns bearer token.</td>
<td>content-type: application/x-www-form-urlencoded</td>
<td>GET/POST</td>
<td>{'grant_type': 'password', 'username': 'INSERT_USERNAME', 'password': 'INSERT_PW', 'client_secret': 'INSERT_CS_HERE'}</td>
</tr>
<tr>
<td>/v1/topic/$topic-id</td>
<td>Returns a page of topic.</td>
<td>(optional) add accept-encoding: gzip to headers.</td>
<td>(optional) accept-encoding: gzip</td>
<td>GET</td>
<td>p=$page_number</td>
</tr>
<tr>
<td>/v1/entry/$entry-id</td>
<td>Returns an entry.</td>
<td>(optional) add accept-encoding: gzip to headers.</td>
<td>(optional) accept-encoding: gzip</td>
<td>GET</td>
<td></td>
</tr>
<tr>
<td>/v1/index/popular</td>
<td>Returns a page of popular/gündem topics.</td>
<td>(optional) add accept-encoding: gzip to headers.</td>
<td>(optional) accept-encoding: gzip</td>
<td>GET</td>
<td></td>
</tr>
<tr>
<td>/v1/index/feed/entry</td>
<td>Returns entries of people you follow.</td>
<td>(optional) add accept-encoding: gzip to headers.</td>
<td>(optional) accept-encoding: gzip</td>
<td>GET</td>
<td></td>
</tr>
<tr>
<td>/v1/index/feed/favorites</td>
<td>Returns favorites of people you follow.</td>
<td>(optional) add accept-encoding: gzip to headers.</td>
<td>(optional) accept-encoding: gzip</td>
<td>GET</td>
<td></td>
</tr>
<tr>
<td>/v1/index/caylak</td>
<td>Returns çaylak topics.</td>
<td>(optional) add accept-encoding: gzip to headers.</td>
<td>(optional) accept-encoding: gzip</td>
<td>GET</td>
<td></td>
</tr>
<tr>
<td>/v1/index/todayinpast/$year</td>
<td>Returns todayinpast/tarihte bugün topics from $year (e.g. /v1/index/todayinpast/1999).</td>
<td>(optional) add accept-encoding: gzip to headers.</td>
<td>(optional) accept-encoding: gzip</td>
<td>GET</td>
<td></td>
</tr>
<tr>
<td>/v1/index/olay</td>
<td>Returns olan biten.</td>
<td>(optional) add accept-encoding: gzip to headers.</td>
<td>Returns 'olan biten'.</td>
<td>(optional) accept-encoding: gzip</td>
<td>GET</td>
<td></td>
</tr>
<tr>
<td>/v1/message/send</td>
<td>Posts a message.This end point uses content-type: application/x-www-form-urlencoded. </td>
<td>{'To': RECIPIENT, 'Message': MESSAGE}</td>
<td>Posts message to a user.</td>
<td>content-type: application/x-www-form-urlencoded</td>
<td>POST</td>
<td>{'To': RECIPIENT, 'Message': MESSAGE}</td>
</tr>
<tr>
<td>/v1/message</td>
<td>Returns messages.</td>
<td>(optional) add accept-encoding: gzip to headers.</td>
<td>(optional) accept-encoding: gzip</td>
<td>GET</td>
<td></td>
</tr>
<tr>
<td>/v1/user/$username</td>
<td>Returns $username's profile (e.g. /v1/user/ssg).</td>
<td>(optional) add accept-encoding: gzip to headers.</td>
<td>(optional) accept-encoding: gzip</td>
<td>GET</td>
<td></td>
</tr>
</tbody>
</table>
Expand Down