API docs by Redocly

Story Stream API (v1)

Download OpenAPI specification:Download

E-mail: mahirhasan333@gmail.com License: MIT License

API endpoints for Story Stream API Course

articles

articles_list

Authorizations:
Basic
query Parameters
author
string

author

title
string

title

tags
string

tags

created_at
string

created_at

updated_at
string

updated_at

ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

articles_create

Authorizations:
Basic
Request Body schema: application/json
required
title
required
string (Title) [ 1 .. 255 ] characters
tags
required
string (Tags)
object (Profile)
description
required
string (Description) [ 1 .. 255 ] characters
body
required
string (Article content) non-empty

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "tags": "string",
  • "author_info": {
    },
  • "description": "string",
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "slug": "string",
  • "tags": "string",
  • "estimated_reading_time": "string",
  • "author_info": {
    },
  • "views": "string",
  • "description": "string",
  • "body": "string",
  • "banner_image": "string",
  • "average_rating": "string",
  • "bookmarks_count": "string",
  • "claps_count": "string",
  • "bookmarks": "string",
  • "responses": [
    ],
  • "responses_count": 0,
  • "created_at": "string",
  • "updated_at": "string"
}

articles_clap_create

Authorizations:
Basic
path Parameters
article_id
required
string
Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_first_name": "string",
  • "article_title": "string"
}

articles_clap_delete

Authorizations:
Basic
path Parameters
article_id
required
string

Responses

articles_read

Authorizations:
Basic
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "slug": "string",
  • "tags": "string",
  • "estimated_reading_time": "string",
  • "author_info": {
    },
  • "views": "string",
  • "description": "string",
  • "body": "string",
  • "banner_image": "string",
  • "average_rating": "string",
  • "bookmarks_count": "string",
  • "claps_count": "string",
  • "bookmarks": "string",
  • "responses": [
    ],
  • "responses_count": 0,
  • "created_at": "string",
  • "updated_at": "string"
}

articles_update

Authorizations:
Basic
path Parameters
id
required
string <uuid>
Request Body schema: multipart/form-data
required
title
required
string [ 1 .. 255 ] characters
tags
required
string
description
required
string [ 1 .. 255 ] characters
body
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "slug": "string",
  • "tags": "string",
  • "estimated_reading_time": "string",
  • "author_info": {
    },
  • "views": "string",
  • "description": "string",
  • "body": "string",
  • "banner_image": "string",
  • "average_rating": "string",
  • "bookmarks_count": "string",
  • "claps_count": "string",
  • "bookmarks": "string",
  • "responses": [
    ],
  • "responses_count": 0,
  • "created_at": "string",
  • "updated_at": "string"
}

articles_partial_update

Authorizations:
Basic
path Parameters
id
required
string <uuid>
Request Body schema: multipart/form-data
required
title
required
string [ 1 .. 255 ] characters
tags
required
string
description
required
string [ 1 .. 255 ] characters
body
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "slug": "string",
  • "tags": "string",
  • "estimated_reading_time": "string",
  • "author_info": {
    },
  • "views": "string",
  • "description": "string",
  • "body": "string",
  • "banner_image": "string",
  • "average_rating": "string",
  • "bookmarks_count": "string",
  • "claps_count": "string",
  • "bookmarks": "string",
  • "responses": [
    ],
  • "responses_count": 0,
  • "created_at": "string",
  • "updated_at": "string"
}

articles_delete

Authorizations:
Basic
path Parameters
id
required
string <uuid>

Responses

auth

auth_login_create

Check the credentials and return the REST Token if the credentials are valid and authenticated. Calls Django Auth login method to register User ID in Django session framework

Accept the following POST parameters: username, password Return the REST Framework Token Object's key.

Authorizations:
Basic
Request Body schema: application/json
required
username
string (Username)
email
string <email> (Email)
password
required
string (Password) non-empty

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "email": "user@example.com",
  • "password": "string"
}

Calls Django logout method and delete the Token object assigned to the current User object.

Accepts/Returns nothing.

Authorizations:
Basic

Responses

Calls Django logout method and delete the Token object assigned to the current User object.

Accepts/Returns nothing.

Authorizations:
Basic

Responses

Calls Django Auth SetPasswordForm save method.

Accepts the following POST parameters: new_password1, new_password2 Returns the success/fail message.

