goosePRESS API (v1)

Download OpenAPI specification:Download

API for goosePRESS

Authentication

Basic

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

article_content

article_content_read

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this article.

Responses

Response samples

200

Content type

application/json

{"content_raw": "string"
}

article_content_update

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this article.

Request Body schema: application/json

content_raw

string (Content raw)

Responses

Request samples

Payload

Content type

application/json

{"content_raw": "string"
}

Response samples

200

Content type

application/json

{"content_raw": "string"
}

article_content_partial_update

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this article.

Request Body schema: application/json

content_raw

string (Content raw)

Responses

Request samples

Payload

Content type

application/json

{"content_raw": "string"
}

Response samples

200

Content type

application/json

{"content_raw": "string"
}

article_html

article_html_read

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this article.

Responses

Response samples

200

Content type

application/json

{"content_raw": "string"
}

articles

articles_list

Authorizations:

Basic

query Parameters

page	integer A page number within the paginated result set.

Responses

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"title": "",
"slug": "string",
"sub_title": "",
"author": "string",
"article_type": "slate",
"is_article_of_issue": true,
"is_promo": true,
"issue": 0,
"user": 0
}
]
}

articles_create

Authorizations:

Basic

Request Body schema: application/json

title	string (Title) non-empty Default: ""
sub_title	string (Sub title) Default: ""
author	string (Author) <= 255 characters
article_type	string (Article type) non-empty Default: "slate"
issue	integer (Issue)

Responses

Request samples

Payload

Content type

application/json

{"title": "",
"sub_title": "",
"author": "string",
"article_type": "slate",
"issue": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"title": "",
"slug": "string",
"sub_title": "",
"author": "string",
"article_type": "slate",
"is_article_of_issue": true,
"is_promo": true,
"issue": 0,
"user": 0
}

articles_read

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this article.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"title": "",
"slug": "string",
"sub_title": "",
"author": "string",
"article_type": "slate",
"is_article_of_issue": true,
"is_promo": true,
"issue": 0,
"user": 0
}

articles_update

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this article.

Request Body schema: application/json

title	string (Title) non-empty Default: ""
sub_title	string (Sub title) Default: ""
author	string (Author) <= 255 characters
article_type	string (Article type) non-empty Default: "slate"
issue	integer (Issue)

Responses

Request samples

Payload

Content type

application/json

{"title": "",
"sub_title": "",
"author": "string",
"article_type": "slate",
"issue": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"title": "",
"slug": "string",
"sub_title": "",
"author": "string",
"article_type": "slate",
"is_article_of_issue": true,
"is_promo": true,
"issue": 0,
"user": 0
}

articles_partial_update

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this article.

Request Body schema: application/json

title	string (Title) non-empty Default: ""
sub_title	string (Sub title) Default: ""
author	string (Author) <= 255 characters
article_type	string (Article type) non-empty Default: "slate"
issue	integer (Issue)

Responses

Request samples

Payload

Content type

application/json

{"title": "",
"sub_title": "",
"author": "string",
"article_type": "slate",
"issue": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"title": "",
"slug": "string",
"sub_title": "",
"author": "string",
"article_type": "slate",
"is_article_of_issue": true,
"is_promo": true,
"issue": 0,
"user": 0
}

articles_delete

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this article.

Responses

issues

issues_list

Authorizations:

Basic

query Parameters

page	integer A page number within the paginated result set.

Responses

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"publish_date": "2019-08-24",
"volume_num": 0,
"issue_code": "s",
"pdf": "http://example.com",
"title": "string",
"description": "string",
"colour": "blastoff-blue"
}
]
}

issues_create

Authorizations:

Basic

Request Body schema: application/json

volume_num required	integer (Volume num)
issue_code required	string (Issue code) 1 characters
title	string (Title) <= 255 characters
description	string (Description)
colour	string (Colour) Enum: "blastoff-blue" "celestial-blue" "cosmic-orange" "fireball-fuchsia" "galaxy-gold" "gamma-green" "gravity-grape" "liftoff-lemon" "lunar-blue" "martian-green" "orbit-orange" "outrageous-orchid" "planetary-purple" "pulsar-pink" "reentry-red" "rocket-red" "sunburst-yellow" "terra-green" "terrestrial-teal" "venus-violet" "pastel-blue" "pastel-buff" "pastel-canary" "pastel-goldenrod" "pastel-grey" "pastel-green" "pastel-orchid" "pastel-pink" "pastel-salmon" "paper"

Responses

Request samples

Payload

Content type

application/json

{"volume_num": 0,
"issue_code": "s",
"title": "string",
"description": "string",
"colour": "blastoff-blue"
}

