From f247e1b66f3a119743fc6789bb853b6c2f7d5ff5 Mon Sep 17 00:00:00 2001
From: bjarnef <bjarne_fyrstenborg@hotmail.com>
Date: Mon, 20 Jun 2016 19:54:46 +0200
Subject: [PATCH] Document getByQuery

---
 .../src/common/resources/entity.resource.js   | 48 ++++++++++++++-----
 1 file changed, 36 insertions(+), 12 deletions(-)

diff --git a/src/Umbraco.Web.UI.Client/src/common/resources/entity.resource.js b/src/Umbraco.Web.UI.Client/src/common/resources/entity.resource.js
index a9296acc37..914b601249 100644
--- a/src/Umbraco.Web.UI.Client/src/common/resources/entity.resource.js
+++ b/src/Umbraco.Web.UI.Client/src/common/resources/entity.resource.js
@@ -109,16 +109,6 @@ function entityResource($q, $http, umbRequestHelper) {
                        [{ id: id}, {type: type }])),
                'Failed to retrieve entity data for id ' + id);
         },
-        
-        getByQuery: function (query, nodeContextId, type) {            
-            return umbRequestHelper.resourcePromise(
-               $http.get(
-                   umbRequestHelper.getApiUrl(
-                       "entityApiBaseUrl",
-                       "GetByQuery",
-                       [{query: query},{ nodeContextId: nodeContextId}, {type: type }])),
-               'Failed to retrieve entity data for query ' + query);
-        },
 
         /**
          * @ngdoc method
@@ -168,7 +158,41 @@ function entityResource($q, $http, umbRequestHelper) {
 
         /**
          * @ngdoc method
-         * @name umbraco.resources.entityResource#getEntityById
+         * @name umbraco.resources.entityResource#getByQuery
+         * @methodOf umbraco.resources.entityResource
+         *
+         * @description
+         * Gets an entity from a given xpath
+         *
+         * ##usage
+         * <pre>
+         * //get content by xpath
+         * entityResource.getByQuery("$current", -1, "Document")
+         *    .then(function(ent) {
+         *        var myDoc = ent; 
+         *        alert('its here!');
+         *    });
+         * </pre> 
+         * 
+         * @param {string} query xpath to use in query
+         * @param {Int} nodeContextId id id to start from
+         * @param {string} type Object type name        
+         * @returns {Promise} resourcePromise object containing the entity.
+         *
+         */
+        getByQuery: function (query, nodeContextId, type) {
+            return umbRequestHelper.resourcePromise(
+               $http.get(
+                   umbRequestHelper.getApiUrl(
+                       "entityApiBaseUrl",
+                       "GetByQuery",
+                       [{ query: query }, { nodeContextId: nodeContextId }, { type: type }])),
+               'Failed to retrieve entity data for query ' + query);
+        },
+
+        /**
+         * @ngdoc method
+         * @name umbraco.resources.entityResource#getAll
          * @methodOf umbraco.resources.entityResource
          *
          * @description
@@ -260,7 +284,7 @@ function entityResource($q, $http, umbRequestHelper) {
      
         /**
          * @ngdoc method
-         * @name umbraco.resources.entityResource#searchMedia
+         * @name umbraco.resources.entityResource#search
          * @methodOf umbraco.resources.entityResource
          *
          * @description