Authorizations:
Basic
Request Body schema: application/json
required
new_password1
required
string (New password1) [ 1 .. 128 ] characters
new_password2
required
string (New password2) [ 1 .. 128 ] characters

Responses

Request samples

Content type
application/json
{
  • "new_password1": "string",
  • "new_password2": "string"
}

Response samples

Content type
application/json
{
  • "new_password1": "string",
  • "new_password2": "string"
}

Calls Django Auth PasswordResetForm save method.

Accepts the following POST parameters: email Returns the success/fail message.

Authorizations:
Basic
Request Body schema: application/json
required
email
required
string <email> (Email) non-empty

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "email": "user@example.com"
}

Password reset e-mail link is confirmed, therefore this resets the user's password.

Accepts the following POST parameters: token, uid, new_password1, new_password2 Returns the success/fail message.

Authorizations:
Basic
Request Body schema: application/json
required
new_password1
required
string (New password1) [ 1 .. 128 ] characters
new_password2
required
string (New password2) [ 1 .. 128 ] characters
uid
required
string (Uid) non-empty
token
required
string (Token) non-empty

Responses

Request samples

Content type
application/json
{
  • "new_password1": "string",
  • "new_password2": "string",
  • "uid": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "new_password1": "string",
  • "new_password2": "string",
  • "uid": "string",
  • "token": "string"
}

Password reset e-mail link is confirmed, therefore this resets the user's password.

Accepts the following POST parameters: token, uid, new_password1, new_password2 Returns the success/fail message.

Authorizations:
Basic
path Parameters
uidb64
required
string
token
required
string
Request Body schema: application/json
required
new_password1
required
string (New password1) [ 1 .. 128 ] characters
new_password2
required
string (New password2) [ 1 .. 128 ] characters
uid
required
string (Uid) non-empty
token
required
string (Token) non-empty

Responses

Request samples

Content type
application/json
{
  • "new_password1": "string",
  • "new_password2": "string",
  • "uid": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "new_password1": "string",
  • "new_password2": "string",
  • "uid": "string",
  • "token": "string"
}

auth_registration_create

Authorizations:
Basic
Request Body schema: application/json
required
email
required
string <email> (Email) non-empty
password1
required
string (Password1) non-empty
password2
required
string (Password2) non-empty
first_name
required
string (First name) non-empty
last_name
required
string (Last name) non-empty

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password1": "string",
  • "password2": "string",
  • "first_name": "string",
  • "last_name": "string"
}

Response samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password1": "string",
  • "password2": "string",
  • "first_name": "string",
  • "last_name": "string"
}

auth_registration_resend-email_create

Authorizations:
Basic
Request Body schema: application/json
required
email
required
string <email> (Email) non-empty

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "email": "user@example.com"
}

auth_registration_verify-email_create

Authorizations:
Basic
Request Body schema: application/json
required
key
required
string (Key) non-empty

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "key": "string"
}

auth_token_refresh_create

Authorizations:
Basic
Request Body schema: application/json
required
refresh
string (Refresh) non-empty

WIll override cookie.

Responses

Request samples

Content type
application/json
{
  • "refresh": "string"
}

Response samples

Content type
application/json
{
  • "refresh": "string",
  • "access": "string"
}

auth_token_verify_create

Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.

Authorizations:
Basic
Request Body schema: application/json
required
token
required
string (Token) non-empty

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

auth_user_read

Authorizations:
Basic

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "gender": "string",
  • "phone_number": "string",
  • "profile_photo": "string",
  • "country": "AF",
  • "city": "string"
}

auth_user_update

Authorizations:
Basic
Request Body schema: application/json
required
email
required
string <email> (Email address) [ 1 .. 254 ] characters
first_name
required
string (First name) [ 1 .. 50 ] characters
last_name
required
string (Last name) [ 1 .. 50 ] characters
gender
required
string (Gender) non-empty
phone_number
required
string (Phone number) non-empty
country
required
string (Country)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
city
required
string (City) non-empty

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "gender": "string",
  • "phone_number": "string",
  • "country": "AF",
  • "city": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "gender": "string",
  • "phone_number": "string",
  • "profile_photo": "string",
  • "country": "AF",
  • "city": "string"
}

auth_user_partial_update

