BlogPost.md

📰 Blog post resource

These posts are created by BOP members in the blog. They can be articles, tutorials and tips on various subjects such as informatic, development, etc...

Blog post object

Field	Type	Description	Can be null ?
url	string	post's URL
title	string	post's title
timestamp	integer	unix timestamp, post creation
author	user object	informations about post's author
type	string	post's type (article / tutorial / flash)
category	string	post's category
description	string	a summary of post's content
labels	list of strings	labels for SEO
banner	string	post's banner
locale	string	post's locale
content	string	post's content, markdown format	✅ (if inclued in a many-posts request)

Get all posts

GET /blog-posts

Get all the posts. Returns a list of blog post objects without the content.

Optional URL parameters

Name	Type	Description
category	string	post's category
type	string	post's type (article / tutorial / flash)
author	string	post's author (their identifier)
search	string	search for articles (text inside title or description)

This endpoint uses pagination.

Get last post

GET /blog-posts/last

Get the last published post. Returns a blog post object.

Get random post

GET /blog-posts/random

Get a random post among all our collection. Returns a blog post object.

Create post

POST /blog-posts

Write a new post and publish it. Requires auth and BLOG_WRITE permission.

Required data

Field	Type	Description
title	string	post's title
type	string	post's category
category	string	post's category
description	string	a summary of post's content
labels	list of strings	labels for SEO
banner	string	post's banner
content	string	post's content, markdown format

Optional data

Field	Type	Description	Default value
locale	string	post's locale	fr

Get one post

GET /blog-posts/{post.url}

Get one post by its URL. Returns a full blog post object.

Edit post

PATCH /blog-posts/{post-url}

Edit a post. Requires auth and BLOG_WRITE permission.

Editable fields : title, type, category, description, labels, banner, content.

Delete post

DELETE /blog-posts/{post-url}

Delete a post. Requires auth and BLOW_WRITE permission.