Adding new response code to endpoints and extending projection to inc…

…lude filter parameter
yetisoftworks · Oct 31, 2019 · 0559a80 · 0559a80
1 parent 386da62
commit 0559a80
Show file tree

Hide file tree

Showing 9 changed files with 67 additions and 5 deletions.
diff --git a/docs/data/creating.rst b/docs/data/creating.rst
@@ -115,5 +115,8 @@ Example Result
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to create meshes or specific mesh.
+
 429 : Too many request
    * You have either hit your API or Database limit. Please review your account.
diff --git a/docs/data/deleting.rst b/docs/data/deleting.rst
@@ -90,6 +90,9 @@ Permanently remove Mesh data from collection.
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to delete meshes or mesh.
+
 404 : Not Found
    * Mesh data was not found.
 

diff --git a/docs/data/projecting.rst b/docs/data/projecting.rst
@@ -38,7 +38,8 @@ API Reference
          var client = MeshyClient.Initialize(accountName, publicKey);
          var connection = await client.LoginAnonymouslyAsync(username);
          
-         var stateAttractions = await connection.Projections.Get<PopularState>(projectionName, 
+         var stateAttractions = await connection.Projections.Get<PopularState>(projectionName,
+                                                                               filter,
                                                                                orderBy, 
                                                                                page, 
                                                                                pageSize);
@@ -53,6 +54,8 @@ API Reference
          Unique identifier for user or device.
       projectionName : :type:`string`, :required:`required`
          Identifies name of mesh collection. e.g. person.
+      filter : :type:`string`
+         Criteria provided in a MongoDB format to limit results.
       orderBy : :type:`object`
          Defines which fields need to be ordered and direction. Review more ways to use `ordering <#ordering-data>`_.
       page : :type:`integer`, default: 1
@@ -72,6 +75,7 @@ API Reference
 
          var popularStates = await meshyConnection.projections.get<any>(projectionName, 
                                                                         {
+                                                                            filter: filter,
                                                                             orderBy: orderBy,
                                                                             page: page,
                                                                             pageSize: pageSize
@@ -87,6 +91,8 @@ API Reference
          Unique identifier for user or device.
       projectionName : :type:`string`, :required:`required`
          Identifies name of mesh collection. e.g. person.
+      filter : :type:`string`
+         Criteria provided in a MongoDB format to limit results.
       orderBy : :type:`string`
          Defines which fields need to be ordered and direction in a MongoDB format. Review more ways to use `ordering <#ordering-data>`_.
       page : :type:`integer`, default: 1
@@ -111,6 +117,8 @@ API Reference
          Identifies name of mesh collection. e.g. person.
       projectionName : :type:`string`, :required:`required`
          Identifies name of mesh collection. e.g. person.
+      filter : :type:`string`
+         Criteria provided in a MongoDB format to limit results.
       orderBy : :type:`string`
          Defines which fields need to be ordered and direction in a MongoDB format. Review more ways to use `ordering <#ordering-data>`_.
       page : :type:`integer`, default: 1
@@ -143,7 +151,10 @@ Example Result
 
 401 : Unauthorized
    * User is not authorized to make call.
-
+
+403 : Forbidden
+   * User has insufficent permission to read projections.
+
 404 : Not Found
    * Projection was not found.
 

diff --git a/docs/data/retrieving.rst b/docs/data/retrieving.rst
@@ -108,6 +108,9 @@ Example Result
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to read meshes or mesh.
+
 404 : Not Found
    * Mesh data was not found.
 

diff --git a/docs/data/searching.rst b/docs/data/searching.rst
@@ -136,6 +136,9 @@ Example Result
 
 401 : Unauthorized
    * User is not authorized to make call.
-
+
+403 : Forbidden
+   * User has insufficent permission to read meshes or mesh.
+
 429 : Too many request
    * You have either hit your API or Database limit. Please review your account.
diff --git a/docs/data/updating.rst b/docs/data/updating.rst
@@ -116,5 +116,8 @@ Example Result
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to update meshes or mesh.
+
 429 : Too many request
    * You have either hit your API or Database limit. Please review your account.
diff --git a/docs/intro/getting_started_csharp.rst b/docs/intro/getting_started_csharp.rst
@@ -321,6 +321,9 @@ Example Result
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to create meshes or mesh.
+
 429 : Too many request
    * You have either hit your API or Database limit. Please review your account.
 
@@ -372,6 +375,9 @@ Example Result
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to update meshes or mesh.
+
 429 : Too many request
    * You have either hit your API or Database limit. Please review your account.
 
@@ -428,6 +434,9 @@ Example Result
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to read meshes or mesh.
+
 429 : Too many request
    * You have either hit your API or Database limit. Please review your account.
 
@@ -473,6 +482,9 @@ The example below shows deleting the data from the API by providing the object.
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to delete meshes or mesh.
+
 404 : Not Found
    * Mesh data was not found.
 

diff --git a/docs/intro/getting_started_nodejs.rst b/docs/intro/getting_started_nodejs.rst
@@ -300,6 +300,9 @@ Example Result
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to create meshes or mesh.
+
 429 : Too many request
    * You have either hit your API or Database limit. Please review your account.
 
@@ -353,6 +356,9 @@ Example Result
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to update meshes or mesh.
+
 429 : Too many request
    * You have either hit your API or Database limit. Please review your account.
 
@@ -410,7 +416,10 @@ Example Result
 
 401 : Unauthorized
    * User is not authorized to make call.
-
+
+403 : Forbidden
+   * User has insufficent permission to read meshes or mesh.
+
 429 : Too many request
    * You have either hit your API or Database limit. Please review your account.
 
@@ -456,6 +465,9 @@ The example below shows deleting the data from the API by providing the object.
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to delete meshes or mesh.
+
 404 : Not Found
    * Mesh data was not found.
 

diff --git a/docs/intro/getting_started_rest.rst b/docs/intro/getting_started_rest.rst
@@ -327,6 +327,9 @@ Example Result
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to create meshes or mesh.
+
 429 : Too many request
    * You have either hit your API or Database limit. Please review your account.
 
@@ -388,6 +391,9 @@ Example Result
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to update meshes or mesh.
+
 429 : Too many request
    * You have either hit your API or Database limit. Please review your account.
 
@@ -455,7 +461,10 @@ Example Result
 
 401 : Unauthorized
    * User is not authorized to make call.
-
+
+403 : Forbidden
+   * User has insufficent permission to read meshes or mesh.
+
 429 : Too many request
    * You have either hit your API or Database limit. Please review your account.
 
@@ -504,6 +513,9 @@ The example below shows deleting the data from the API by providing the object.
 401 : Unauthorized
    * User is not authorized to make call.
 
+403 : Forbidden
+   * User has insufficent permission to delete meshes or mesh.
+
 404 : Not Found
    * Mesh data was not found.