Authorizations:
Basic
Request Body schema: application/json
required
email
required
string <email> (Email address) [ 1 .. 254 ] characters
first_name
required
string (First name) [ 1 .. 50 ] characters
last_name
required
string (Last name) [ 1 .. 50 ] characters
gender
required
string (Gender) non-empty
phone_number
required
string (Phone number) non-empty
country
required
string (Country)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
city
required
string (City) non-empty

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "gender": "string",
  • "phone_number": "string",
  • "country": "AF",
  • "city": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "gender": "string",
  • "phone_number": "string",
  • "profile_photo": "string",
  • "country": "AF",
  • "city": "string"
}

bookmarks

bookmarks_bookmark_article_create

Authorizations:
Basic
path Parameters
article_id
required
string
Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_first_name": "string",
  • "article_title": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

bookmarks_remove_bookmark_delete

Authorizations:
Basic
path Parameters
article_id
required
string

Responses

elastic

elastic_search_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{}

profiles

profiles_all_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

profiles_me_read

Authorizations:
Basic

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "first_name": "string",
  • "last_name": "string",
  • "full_name": "string",
  • "email": "user@example.com",
  • "profile_photo": "string",
  • "phone_number": "string",
  • "gender": "M",
  • "country": "Afghanistan",
  • "city": "string",
  • "twitter_handle": "string",
  • "about_me": "string"
}

profiles_me_followers_list

Authorizations:
Basic

Responses

profiles_me_update_read

Authorizations:
Basic

Responses

Response samples

Content type
application/json
{
  • "phone_number": "string",
  • "profile_photo": "http://example.com",
  • "about_me": "string",
  • "gender": "M",
  • "country": "Afghanistan",
  • "city": "string",
  • "twitter_handle": "string"
}

profiles_me_update_partial_update

Authorizations:
Basic
Request Body schema: multipart/form-data
phone_number
string [ 1 .. 30 ] characters
profile_photo
string <binary>
about_me
string non-empty
gender
string
Enum: "M" "F" "O"
country
required
string
Enum: "Afghanistan" "Åland Islands" "Albania" "Algeria" "American Samoa" "Andorra" "Angola" "Anguilla" "Antarctica" "Antigua and Barbuda" "Argentina" "Armenia" "Aruba" "Australia" "Austria" "Azerbaijan" "Bahamas" "Bahrain" "Bangladesh" "Barbados" "Belarus" "Belgium" "Belize" "Benin" "Bermuda" "Bhutan" "Bolivia" "Bonaire, Sint Eustatius and Saba" "Bosnia and Herzegovina" "Botswana" "Bouvet Island" "Brazil" "British Indian Ocean Territory" "Brunei" "Bulgaria" "Burkina Faso" "Burundi" "Cabo Verde" "Cambodia" "Cameroon" "Canada" "Cayman Islands" "Central African Republic" "Chad" "Chile" "China" "Christmas Island" "Cocos (Keeling) Islands" "Colombia" "Comoros" "Congo" "Congo (the Democratic Republic of the)" "Cook Islands" "Costa Rica" "Côte d'Ivoire" "Croatia" "Cuba" "Curaçao" "Cyprus" "Czechia" "Denmark" "Djibouti" "Dominica" "Dominican Republic" "Ecuador" "Egypt" "El Salvador" "Equatorial Guinea" "Eritrea" "Estonia" "Eswatini" "Ethiopia" "Falkland Islands (Malvinas)" "Faroe Islands" "Fiji" "Finland" "France" "French Guiana" "French Polynesia" "French Southern Territories" "Gabon" "Gambia" "Georgia" "Germany" "Ghana" "Gibraltar" "Greece" "Greenland" "Grenada" "Guadeloupe" "Guam" "Guatemala" "Guernsey" "Guinea" "Guinea-Bissau" "Guyana" "Haiti" "Heard Island and McDonald Islands" "Holy See" "Honduras" "Hong Kong" "Hungary" "Iceland" "India" "Indonesia" "Iran" "Iraq" "Ireland" "Isle of Man" "Israel" "Italy" "Jamaica" "Japan" "Jersey" "Jordan" "Kazakhstan" "Kenya" "Kiribati" "Kuwait" "Kyrgyzstan" "Laos" "Latvia" "Lebanon" "Lesotho" "Liberia" "Libya" "Liechtenstein" "Lithuania" "Luxembourg" "Macao" "Madagascar" "Malawi" "Malaysia" "Maldives" "Mali" "Malta" "Marshall Islands" "Martinique" "Mauritania" "Mauritius" "Mayotte" "Mexico" "Micronesia" "Moldova" "Monaco" "Mongolia" "Montenegro" "Montserrat" "Morocco" "Mozambique" "Myanmar" "Namibia" "Nauru" "Nepal" "Netherlands" "New Caledonia" "New Zealand" "Nicaragua" "Niger" "Nigeria" "Niue" "Norfolk Island" "North Korea" "North Macedonia" "Northern Mariana Islands" "Norway" "Oman" "Pakistan" "Palau" "Palestine, State of" "Panama" "Papua New Guinea" "Paraguay" "Peru" "Philippines" "Pitcairn" "Poland" "Portugal" "Puerto Rico" "Qatar" "Réunion" "Romania" "Russia" "Rwanda" "Saint Barthélemy" "Saint Helena, Ascension and Tristan da Cunha" "Saint Kitts and Nevis" "Saint Lucia" "Saint Martin (French part)" "Saint Pierre and Miquelon" "Saint Vincent and the Grenadines" "Samoa" "San Marino" "Sao Tome and Principe" "Saudi Arabia" "Senegal" "Serbia" "Seychelles" "Sierra Leone" "Singapore" "Sint Maarten (Dutch part)" "Slovakia" "Slovenia" "Solomon Islands" "Somalia" "South Africa" "South Georgia and the South Sandwich Islands" "South Korea" "South Sudan" "Spain" "Sri Lanka" "Sudan" "Suriname" "Svalbard and Jan Mayen" "Sweden" "Switzerland" "Syria" "Taiwan" "Tajikistan" "Tanzania" "Thailand" "Timor-Leste" "Togo" "Tokelau" "Tonga" "Trinidad and Tobago" "Tunisia" "Türkiye" "Turkmenistan" "Turks and Caicos Islands" "Tuvalu" "Uganda" "Ukraine" "United Arab Emirates" "United Kingdom" "United States Minor Outlying Islands" "United States of America" "Uruguay" "Uzbekistan" "Vanuatu" "Venezuela" "Vietnam" "Virgin Islands (British)" "Virgin Islands (U.S.)" "Wallis and Futuna" "Western Sahara" "Yemen" "Zambia" "Zimbabwe"
city
string [ 1 .. 180 ] characters
twitter_handle
string <= 20 characters

