kevinharvey/redthat-api-final

Redthat, a place to share stuff you read

The Redthat API

The API provides the following endpoints:

Get a Single Submission

GET /submissions/1/

Response

200 OK

{
  'url': 'https://api.redthat.com/submissions/1/',
  'title': 'List of HTTP Status Codes',
  'external_link': 'https://en.wikipedia.org/wiki/List_of_HTTP_status_codes',
  'upvotes': 0,
  'downvotes': 0
}

---

List All Submissions

GET /submissions/

A paginated list of all submissions in the database

Response

200 OK

{
  'count': 1,
  'next': null, # the URL for the next page of results
  'previous': null, # the URL for the previous page of results
  'results': [
    {
      'url': 'https://api.redthat.com/sumbmissions/1/',
      'title': 'List of HTTP Status Code',
      'external_link': 'https://en.wikipedia.org/wiki/List_of_HTTP_status_codes',
      'upvotes': 0,
      'downvotes': 0
    },
    ...
  ]
}

---

Create a New Submission

POST /submissions/
Authorization: Token <token>

{
  'external_link': 'http://www.django-rest-framework.org/api-guide/serializers'
}

Response

201 Created

{
  'url': 'https://api.redthat.com/submissions/2/',
  'title': 'Serializers - Django REST Framework',
  'external_link': 'http://www.django-rest-framework.org/api-guide/serializers',
  'upvotes': 0,
  'downvotes': 0
}

---

Get a Token

POST /get-token/

{
  'email': 'username@example.com'
}

Response

201 Created (or 200 OK if it already existed)

{
  'token': 'abc123',
}

---

Upvote an Existing Submission

POST /submission/1/upvote/
Authorization: Token <token>

Response

201 Created

{
  'url': 'https://api.redthat.com/submissions/1/',
  'title': 'List of HTTP Status Codes from Wikipedia', # updated
  'external_link': 'https://en.wikipedia.org/wiki/List_of_HTTP_status_codes',
  'upvotes': 1, # incremented
  'downvotes': 0
}

---

Downvote an Existing Submission

POST /submission/1/downvote/
Authorization: Token <token>

Response

201 Created

{
  'url': 'https://api.redthat.com/submissions/1/',
  'title': 'List of HTTP Status Codes from Wikipedia', # updated
  'external_link': 'https://en.wikipedia.org/wiki/List_of_HTTP_status_codes',
  'upvotes': 0,
  'downvotes': 1 # incremented
}