events
default

Notify about new releases. The release settings must be set to "event".

Changed on
post/events/releases

Request

Request body

repositorystring required

Repository name which uniquely identifies any repository in any service provider. The format matches the repository URL without the protocol part. No ".git" should be appended. We support a special syntax for repository sets: "{reposet id}" adds all the repositories from the given set.

commitstring required

Commit hash, either short (7 chars) or long (40 chars) form.

namestring nullable

Release name. The value may not contain \n - new line character, and ' - single quote.

authorstring

Release author.

urlstring url

Release URL.

published_atstring date-time

When the release was created. If missing, set to now().

Example request

[
  {
    "author": "Vadim Markovtsev",
    "commit": "c3f4d3a",
    "name": "0.8.66",
    "repository": "github.com/athenianco/athenian-api",
    "published_at": "2021-02-23T15:16:07Z",
    "url": "https://github.com/athenianco/athenian-api/releases/tag/v0.8.66"
  }
]

Response

Summary of the accepted and the rejected releases.

ReleaseNotificationStatus[] required

Response from /events/releases. The status of each release notification in the order of NotifyReleasesRequest.

Changes

    • breaking

      added the pattern ^([^'\s]| ){1,100}$ to the request property /

    • info

      the request property / became nullable