Jira REST API document should clarify the mutually exclusive condition for Permission scheme

XMLWordPrintable

    • 2
    • Severity 3 - Minor

      Issue Summary

      The documentation for Create Permission Scheme Jira REST API does not clarify the mutually exclusive condition for 'parameter' and 'value'.

      The API documentation should be updated to clarify that either one of the parameters is required.

      Steps to Reproduce

      1. Use the payload from the "Example" code for the create Permission scheme.
      2. The body for the POST method has both "parameter" and "value":
        "holder": {
                "parameter": "jira-core-users",
                "type": "group",
                "value": "ca85fac0-d974-40ca-a615-7af99c48d24f"
              } 

      Expected Results

      A permission scheme should be created using the example code from the documentation.

      Actual Results

      The API call will fail with below message:

      
          "errorMessages": [
              "The body parameters 'parameter' and 'value' are mutually exclusive."
          ],
          "errors": {} 

      Workaround

      The body should either contain a "parameter" or "value"

            Assignee:
            Unassigned
            Reporter:
            Rahul Kumar
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated: