PingAM

Changelog

Add a changelog to the node’s .properties file for each node version to provide a record of changes for a node.

  1. Make sure there’s a .properties file under src/main/resources/org.forgerock.openam.auth.nodes with the same name as your node class.

  2. At the end of the .properties file, add a changelog property in the following format:

    changelog.n.n=changelog text

    For example:

    changelog.2.0=Updated the node to replace the secretValue attribute with secretLabelIdentifier.

To retrieve all the changelogs for a node, send a POST request to the realm-config/authentication/authenticationtrees/nodes/node-name?_action=versionInfo endpoint.

Example response:

[
  {
    "version": "1.0",
    "changelog": "No changelog entry found"
  },
  {
    "version": "2.0",
    "changelog": "Updated the node to replace the secretValue attribute with secretLabelIdentifier."
  }
]

Include the node version in the request URL to return the changelog only for the specified node version.