Response samples

201

Content type

application/json

{"id": 0,
"publish_date": "2019-08-24",
"volume_num": 0,
"issue_code": "s",
"pdf": "http://example.com",
"title": "string",
"description": "string",
"colour": "blastoff-blue"
}

issues_latest

Authorizations:

Basic

query Parameters

page	integer A page number within the paginated result set.

Responses

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"publish_date": "2019-08-24",
"volume_num": 0,
"issue_code": "s",
"pdf": "http://example.com",
"title": "string",
"description": "string",
"colour": "blastoff-blue"
}
]
}

issues_read

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this issue.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"publish_date": "2019-08-24",
"volume_num": 0,
"issue_code": "s",
"pdf": "http://example.com",
"title": "string",
"description": "string",
"colour": "blastoff-blue"
}

issues_update

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this issue.

Request Body schema: application/json

volume_num required	integer (Volume num)
issue_code required	string (Issue code) 1 characters
title	string (Title) <= 255 characters
description	string (Description)
colour	string (Colour) Enum: "blastoff-blue" "celestial-blue" "cosmic-orange" "fireball-fuchsia" "galaxy-gold" "gamma-green" "gravity-grape" "liftoff-lemon" "lunar-blue" "martian-green" "orbit-orange" "outrageous-orchid" "planetary-purple" "pulsar-pink" "reentry-red" "rocket-red" "sunburst-yellow" "terra-green" "terrestrial-teal" "venus-violet" "pastel-blue" "pastel-buff" "pastel-canary" "pastel-goldenrod" "pastel-grey" "pastel-green" "pastel-orchid" "pastel-pink" "pastel-salmon" "paper"

Responses

Request samples

Payload

Content type

application/json

{"volume_num": 0,
"issue_code": "s",
"title": "string",
"description": "string",
"colour": "blastoff-blue"
}

Response samples

200

Content type

application/json

{"id": 0,
"publish_date": "2019-08-24",
"volume_num": 0,
"issue_code": "s",
"pdf": "http://example.com",
"title": "string",
"description": "string",
"colour": "blastoff-blue"
}

issues_partial_update

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this issue.

Request Body schema: application/json

volume_num required	integer (Volume num)
issue_code required	string (Issue code) 1 characters
title	string (Title) <= 255 characters
description	string (Description)
colour	string (Colour) Enum: "blastoff-blue" "celestial-blue" "cosmic-orange" "fireball-fuchsia" "galaxy-gold" "gamma-green" "gravity-grape" "liftoff-lemon" "lunar-blue" "martian-green" "orbit-orange" "outrageous-orchid" "planetary-purple" "pulsar-pink" "reentry-red" "rocket-red" "sunburst-yellow" "terra-green" "terrestrial-teal" "venus-violet" "pastel-blue" "pastel-buff" "pastel-canary" "pastel-goldenrod" "pastel-grey" "pastel-green" "pastel-orchid" "pastel-pink" "pastel-salmon" "paper"

Responses

Request samples

Payload

Content type

application/json

{"volume_num": 0,
"issue_code": "s",
"title": "string",
"description": "string",
"colour": "blastoff-blue"
}

Response samples

200

Content type

application/json

{"id": 0,
"publish_date": "2019-08-24",
"volume_num": 0,
"issue_code": "s",
"pdf": "http://example.com",
"title": "string",
"description": "string",
"colour": "blastoff-blue"
}

issues_delete

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this issue.

Responses

issues_articles

This method returns the articles associated with an issue. If the issue is not yet published and the requesting user is not signed in, then an error is raised.

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this issue.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"publish_date": "2019-08-24",
"volume_num": 0,
"issue_code": "s",
"pdf": "http://example.com",
"title": "string",
"description": "string",
"colour": "blastoff-blue"
}

login

login_create

Authorizations:

Basic

Responses

logout

logout_create

Authorizations:

Basic

Responses

me

me_list

Authorizations:

Basic

Responses

me_partial_update

Authorizations:

Basic

Responses

published_issues

published_issues_list

Authorizations:

Basic

query Parameters

page	integer A page number within the paginated result set.

Responses

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"publish_date": "2019-08-24",
"volume_num": 0,
"issue_code": "s",
"pdf": "http://example.com",
"title": "string",
"description": "string",
"colour": "blastoff-blue"
}
]
}

published_issues_latest

Authorizations:

Basic

query Parameters

page	integer A page number within the paginated result set.

Responses

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"publish_date": "2019-08-24",
"volume_num": 0,
"issue_code": "s",
"pdf": "http://example.com",
"title": "string",
"description": "string",
"colour": "blastoff-blue"
}
]
}

