@ -114,9 +114,10 @@ public class AssetController extends BaseController {
}
}
@ApiOperation(value="Create Or Update Asset (saveAsset)",
@ApiOperation(value="Create Or Update Asset (saveAsset)",
notes="Creates or Updates the Asset. Platform generates random asset Id during asset creation. "+
notes="Creates or Updates the Asset. When creating asset, platform generates Asset Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)"+
"The asset id will be present in the response. "+
"The newly created asset id will be present in the response. "+
"Specify the asset id when you would like to update the asset. Referencing non-existing asset Id will cause an error.",produces=MediaType.APPLICATION_JSON_VALUE)
"Specify existing Asset id to update the asset. "+
"Referencing non-existing asset Id will cause 'Not Found' error.",produces=MediaType.APPLICATION_JSON_VALUE)
@ -85,6 +96,8 @@ public class AuthController extends BaseController {
}
}
}
}
@ApiOperation(value="Logout (logout)",
notes="Special API call to record the 'logout' of the user to the Audit Logs. Since platform uses [JWT](https://jwt.io/), the actual logout is the procedure of clearing the [JWT](https://jwt.io/) token on the client side. ")
@ -92,13 +105,17 @@ public class AuthController extends BaseController {
logLogoutAction(request);
logLogoutAction(request);
}
}
@ApiOperation(value="Change password for current User (changePassword)",
notes="Change the password for the User which credentials are used to perform this REST API call. Be aware that previously generated [JWT](https://jwt.io/) tokens will be still valid until they expire.")
@ -135,8 +154,13 @@ public class AuthController extends BaseController {
}
}
}
}
@ApiOperation(value="Check Activate User Token (checkActivateToken)",
notes="Checks the activation token and forwards user to 'Create Password' page. "+
"If token is valid, returns '303 See Other' (redirect) response code with the correct address of 'Create Password' page and same 'activateToken' specified in the URL parameters. "+
notes="Checks the password reset token and forwards user to 'Reset Password' page. "+
"If token is valid, returns '303 See Other' (redirect) response code with the correct address of 'Reset Password' page and same 'resetToken' specified in the URL parameters. "+
@ -137,9 +137,11 @@ public class DeviceController extends BaseController {
}
}
@ApiOperation(value="Create Or Update Device (saveDevice)",
@ApiOperation(value="Create Or Update Device (saveDevice)",
notes="Creates or Updates the Device. Platform generates random device Id and credentials (access token) during device creation. "+
notes="Creates or Updates the Device. When creating device, platform generates Device Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)"+
"The device id will be present in the response. "+
"Device credentials are also generated if not provided in the 'accessToken' request parameter. "+
"Specify the device id when you would like to update the device. Referencing non-existing device Id will cause an error.")
"The newly created device id will be present in the response. "+
"Specify existing Device id to update the device. "+
"Referencing non-existing device Id will cause 'Not Found' error.")
@ApiModelProperty(position=3,value="Type of the Rule Node",readOnly=true)
@Getter@SetterprivateComponentTypetype;
@Getter@SetterprivateComponentTypetype;
@ApiModelProperty(position=4,value="Scope of the Rule Node. Always set to 'TENANT', since no rule chains on the 'SYSTEM' level yet.",readOnly=true,allowableValues="TENANT",example="TENANT")
@Getter@SetterprivateComponentScopescope;
@Getter@SetterprivateComponentScopescope;
@ApiModelProperty(position=5,value="Name of the Rule Node. Taken from the @RuleNode annotation.",readOnly=true,example="Custom Rule Node")
@Getter@SetterprivateStringname;
@Getter@SetterprivateStringname;
@ApiModelProperty(position=6,value="Full name of the Java class that implements the Rule Engine Node interface.",readOnly=true,example="com.mycompany.CustomRuleNode")
@Getter@SetterprivateStringclazz;
@Getter@SetterprivateStringclazz;
@ApiModelProperty(position=7,value="Complex JSON object that represents the Rule Node configuration.",readOnly=true)
Dima Landiak
5 years ago