Responses

Response samples

Content type
application/json
{
  • "phone_number": "string",
  • "profile_photo": "http://example.com",
  • "about_me": "string",
  • "gender": "M",
  • "country": "Afghanistan",
  • "city": "string",
  • "twitter_handle": "string"
}

profiles_follow_create

Authorizations:
Basic
path Parameters
user_id
required
string

Responses

profiles_unfollow_create

Authorizations:
Basic
path Parameters
user_id
required
string

Responses

ratings

ratings_rate_article_create

Authorizations:
Basic
path Parameters
article_id
required
string
Request Body schema: application/json
required
rating
required
integer (Rating)
Enum: 1 2 3 4 5
review
string (Review)

Responses

Request samples

Content type
application/json
{
  • "rating": 1,
  • "review": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "article_title": "string",
  • "user_first_name": "string",
  • "rating": 1,
  • "review": "string"
}

responses

responses_article_read

Authorizations:
Basic
path Parameters
article_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

responses_article_create

Authorizations:
Basic
path Parameters
article_id
required
string
Request Body schema: application/json
required
parent_response
integer or null (Parent response)
content
required
string (Response content) non-empty

Responses

Request samples

Content type
application/json
{
  • "parent_response": 0,
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_first_name": "string",
  • "article_title": "string",
  • "parent_response": 0,
  • "content": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

responses_read

Authorizations:
Basic
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_first_name": "string",
  • "article_title": "string",
  • "parent_response": 0,
  • "content": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

responses_update

Authorizations:
Basic
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
parent_response
integer or null (Parent response)
content
required
string (Response content) non-empty

Responses

Request samples

Content type
application/json
{
  • "parent_response": 0,
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_first_name": "string",
  • "article_title": "string",
  • "parent_response": 0,
  • "content": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

responses_partial_update

Authorizations:
Basic
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
parent_response
integer or null (Parent response)
content
required
string (Response content) non-empty

Responses

Request samples

Content type
application/json
{
  • "parent_response": 0,
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_first_name": "string",
  • "article_title": "string",
  • "parent_response": 0,
  • "content": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

responses_delete

Authorizations:
Basic
path Parameters
id
required
string <uuid>

Responses