githubModifier

posts

Posts related operations

List all posts

get
Paramètres de requête
pageintegerOptionnel

The page to display

page_sizeintegerOptionnel

The page size

sortstring · enumOptionnel

The field (and direction) on which sorting apply

Valeurs possibles:
qstringOptionnel
kindstring · enumOptionnelValeurs possibles:
with_draftsbooleanOptionnel

True also returns the unpublished posts (only for super-admins)

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
chevron-right
200

Success

application/json
next_pagestringOptionnel

The next page URL if exists

pageinteger · min: 1Requis

The current page

page_sizeintegerRequis

The page size used for pagination

previous_pagestringOptionnel

The previous page URL if exists

totalintegerRequis

The total paginated items

get
/posts/
200

Success

Create a post

post
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
body_typestring · enumOptionnelExample: markdownValeurs possibles:
contentstring · markdownOptionnel
content_as_pagestringOptionnel

Reference to a Page when body_type is 'blocs'

credit_tostringOptionnel

An optional credit line (associated to the image)

credit_urlstringOptionnel

An optional link associated to the credits

datasetsstring[]Optionnel

The post datasets

headlinestringOptionnel
image_urlstringOptionnel
kindstring · enumOptionnel

Post kind (news or page)

Example: newsValeurs possibles:
namestring · max: 255Requis
reusesstring[]Optionnel

The post reuses

tagsstring[]Optionnel

Some keywords to help in search

Réponses
chevron-right
200

Success

application/json
body_typestring · enumOptionnelExample: markdownValeurs possibles:
contentstring · markdownOptionnel
created_atstring · date-timeLecture seuleRequis
credit_tostringOptionnel

An optional credit line (associated to the image)

credit_urlstringOptionnel

An optional link associated to the credits

headlinestringOptionnel
idstringLecture seuleRequis
imagestringLecture seuleOptionnel

URL of the image

image_thumbnailstringLecture seuleOptionnel

URL of the cropped and squared image (100x100)

image_urlstringOptionnel
kindstring · enumOptionnel

Post kind (news or page)

Example: newsValeurs possibles:
last_modifiedstring · date-timeLecture seuleRequis
namestring · max: 255Requis
pagestringLecture seuleOptionnel

The post web page URL

publishedstring · date-timeLecture seuleOptionnel

The post publication date

slugstring · max: 255Lecture seuleRequis
tagsstring[]Optionnel

Some keywords to help in search

uristringLecture seuleOptionnel

The API URI for this post

post
/posts/

Get a given post

get
Paramètres de chemin
poststringRequis

The post ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
chevron-right
200

Success

application/json
body_typestring · enumOptionnelExample: markdownValeurs possibles:
contentstring · markdownOptionnel
created_atstring · date-timeLecture seuleRequis
credit_tostringOptionnel

An optional credit line (associated to the image)

credit_urlstringOptionnel

An optional link associated to the credits

headlinestringOptionnel
idstringLecture seuleRequis
imagestringLecture seuleOptionnel

URL of the image

image_thumbnailstringLecture seuleOptionnel

URL of the cropped and squared image (100x100)

image_urlstringOptionnel
kindstring · enumOptionnel

Post kind (news or page)

Example: newsValeurs possibles:
last_modifiedstring · date-timeLecture seuleRequis
namestring · max: 255Requis
pagestringLecture seuleOptionnel

The post web page URL

publishedstring · date-timeLecture seuleOptionnel

The post publication date

slugstring · max: 255Lecture seuleRequis
tagsstring[]Optionnel

Some keywords to help in search

uristringLecture seuleOptionnel

The API URI for this post

get
/posts/{post}/

Update a given post

put
Paramètres de chemin
poststringRequis

The post ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
body_typestring · enumOptionnelExample: markdownValeurs possibles:
contentstring · markdownOptionnel
content_as_pagestringOptionnel

Reference to a Page when body_type is 'blocs'

credit_tostringOptionnel

An optional credit line (associated to the image)

credit_urlstringOptionnel

An optional link associated to the credits

datasetsstring[]Optionnel

The post datasets

headlinestringOptionnel
image_urlstringOptionnel
kindstring · enumOptionnel

Post kind (news or page)

Example: newsValeurs possibles:
namestring · max: 255Requis
reusesstring[]Optionnel

The post reuses

tagsstring[]Optionnel

Some keywords to help in search

Réponses
chevron-right
200

Success

application/json
body_typestring · enumOptionnelExample: markdownValeurs possibles:
contentstring · markdownOptionnel
created_atstring · date-timeLecture seuleRequis
credit_tostringOptionnel

An optional credit line (associated to the image)

credit_urlstringOptionnel

An optional link associated to the credits

headlinestringOptionnel
idstringLecture seuleRequis
imagestringLecture seuleOptionnel

URL of the image

image_thumbnailstringLecture seuleOptionnel

URL of the cropped and squared image (100x100)

image_urlstringOptionnel
kindstring · enumOptionnel

Post kind (news or page)

Example: newsValeurs possibles:
last_modifiedstring · date-timeLecture seuleRequis
namestring · max: 255Requis
pagestringLecture seuleOptionnel

The post web page URL

publishedstring · date-timeLecture seuleOptionnel

The post publication date

slugstring · max: 255Lecture seuleRequis
tagsstring[]Optionnel

Some keywords to help in search

uristringLecture seuleOptionnel

The API URI for this post

put
/posts/{post}/

Delete a given post

delete
Paramètres de chemin
poststringRequis

The post ID or slug

Réponses
delete
/posts/{post}/

Aucun contenu

Mis à jour

Ce contenu vous a-t-il été utile ?