Add docs for settings per #1069

common/models/access-token.js

@@ -15,9 +15,12 @@ var DEFAULT_TOKEN_LEN = 64;
  *  - DENY EVERYONE `*`
  *  - ALLOW EVERYONE create
  *
- * @property {String} id Generated token ID
+ * @property {String} id Generated token ID.
  * @property {Number} ttl Time to live in seconds, 2 weeks by default.
- * @property {Date} created When the token was created
+ * @property {Date} created When the token was created.
+ * @property {Object} settings Extends the `Model.settings` object.
+ * @property {Number} settings.accessTokenIdLength Length of the base64-encoded string access token. Default value is 64.
+ * Increase the length for a more secure access token.
  *
  * @class AccessToken
  * @inherits {PersistedModel}

common/models/acl.js

@@ -62,12 +62,16 @@ assert(Role, 'Role model must be defined before ACL model');
  * @property {String} property Name of the property, method, scope, or relation.
  * @property {String} accessType Type of access being granted: one of READ, WRITE, or EXECUTE.
  * @property {String} permission Type of permission granted. One of:
+ *
  *  - ALARM: Generate an alarm, in a system-dependent way, the access specified in the permissions component of the ACL entry.
  *  - ALLOW: Explicitly grants access to the resource.
  *  - AUDIT: Log, in a system-dependent way, the access specified in the permissions component of the ACL entry.
  *  - DENY: Explicitly denies access to the resource.
  * @property {String} principalType Type of the principal; one of: Application, Use, Role.
- * @property {String} principalId ID of the principal - such as appId, userId or roleId
+ * @property {String} principalId ID of the principal - such as appId, userId or roleId.
+ * @property {Object} settings Extends the `Model.settings` object.
+ * @property {String} settings.defaultPermission Default permission setting: ALLOW, DENY, ALARM, or AUDIT. Default is ALLOW.
+ * Set to DENY to prohibit all API access by default.
  *
  * @class ACL
  * @inherits PersistedModel

common/models/change.js

@@ -13,13 +13,17 @@ var debug = require('debug')('loopback:change');
 /**
  * Change list entry.
  *
- * @property {String} id Hash of the modelName and id
- * @property {String} rev The current model revision
- * @property {String} prev The previous model revision
- * @property {Number} checkpoint The current checkpoint at time of the change
- * @property {String} modelName Model name
- * @property {String} modelId Model ID
- *
+ * @property {String} id Hash of the modelName and ID.
+ * @property {String} rev The current model revision.
+ * @property {String} prev The previous model revision.
+ * @property {Number} checkpoint The current checkpoint at time of the change.
+ * @property {String} modelName Model name.
+ * @property {String} modelId Model ID.
+ * @property {Object} settings Extends the `Model.settings` object.
+ * @property {String} settings.hashAlgorithm Algorithm used to create cryptographic hash, used as argument
+ * to [crypto.createHash](http://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm).  Default is sha1.
+ * @property {Boolean} settings.ignoreErrors By default, when changes are rectified, an error will throw an exception.
+ * However, if this setting is true, then errors will not throw exceptions.
  * @class Change
  * @inherits {PersistedModel}
  */

common/models/user.js

@@ -53,9 +53,9 @@ var debug = require('debug')('loopback:user');
  * Default is `1209600` (2 weeks)
  * @property {Number} settings.maxTTL The max value a user can request a token to be alive / valid for.
  * Default is `31556926` (1 year)
- * @property {Boolean} settings.realmRequired Require a realm when logging in a user
- * @property {String} settings.realmDelimiter When set a realm is required
- * @property {Number} settings.resetPasswordTokenTTL Time to live for password reset `AccessToken`. Default is `900` (15 minutes)
+ * @property {Boolean} settings.realmRequired Require a realm when logging in a user.
+ * @property {String} settings.realmDelimiter When set a realm is required.
+ * @property {Number} settings.resetPasswordTokenTTL Time to live for password reset `AccessToken`. Default is `900` (15 minutes).
  * @property {Number} settings.saltWorkFactor The `bcrypt` salt work factor. Default is `10`.
  *
  * @class User

lib/model.js

@@ -90,6 +90,9 @@ var stringUtils = require('underscore.string');
  * @property {String} Model.modelName The name of the model. Static property.
  * @property {DataSource} Model.dataSource Data source to which the model is connected, if any. Static property.
  * @property {SharedClass} Model.sharedMethod The `strong-remoting` [SharedClass](http://apidocs.strongloop.com/strong-remoting/#sharedclass) that contains remoting (and http) metadata. Static property.
+ * @property {Object} settings Contains additional model settings.
+ * @property {string} settings.http.path Base URL of the model HTTP route.
+ * @property [{string}] settings.acls Array of ACLs for the model.
  * @class
  */