Skip to content
OpenSmartRoute
Documentation
Hosted platformREST API reference

Releases

Release notes parsed from the changelog: every released version with its sections and highlights, the version this deployment runs, and what a signed-in person has not read yet (What's new).

Hosted platformAPI version 2.1.0

get/api/v1/me/whats-new

Whats New

What changed since this user last acknowledged a release (empty once acknowledged).

Requires an API key

Parameters

NameInTypeDefaultDescription
x-goog-api-keyheaderstring | null

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s "$OSR_URL/api/v1/me/whats-new" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/me/whats-new/seen

Mark Seen

Remember that this user has read the notes up to the running version.

Requires an API key

Parameters

NameInTypeDefaultDescription
x-goog-api-keyheaderstring | null

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s -X POST "$OSR_URL/api/v1/me/whats-new/seen" \
  -H "Authorization: Bearer $OSR_API_KEY"

get/api/v1/releases

List Releases

Released versions from the changelog, newest first, the version this deployment runs, the build it is (stable release or developer preview, docs/RELEASES.md) and what has landed since the last release.

No authentication

Parameters

NameInTypeDefaultDescription
limitqueryinteger10

Responses

200Successful Response
422Validation ErrorHTTPValidationError
Requestbash
curl -s "$OSR_URL/api/v1/releases?limit=10"

get/api/v1/releases/{version}

One Release

One release's notes; unreleased returns the changes since the last release (404 when there are none).

No authentication

Parameters

NameInTypeDefaultDescription
version(required)pathstring

Responses

200Successful Response
422Validation ErrorHTTPValidationError
Requestbash
curl -s "$OSR_URL/api/v1/releases/<version>"

Something wrong or out of date on this page? Tell us - the page is named for you, so a one-line note is enough.