Versions Compared

Old Version 11

changes.mady.by.user Prachi Damle

Saved on

compared with

New Version 12

changes.mady.by.user Rohit Yadav

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • name (String, should be unique and is required) - api command name to use for over the wire requests. Should be camelcased.
  • description (String, empty if not specified) - provides brief description for the API command.
  • usage (String, empty if not specified) - gives the example of the command usage (supported parameters combinations, any other details that are too big to be included to the description)
  • includeInApiDoc (boolean, true if not specified) - defines if the command should be included to the API doc
  • since (String, empty if not specified) - mentions the product version the command was introduced in.
  • responseObject (class<? extends BaseResponse>) - type of the response object for the command.

  • requestHasSensitiveInfo (boolean, defaulted to true)

  • responseHasSensitiveInfo (boolean, defaulted to true)

  • authorized(RoleType[], empty by default) - define the Account user account roles eligible to execute this command. This can be used to enable default ACL for an API.

  • entityType(IAMEntityType[], empty by default) - 

...