published_issues_read

Authorizations:

Basic

path Parameters

id

required

integer

A unique integer value identifying this issue.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"publish_date": "2019-08-24",
"volume_num": 0,
"issue_code": "s",
"pdf": "http://example.com",
"title": "string",
"description": "string",
"colour": "blastoff-blue"
}

reset_password

reset_password_list

Authorizations:

Basic

Responses

reset_password_create

Authorizations:

Basic

Responses

user_articles

user_articles_list

Authorizations:

Basic

query Parameters

page	integer A page number within the paginated result set.

Responses

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"title": "",
"slug": "string",
"sub_title": "",
"author": "string",
"article_type": "slate",
"is_article_of_issue": true,
"is_promo": true,
"issue": 0,
"user": 0
}
]
}

user_articles_read

Authorizations:

Basic

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": 0,
"title": "",
"slug": "string",
"sub_title": "",
"author": "string",
"article_type": "slate",
"is_article_of_issue": true,
"is_promo": true,
"issue": 0,
"user": 0
}

users

users_list

Authorizations:

Basic

query Parameters

page	integer A page number within the paginated result set.

Responses

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"username": "string",
"password": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_staff": true,
"role": "Contributor",
"writer_name": "string"
}
]
}

users_create

Authorizations:

Basic

Request Body schema: application/json

username required	string (Username) [ 1 .. 150 ] characters ^[\w.@+-]+$ Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
password required	string (Password) [ 1 .. 128 ] characters
first_name	string (First name) <= 30 characters
last_name	string (Last name) <= 150 characters
email required	string <email> (Email) [ 1 .. 254 ] characters
role	string (Role) non-empty Default: "Contributor"
writer_name required	string (Writer name) [ 1 .. 255 ] characters

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"role": "Contributor",
"writer_name": "string"
}

Response samples

201

Content type

application/json

{"username": "string",
"password": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_staff": true,
"role": "Contributor",
"writer_name": "string"
}

users_read

Authorizations:

Basic

path Parameters

username

required

string^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Responses

Response samples

200

Content type

application/json

{"username": "string",
"password": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_staff": true,
"role": "Contributor",
"writer_name": "string"
}

users_update

Authorizations:

Basic

path Parameters

username

required

string^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Request Body schema: application/json

username required	string (Username) [ 1 .. 150 ] characters ^[\w.@+-]+$ Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
password required	string (Password) [ 1 .. 128 ] characters
first_name	string (First name) <= 30 characters
last_name	string (Last name) <= 150 characters
email required	string <email> (Email) [ 1 .. 254 ] characters
role	string (Role) non-empty Default: "Contributor"
writer_name required	string (Writer name) [ 1 .. 255 ] characters

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"role": "Contributor",
"writer_name": "string"
}

Response samples

200

Content type

application/json

{"username": "string",
"password": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_staff": true,
"role": "Contributor",
"writer_name": "string"
}

users_partial_update

Authorizations:

Basic

path Parameters

username

required

string^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Request Body schema: application/json

username required	string (Username) [ 1 .. 150 ] characters ^[\w.@+-]+$ Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
password required	string (Password) [ 1 .. 128 ] characters
first_name	string (First name) <= 30 characters
last_name	string (Last name) <= 150 characters
email required	string <email> (Email) [ 1 .. 254 ] characters
role	string (Role) non-empty Default: "Contributor"
writer_name required	string (Writer name) [ 1 .. 255 ] characters

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"role": "Contributor",
"writer_name": "string"
}

Response samples

200

Content type

application/json

{"username": "string",
"password": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_staff": true,
"role": "Contributor",
"writer_name": "string"
}

users_delete

Authorizations:

Basic

path Parameters

username

required

string^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Responses

users_query

Authorizations:

Basic

path Parameters

username

required

string^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Responses

Response samples

200

Content type

application/json

{"username": "string",
"password": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_staff": true,
"role": "Contributor",
"writer_name": "string"
}

users_reset_password

Authorizations:

Basic

path Parameters

username

required

string^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Request Body schema: application/json

username required	string (Username) [ 1 .. 150 ] characters ^[\w.@+-]+$ Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
password required	string (Password) [ 1 .. 128 ] characters
first_name	string (First name) <= 30 characters
last_name	string (Last name) <= 150 characters
email required	string <email> (Email) [ 1 .. 254 ] characters
role	string (Role) non-empty Default: "Contributor"
writer_name required	string (Writer name) [ 1 .. 255 ] characters

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"role": "Contributor",
"writer_name": "string"
}

Response samples

201

Content type

application/json

{"username": "string",
"password": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_staff": true,
"role": "Contributor",
"writer_name": "string"
}