Create a changelog entry (publishing needs changelog.publish)

:::openapi-operation POST /api/v1/workspaces/{workspace}/changelog AUTH bearerAuth :::

Creates a draft entry, or a published entry when status is published. A future published_at schedules the entry. When the org reviews changes from agent keys, a published entry answers 202 with the proposal that holds it. Tags take the canonical tags or an alias. Use new, improved, fixed, deprecated or security. added, feature and features also mean new. changed, improvement and improvements also mean improved. fix, fixes and bugfix also mean fixed. removed and deprecation also mean deprecated.

:::codesamples open Code examples

curl -X POST "https://contextowl.co/api/v1/workspaces/string/changelog" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data '{
  "markdown": "string",
  "note": "string",
  "published_at": "string",
  "status": "string",
  "tags": [
    "string"
  ],
  "title": "string"
}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
  public static void main(String[] args) throws Exception {
    var client = HttpClient.newHttpClient();
    var request = HttpRequest.newBuilder()
        .uri(URI.create("https://contextowl.co/api/v1/workspaces/string/changelog"))
        .header("Accept", "application/json")
        .header("Authorization", "Bearer <token>")
        .header("Content-Type", "application/json")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"markdown\": \"string\",\n  \"note\": \"string\",\n  \"published_at\": \"string\",\n  \"status\": \"string\",\n  \"tags\": [\n    \"string\"\n  ],\n  \"title\": \"string\"\n}"))
        .build();

    var response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.statusCode());
    System.out.println(response.body());
  }
}

import urllib.request

url = "https://contextowl.co/api/v1/workspaces/string/changelog"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
}
data = "{\n  \"markdown\": \"string\",\n  \"note\": \"string\",\n  \"published_at\": \"string\",\n  \"status\": \"string\",\n  \"tags\": [\n    \"string\"\n  ],\n  \"title\": \"string\"\n}".encode("utf-8")
req = urllib.request.Request(url, data=data, headers=headers, method="POST")
with urllib.request.urlopen(req) as res:
    print(res.status)
    print(res.read().decode())

const response = await fetch("https://contextowl.co/api/v1/workspaces/string/changelog", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "markdown": "string",
    "note": "string",
    "published_at": "string",
    "status": "string",
    "tags": [
      "string"
    ],
    "title": "string"
  })
});

console.log(response.status);
console.log(await response.json());

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
	"time"
)

func main() {
	body := strings.NewReader(`{
  "markdown": "string",
  "note": "string",
  "published_at": "string",
  "status": "string",
  "tags": [
    "string"
  ],
  "title": "string"
}`)
	req, err := http.NewRequest("POST", "https://contextowl.co/api/v1/workspaces/string/changelog", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")
	client := &http.Client{Timeout: 30 * time.Second}
	res, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	bodyBytes, err := io.ReadAll(io.LimitReader(res.Body, 10<<20))
	if err != nil {
		panic(err)
	}
	fmt.Println(res.StatusCode)
	fmt.Println(string(bodyBytes))
}

// cargo add reqwest --features blocking
fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = reqwest::blocking::Client::new();
    let response = client.request(reqwest::Method::POST, "https://contextowl.co/api/v1/workspaces/string/changelog")
        .header("Accept", "application/json")
        .header("Authorization", "Bearer <token>")
        .header("Content-Type", "application/json")
        .body("{\n  \"markdown\": \"string\",\n  \"note\": \"string\",\n  \"published_at\": \"string\",\n  \"status\": \"string\",\n  \"tags\": [\n    \"string\"\n  ],\n  \"title\": \"string\"\n}")
        .send()?;

    println!("{}", response.status());
    println!("{}", response.text()?);
    Ok(())
}

:::

:::details open Parameters (1)

:::

:::details open Request body (required)

application/json

{
  "markdown": "string",
  "note": "string",
  "published_at": "string",
  "status": "string",
  "tags": [
    "string"
  ],
  "title": "string"
}

:::

:::details open Success responses (201, 202)

201

Success

Content-Type: application/json

{
  "author": "string",
  "createdAt": "string",
  "id": 0,
  "markdown": "string",
  "publishedAt": "string",
  "status": "string",
  "tags": [
    "string"
  ],
  "title": "string",
  "updatedAt": "string",
  "url": "string"
}

202

The org reviews changes from agent keys, so the change waits in a proposal for an editor. Nothing changed for readers.

Content-Type: application/json

{
  "message": "string",
  "pendingReview": true,
  "proposal": {
    "baseRevision": "string",
    "entryId": 0,
    "id": 0,
    "objectType": "string",
    "outcome": "string",
    "reviewUrl": "string",
    "slug": "string",
    "status": "string",
    "summary": "string",
    "target": "string"
  }
}

:::

:::details Error responses (400, 401, 403, 404, 429, 500)

400

invalid_request: a parameter or the body is not valid.

Content-Type: application/json

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

401

unauthorized: the access key is missing, invalid or expired.

Content-Type: application/json

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

403

permission_denied: the key lacks the permission. two_factor_required: the org requires admins to turn on two-factor authentication.

Content-Type: application/json

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

404

not_found: the object does not exist, or the key cannot reach it.

Content-Type: application/json

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

429

rate_limited: too many requests. Wait for the time in the Retry-After header.

Content-Type: application/json

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

500

internal: the server failed.

Content-Type: application/json

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

:::