Listing release candidates

It is possible to view a list of available feeds on the syndication server, which will list all available release candidate snapshots. This is useful when confirming configuration to deploy a release candidate to Staging or Production.

Prerequisites

The following prerequisites are required

  1. A set of client credentials with read access to the syndication server

Procedure

As there is presently no user interface for this feature, an HTTP request tool such as cURL or Postman is required. The following example is provided using cURL which can easily be imported into Postman.

REST request to list feeds

First get a bearer token. See more details about this process here.

curl --location --request GET 'https://syndication-server/feed'\  --header 'Authorization: Bearer AAA'

where the following placeholders require completion for the specific installation

PlaceholderRequired value
syndication-serverhost name of the syndication server
AAAthe bearer token taken from the earlier step

The response will be a JSON payload containing a list of all the syndication feeds in the syndication server detailing their name, title and URL. An example feed listing request response is shown below.

[
  {
    "name": "test",
    "title": "test",
    "url": "https://syndication-server/feed/test/syndication.xml"
  },
  {
    "name": "authoring-input",
    "title": "Input indexes and FHIR content for the authoring server",
    "url": "https://syndication-server/feed/authoring-input/syndication.xml"
  },
  {
    "name": "release-candidate-20200815T1300",
    "title": "Release candidate snapshot taken 20200815T1300",
    "url": "https://syndication-server/feed/release-candidate-20200815T1300/syndication.xml"
  }
]