[CLOUDSTACK-4719] Document details parameter of registerTemplate

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 4.1.1
• Fix Version/s: 4.6.0
• Component/s: Doc
• Security Level: Public (Anyone can view this level - this is the default.)
• Labels: adminguide api
• Assignee: Pierre-Luc Dion
• Reporter: Kirk Kosinski
• Created: 20/Sep/13 23:13
• Updated: 09/Mar/15 02:19
• Resolved: 09/Mar/15 02:19

Description

Currently the API documentation for registerTemplate has the following description for the "details" parameter:

Template details in key/value pairs.

This is not an adequate explanation for how to use it. This parameter must be in the format "details[id].keyname=keyvalue". For example, "details[0].somekey=somevalue".

This feature can be useful so the explanation in the API documentation should be updated, or it should be explained in more detail in the admin guide.