Problem Definition

API Documentation for the elasticConfiguration REST APIs are not well documented.

/elasticConfiguration, {{/elasticConfiguration/

}}, and /elasticConfiguration/image-id/{imageId}?newImageId does not include an acceptable request representation or parameters so it's difficult to know which parameters need to be included. Example:

• https://docs.atlassian.com/atlassian-bamboo/REST/6.8.1/#d2e2681

Suggested Solution

Update the documentation to include correct response examples.

Example, for GET /elasticConfiguration

{
        "configurationId": 262146,
        "configurationName": "Windows stock image",
        "configurationDescription": "Elastic Image Configuration shipped with Bamboo",
        "imageId": "ami-0137c5d951e6fd8d6",
        "ebsEnabled": false,
        "useLegacyEbsHandling": false,
        "instanceType": "M3Large",
        "product": "Windows",
        "startupScripts": [],
        "architecture": "x86_64",
        "platform": "windows",
        "rootDeviceType": "ebs",
        "region": "eu-c1",
        "imageFilesVersion": "3.0",
        "isEbsOptimised": false
    },

Example response for PUT /elasticConfiguration/image-id/{imageId}?newImageId

2

(where the number represents the amount of configurations that have changed)

Workaround

For a better idea on how to use these APIs, see the PUT /elasticConfiguration/image-id/{imageId}?newImageId curl example included below:

curl --user bamboo-admin:password -H "Content-Type: application/json" -X PUT http://bamboo:8085/rest/api/latest/elasticConfiguration/image-id/ami-xxxxxxxx?newImageId=ami-xxxxxxxx