Zympler.

ReleaseNote

The release notes of the Zympler platform, as shown in the portal, with their attachments.

List all release notes

GET /release-notes

curl

curl -X GET "https://api.zympler.com/v1beta/release-notes" \
  -H "Authorization: Bearer $ZYMPLER_TOKEN"

Rust

let response = reqwest::Client::new()
    .get("https://api.zympler.com/v1beta/release-notes")
    .bearer_auth(&token)
    .send()
    .await?
    .error_for_status()?;
let body: serde_json::Value = response.json().await?;

Python

response = requests.get(
    "https://api.zympler.com/v1beta/release-notes",
    headers={"Authorization": f"Bearer {token}"},
    timeout=30,
)
response.raise_for_status()
data = response.json()
Parameters
NameInTypeRequiredDescription
page_cursorquerystringPageCursor
page_sizequeryinteger (uint64)Page size
Responses

Fields

Type: object

Status codes

StatusDescription
200Ok
400Bad Request
401Unauthorized
403Forbidden

Download a file for a release note

GET /release-notes/{release_note_id}/files/{release_note_file_id}

curl

RELEASE_NOTE_ID="<release_note_id>"
RELEASE_NOTE_FILE_ID="<release_note_file_id>"

curl -X GET "https://api.zympler.com/v1beta/release-notes/$RELEASE_NOTE_ID/files/$RELEASE_NOTE_FILE_ID" \
  -H "Authorization: Bearer $ZYMPLER_TOKEN"

Rust

let release_note_id = "<release_note_id>";
let release_note_file_id = "<release_note_file_id>";
let response = reqwest::Client::new()
    .get(format!("https://api.zympler.com/v1beta/release-notes/{release_note_id}/files/{release_note_file_id}"))
    .bearer_auth(&token)
    .send()
    .await?
    .error_for_status()?;
let body: serde_json::Value = response.json().await?;

Python

release_note_id = "<release_note_id>"
release_note_file_id = "<release_note_file_id>"
response = requests.get(
    f"https://api.zympler.com/v1beta/release-notes/{release_note_id}/files/{release_note_file_id}",
    headers={"Authorization": f"Bearer {token}"},
    timeout=30,
)
response.raise_for_status()
data = response.json()
Parameters
NameInTypeRequiredDescription
release_note_idpathstring (uuid)yesID of release note
release_note_file_idpathstring (uuid)yesID of release note file
Responses

Fields

Type: string (binary)

Status codes

StatusDescription
200Ok
400Bad Request
401Unauthorized
Search