Publish a changelog entry

Admin only. Writes one published changelog entry and records the caller as its author. Only the title is required, and the entry is published at once for the next release screen.

POST/api/v1/changelog

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Request body

requiredapplication/json

titlestringrequired

versionstring

categorystring

bodystring

Responses

201

Changelog entry published

idstringrequired

versionstringrequired

categorystringrequired

titlestringrequired

bodystringrequired

publishedintegerrequired

min -9007199254740991 · max 9007199254740991

published_atstringrequired

created_bystringrequired

created_atstringrequired

400

title is required

detailstringrequired

401

Not authenticated

detailstringrequired

403

Caller is not an admin

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

titlestring*versionstringcategorystringbodystring

Request

curl -X POST 'http://localhost:8000/api/v1/changelog' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string",
  "version": "string",
  "category": "string",
  "body": "string"
}'

const response = await fetch("http://localhost:8000/api/v1/changelog", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"title\": \"string\",\n  \"version\": \"string\",\n  \"category\": \"string\",\n  \"body\": \"string\"\n}"
});

import requests

response = requests.post(
    "http://localhost:8000/api/v1/changelog",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"title\": \"string\",\n  \"version\": \"string\",\n  \"category\": \"string\",\n  \"body\": \"string\"\n}",
)

Response

{
  "id": "string",
  "version": "string",
  "category": "string",
  "title": "string",
  "body": "string",
  "published": -9007199254740991,
  "published_at": "string",
  "created_by": "string",
  "created_at": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}