Helix Swarm Guide (2019.3)

API versions

Beginning with Swarm 2019.3, we have started adding a new set of v10 APIs to Swarm. These will provide a new endpoint and response pattern, and are designed for use with the new rich User Interface that is being introduced in 2020. The v9 APIs will continue to be available for some time to come, but their functionality will be duplicated and expanded in the v10 APIs over the next few releases.

v10 does not currently provide a full set of features, so it is recommended that you use v9 for now if the features that you need are not present in v10. APIs older than v9 are being deprecated, and support for them will be removed in a future release.

Important
  • Swarm will continue to support the v9 APIs and you can continue to use them if you prefer.
  • Any improvements made in the migration to v10 will not be backported to v9.
  • New API endpoints will be created as v10 and will not be backported to v9.

Current API versions:

API version Swarm Release Date Description
v10 2019.3 October 2019 Include support for integration with CI tools.

v9

2018.1

April 2018

Include support for append and replace changelist to a review, 2 Factor Authentication and mark a comment as read.

Deprecated API versions:

From Swarm 2019.3, APIs older than v9 are being deprecated. Support for them will be removed in a future release.

API version Swarm Release Date Description

v8

2017.4

December 2017

Include support for default reviewers on a project or project branch.

v7

2017.3

October 2017

Include support for groups as participants of a review and groups as moderators of a project branch.

v6

2017.1

May 2017

Include support for activity dashboard, archiving of inactive reviews, cleaning completed reviews and for voting reviews up and down.

v5

2016.3

December 2016

Include support for limiting comments to a specific review version.

v4

2016.2

October 2016

Include support for private projects, as well as file-level and line-level inline comments.

v3

2016.1 SP1

September 2016

Include new endpoint for comments.

v2

2016.1

May 2016

Include new endpoints for projects, groups, etc.

v1.2

2015.3

October 2015

Add author filter to the list reviews endpoint.

v1.1

2014.4

January 2015

Addition of required reviewers, and apiVersions.

v1

2014.3

July 2014

Initial release.