Skip to content
Snippets Groups Projects
Commit 51edefaf authored by Mathis Neumann's avatar Mathis Neumann
Browse files

additional documentation

parent e3c3e38e
No related branches found
No related tags found
No related merge requests found
...@@ -13,18 +13,24 @@ const Model = Measurable.extend({ ...@@ -13,18 +13,24 @@ const Model = Measurable.extend({
*/ */
technology: attr('string'), technology: attr('string'),
/** /**
* id of the ServiceInstance which is the sender * id of the sending ServiceInstance
* @property sourceId * @property sourceId
* @type String * @type String
*/ */
sourceId: attr('string'), sourceId: attr('string'),
/** /**
* id of the ServiceInstance which is the sender * id of the receiving ServiceInstance
* @property sourceId * @property targetId
* @type String * @type String
*/ */
targetId: attr('string'), targetId: attr('string'),
/**
* The amount of workload. Shows how many requests where sent via this connection
* @property workload
* @type Number
*/
workload: attr('number') workload: attr('number')
}); });
......
...@@ -13,13 +13,13 @@ const Model = BaseEntity.extend({ ...@@ -13,13 +13,13 @@ const Model = BaseEntity.extend({
* name of the system * name of the system
* @type {String} * @type {String}
* @property name * @property name
* @for System
* @public * @public
*/ */
name: attr('string'), name: attr('string'),
/** /**
* loads the current revision for the system instance from the server (without caching) * loads the current revision for the system instance from the server (without caching)
* @type {Promise|RevisionResponse} plain JS object containing the revisionNumber (number), lastUpdate (Date string), changelogSequence (number) * @method getRevision
* @return {Promise|RevisionResponse} plain JS object containing the revisionNumber (number), lastUpdate (Date string), changelogSequence (number)
*/ */
getRevision: memberAction({ path: 'revision', type: 'GET', urlType: 'findRecord'}) getRevision: memberAction({ path: 'revision', type: 'GET', urlType: 'findRecord'})
}); });
...@@ -34,6 +34,7 @@ Model.reopenClass({ ...@@ -34,6 +34,7 @@ Model.reopenClass({
export default Model; export default Model;
// FOR DOCUMENTATION ONLY
/** /**
* Response object from a revision class. This is only for improving the documentation, there is no real class existing. * Response object from a revision class. This is only for improving the documentation, there is no real class existing.
* @class RevisionResponse * @class RevisionResponse
...@@ -42,22 +43,25 @@ export default Model; ...@@ -42,22 +43,25 @@ export default Model;
const Revision = { const Revision = {
// jshint unused:false // jshint unused:false
/** /**
* * the revision which was used when creating the entity
* @property revisionNumber * @property revisionNumber
* @type {Number} * @type Number
* @readonly * @readonly
*/ */
revisionNumber: null, revisionNumber: null,
/** /**
* The date (as a String) when the revision was changed the last time (server time)
*
* @property lastUpdate * @property lastUpdate
* @type {String|Date} * @type String|Date
* @readonly * @readonly
*/ */
lastUpdate: null, lastUpdate: null,
/** /**
* The sequence number, at which position of the applied list of changelogs was the last update
* @property changelogSequence * @property changelogSequence
* @type {Number} * @type Number
* @readonly * @readonly
*/ */
changelogSequence: null changelogSequence: null
......
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
"json": "http://builds.emberjs.com/tags/v2.4.0/ember-docs.json" "json": "http://builds.emberjs.com/tags/v2.4.0/ember-docs.json"
}, },
{ {
"base": "http://emberjs.com/api/", "base": "http://emberjs.com/api/data/",
"json": "http://builds.emberjs.com/tags/v2.4.0/ember-data-docs.json" "json": "http://builds.emberjs.com/tags/v2.4.0/ember-data-docs.json"
} }
] ]
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment