[Prototype] EZP-26309: Prototype the usage of REST Embedding in PlatformUI

[dpobel]

See ezsystems/PlatformUIBundle#687

[ezrobot]

yuidoc reports the following documentation warnings:

YUIDoc found 1 lint errors in your docs
#1 replacing incorrect tag: parma with param  src/services/ContentService.js:563

[andrerom]

should specify it acts as callback if callback is not set for bc, same below :)

[dpobel]

the [ and ] around headers means the parameter is not mandatory so that's kind of implied but to be honest, the documentation was not really my main purpose here :-)
That said, this is a good point because we could also do the same thing by keeping 2 parameters on the method and allowing the first one to be an option object:

/**
  * bla bla
  *
  * @param {String|Object} options the userId or an object containing the userId and others options
  * @param {String} options.userId
  * @param {Object} options.headers additional headers
  * @param {Function} callback
  */
ContentService.prototype.loadUserDrafts = function (options, callback) {
    var userId = options, headers = {};

    if ( typeof options === "object" ) {
        userId = options.userId;
        headers = options.headers || headers;
    }
    // ...
};

and I'm not really sure which approach is the best

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication