-
Type:
Suggestion
-
Resolution: Fixed
-
None
-
Component/s: Documentation - All
-
None
Problem Definition
The Setting configuration properties document for Automation for Jira (A4J) has some command examples on how to query current value for properties and how to change them.
How the current examples are presented may lead to confusion on how to use the REST API method to perform the above actions, specifically regarding where the Jira Base URL is expected.
For example, this URL is used in one of the examples:
http://<HOST>:<PORT>/jira/rest/cb-automation/1/configuration/property/
There's no explanation that /jira is a context path and should be changed/removed depending on the customer configuration.
Suggested Solution
Instead of using http://<HOST>:<PORT>/jira, change it for <Jira Base URL>, such as:
curl -u <user>:<password> <Jira Base URL>/rest/cb-automation/1/configuration/property/<PROPERTY_KEY>