You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by kl...@apache.org on 2016/12/14 17:57:24 UTC
[09/50] [abbrv] geode git commit: GEODE-2004: [doc update] change to
a permission for REST-initiated queries. Updated error messages.
GEODE-2004: [doc update] change to a permission for REST-initiated queries. Updated error messages.
Project: http://git-wip-us.apache.org/repos/asf/geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/1d34eeb9
Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/1d34eeb9
Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/1d34eeb9
Branch: refs/heads/feature/GEODE-1930
Commit: 1d34eeb9f6217a4375590094166e5b81a820abae
Parents: 22ec6a7
Author: Dave Barnes <db...@pivotal.io>
Authored: Wed Dec 7 14:37:09 2016 -0800
Committer: Dave Barnes <db...@pivotal.io>
Committed: Wed Dec 7 14:37:09 2016 -0800
----------------------------------------------------------------------
.../rest_apps/delete_named_query.html.md.erb | 4 ++-
.../get_execute_adhoc_query.html.md.erb | 12 +++++++
geode-docs/rest_apps/get_queries.html.md.erb | 30 ++++++++++++++---
.../rest_apps/post_create_query.html.md.erb | 16 +++++++--
.../rest_apps/post_execute_query.html.md.erb | 18 +++++++++--
.../rest_apps/put_update_query.html.md.erb | 34 +++++++++++++++++---
6 files changed, 100 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/geode/blob/1d34eeb9/geode-docs/rest_apps/delete_named_query.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/rest_apps/delete_named_query.html.md.erb b/geode-docs/rest_apps/delete_named_query.html.md.erb
index ae109d6..d26ea36 100644
--- a/geode-docs/rest_apps/delete_named_query.html.md.erb
+++ b/geode-docs/rest_apps/delete_named_query.html.md.erb
@@ -54,7 +54,9 @@ Response Payload: application/json
| Status Code | Description |
|---------------------------|-----------------------------------------------------------------------------------------------|
-| 404 NOT FOUND | Query with specified ID could not be found. |
+| 401 UNAUTHORIZED | Invalid Username or Password |
+| 403 FORBIDDEN | Insufficient privileges for operation |
+| 404 NOT FOUND | Query with specified ID could not be found |
| 500 INTERNAL SERVER ERROR | Encountered error at server. Check the HTTP response body for a stack trace of the exception. |
http://git-wip-us.apache.org/repos/asf/geode/blob/1d34eeb9/geode-docs/rest_apps/get_execute_adhoc_query.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/rest_apps/get_execute_adhoc_query.html.md.erb b/geode-docs/rest_apps/get_execute_adhoc_query.html.md.erb
index 0a70c82..dc31407 100644
--- a/geode-docs/rest_apps/get_execute_adhoc_query.html.md.erb
+++ b/geode-docs/rest_apps/get_execute_adhoc_query.html.md.erb
@@ -103,10 +103,22 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
+<tr>
+<td>401 UNAUTHORIZED</td>
+<td>Invalid Username or Password</td>
+</tr>
+<tr>
+<td>403 FORBIDDEN</td>
+<td>Insufficient privileges for operation</td>
+</tr>
<tr class="odd">
<td>500 INTERNAL SERVER ERROR</td>
<td>Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. Some possible exceptions include:
<ul>
+<li>A function was applied to a parameter that is improper for that function!</li>
+<li>Bind parameter is not of the expected type!</li>
+<li>Name in the query cannot be resolved!</li>
+<li>The number of bound parameters does not match the number of placeholders!</li>
<li>Query is not permitted on this type of region!</li>
<li>Query execution time is exceeded max query execution time (gemfire.Cache.MAX_QUERY_EXECUTION_TIME) configured!</li>
<li>Data referenced in from clause is not available for querying!</li>
http://git-wip-us.apache.org/repos/asf/geode/blob/1d34eeb9/geode-docs/rest_apps/get_queries.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/rest_apps/get_queries.html.md.erb b/geode-docs/rest_apps/get_queries.html.md.erb
index 71e0219..ba86e55 100644
--- a/geode-docs/rest_apps/get_queries.html.md.erb
+++ b/geode-docs/rest_apps/get_queries.html.md.erb
@@ -65,8 +65,30 @@ Location: http://localhost:8080/gemfire-api/v1/queries
## Error Codes
-| � | � |
-|---------------------------|----------------------------------------------------------------------------------------------------------------------------------|
-| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. |
-
+<table>
+<colgroup>
+<col width="40%" />
+<col width="60%" />
+</colgroup>
+<thead>
+<tr class="header">
+<th>Status Code</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>401 UNAUTHORIZED</td>
+<td>Invalid Username or Password</td>
+</tr>
+<tr>
+<td>403 FORBIDDEN</td>
+<td>Insufficient privileges for operation</td>
+</tr>
+<tr class="even">
+<td>500 INTERNAL SERVER ERROR</td>
+<td>Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception.</td>
+</tr>
+</tbody>
+</table>
http://git-wip-us.apache.org/repos/asf/geode/blob/1d34eeb9/geode-docs/rest_apps/post_create_query.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/rest_apps/post_create_query.html.md.erb b/geode-docs/rest_apps/post_create_query.html.md.erb
index 9062948..9fdba2a 100644
--- a/geode-docs/rest_apps/post_create_query.html.md.erb
+++ b/geode-docs/rest_apps/post_create_query.html.md.erb
@@ -89,9 +89,21 @@ Location: http://localhost:8080/gemfire-api/v1/queries/selectOrders
</tr>
</thead>
<tbody>
-<tr class="odd">
+<tr>
<td>400 BAD REQUEST</td>
-<td>Returned if user does not specify a query ID or a malformed OQL statement.</td>
+<td>Query ID not specified or malformed OQL statement</td>
+</tr>
+<tr>
+<td>401 UNAUTHORIZED</td>
+<td>Invalid Username or Password</td>
+</tr>
+<tr>
+<td>403 FORBIDDEN</td>
+<td>Insufficient privileges for operation</td>
+</tr>
+<tr>
+<td>409 CONFLICT</td>
+<td>QueryId already assigned to another query</td>
</tr>
<tr class="even">
<td>500 INTERNAL SERVER ERROR</td>
http://git-wip-us.apache.org/repos/asf/geode/blob/1d34eeb9/geode-docs/rest_apps/post_execute_query.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/rest_apps/post_execute_query.html.md.erb b/geode-docs/rest_apps/post_execute_query.html.md.erb
index 7d0853c..f0557ba 100644
--- a/geode-docs/rest_apps/post_execute_query.html.md.erb
+++ b/geode-docs/rest_apps/post_execute_query.html.md.erb
@@ -146,9 +146,21 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
-<tr class="odd">
+<tr>
+<tr>
+<td>400 BAD REQUEST</td>
+<td>JSON document in the request body (specifying query bind params) is invalid</td>
+</tr>
+<td>401 UNAUTHORIZED</td>
+<td>Invalid Username or Password</td>
+</tr>
+<tr>
+<td>403 FORBIDDEN</td>
+<td>Insufficient privileges for operation</td>
+</tr>
+<tr>
<td>404 NOT FOUND</td>
-<td>Query with specified ID could not be found.</td>
+<td>Query with specified ID could not be found</td>
</tr>
<tr class="even">
<td>500 INTERNAL SERVER ERROR</td>
@@ -160,7 +172,7 @@ Content-Type: application/json
<li>Name in the query cannot be resolved!"</li>
<li>The number of bound parameters does not match the number of placeholders!</li>
<li>Query is not permitted on this type of region!</li>
-<li>Query execution time is exceeded max query execution time (gemfire.Cache.MAX_QUERY_EXECUTION_TIME) configured!</li>
+<li>Query execution time has exceeded max query execution time (gemfire.Cache.MAX_QUERY_EXECUTION_TIME) configured!</li>
<li>Data referenced in from clause is not available for querying!"</li>
<li>Query execution gets canceled due to low memory conditions and the resource manager critical heap percentage has been set!"</li>
<li>Error encountered while executing named query!"</li>
http://git-wip-us.apache.org/repos/asf/geode/blob/1d34eeb9/geode-docs/rest_apps/put_update_query.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/rest_apps/put_update_query.html.md.erb b/geode-docs/rest_apps/put_update_query.html.md.erb
index 966154a..339f4d7 100644
--- a/geode-docs/rest_apps/put_update_query.html.md.erb
+++ b/geode-docs/rest_apps/put_update_query.html.md.erb
@@ -73,10 +73,36 @@ Response Payload: null
## Error Codes
-| Status Code | Description |
-|---------------------------|----------------------------------------------------------------------------------------------------------------------------------|
-| 404 NOT FOUND | Returned if the specified queryId cannot be found. |
-| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. |
+<table>
+<colgroup>
+<col width="50%" />
+<col width="50%" />
+</colgroup>
+<thead>
+<tr class="header">
+<th>Status Code</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>401 UNAUTHORIZED</td>
+<td>Invalid Username or Password</td>
+</tr>
+<tr>
+<td>403 FORBIDDEN</td>
+<td>Insufficient privileges for operation</td>
+</tr>
+<tr>
+<td>404 NOT FOUND</td>
+<td>QueryID does not exist</td>
+</tr>
+<tr class="odd">
+<td>500 INTERNAL SERVER ERROR</td>
+<td>Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception.</td>
+</tr>
+</tbody>
+</table>
## Implementation Notes