diff --git a/src/Umbraco.Web.UI.Client/src/common/resources/modelsbuildermanagement.resource.js b/src/Umbraco.Web.UI.Client/src/common/resources/modelsbuildermanagement.resource.js index ee3cd80c71..8352ca07e6 100644 --- a/src/Umbraco.Web.UI.Client/src/common/resources/modelsbuildermanagement.resource.js +++ b/src/Umbraco.Web.UI.Client/src/common/resources/modelsbuildermanagement.resource.js @@ -1,18 +1,82 @@ + +/** +* @ngdoc service +* @name umbraco.resources.modelsBuilderManagementResource +* @description Resources to get information on modelsbuilder status and build models +**/ function modelsBuilderManagementResource($q, $http, umbRequestHelper) { return { + + /** + * @ngdoc method + * @name umbraco.resources.modelsBuilderManagementResource#getModelsOutOfDateStatus + * @methodOf umbraco.resources.modelsBuilderManagementResource + * + * @description + * Gets the status of modelsbuilder + * + * ##usage + *
+ * modelsBuilderManagementResource.getModelsOutOfDateStatus()
+ * .then(function() {
+ * Do stuff...*
+ * });
+ *
+ *
+ * @returns {Promise} resourcePromise object.
+ *
+ */
getModelsOutOfDateStatus: function () {
return umbRequestHelper.resourcePromise(
$http.get(umbRequestHelper.getApiUrl("modelsBuilderBaseUrl", "GetModelsOutOfDateStatus")),
"Failed to get models out-of-date status");
},
+ /**
+ * @ngdoc method
+ * @name umbraco.resources.modelsBuilderManagementResource#buildModels
+ * @methodOf umbraco.resources.modelsBuilderManagementResource
+ *
+ * @description
+ * Builds the models
+ *
+ * ##usage
+ *
+ * modelsBuilderManagementResource.buildModels()
+ * .then(function() {
+ * Do stuff...*
+ * });
+ *
+ *
+ * @returns {Promise} resourcePromise object.
+ *
+ */
buildModels: function () {
return umbRequestHelper.resourcePromise(
$http.post(umbRequestHelper.getApiUrl("modelsBuilderBaseUrl", "BuildModels")),
"Failed to build models");
},
+ /**
+ * @ngdoc method
+ * @name umbraco.resources.modelsBuilderManagementResource#getDashboard
+ * @methodOf umbraco.resources.modelsBuilderManagementResource
+ *
+ * @description
+ * Gets the modelsbuilder dashboard
+ *
+ * ##usage
+ *
+ * modelsBuilderManagementResource.getDashboard()
+ * .then(function() {
+ * Do stuff...*
+ * });
+ *
+ *
+ * @returns {Promise} resourcePromise object.
+ *
+ */
getDashboard: function () {
return umbRequestHelper.resourcePromise(
$http.get(umbRequestHelper.getApiUrl("modelsBuilderBaseUrl", "GetDashboard")),