Uploaded image for project: 'Bamboo Data Center'
  1. Bamboo Data Center
  2. BAM-22122

The REST API elasticConfiguration endpoint has incorrect sample syntax for POST and PUT methods

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • Low
    • 9.2.3, 9.1.3, 9.0.4
    • 9.2.1
    • REST API
    • None

    Description

      Issue Summary

      This is reproducible on Data Center:

      The REST API elasticConfiguration has incorrect POST and PUT sample syntaxes

      The example syntax provided on the REST API Swagger documentation contains invalid examples for the "subnetIds" and "availabilityZones"

      Steps to Reproduce

      1. Try updating an elasticConfiguration via the Bamboo REST API using the sample input from the documentation
      2. Observe that Bamboo will not accept subnetIds and availabilityZones

      Expected Results

      1. Bamboo should work as reported on the documentation

      Actual Results

      The REST API documentation contains an incorrect example of the following properties:

      • subnetIds
      • availabilityZones

      Both valid properties are actually in the singular form and should be used as:

      • subnetId
      • availabilityZone

      There is another issue that relies on the format of the input on both fields. In the example below, it is expected the user provides an array:

        "availabilityZones": [
          "<string>"
        ],
        "subnetIds": [
          "<string>"
        ],
      

      But the expected and working format is a string. E.g:

        "availabilityZone": "ap-southeast-2a,ap-southeast-2b",
        "subnetId": "subnet-059ab6ecbd34db33f,subnet-07509d60ac00ff33",
      

      Workaround

      Use the correct property names and string input as reported above

      Attachments

        Issue Links

          Activity

            People

              72548a1cec6d Wioletta Dys
              73868399605e Eduardo Alvarenga
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: