GEODE-3395 Variable-ize product version and name in user guide - REST apps
Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/d291a457 Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/d291a457 Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/d291a457 Branch: refs/heads/feature/GEODE-1279 Commit: d291a457f5237b94f554047f33852b33d690a23a Parents: 9b7dd54 Author: Dave Barnes <[email protected]> Authored: Wed Aug 16 11:58:29 2017 -0700 Committer: Dave Barnes <[email protected]> Committed: Wed Aug 16 11:58:29 2017 -0700 ---------------------------------------------------------------------- geode-docs/rest_apps/book_intro.html.md.erb | 40 ++++++++++---------- .../rest_apps/chapter_overview.html.md.erb | 18 ++++----- .../rest_apps/delete_all_data.html.md.erb | 2 +- .../rest_apps/delete_data_for_key.html.md.erb | 2 +- .../delete_data_for_multiple_keys.html.md.erb | 2 +- .../rest_apps/develop_rest_apps.html.md.erb | 40 ++++++++++---------- .../get_execute_adhoc_query.html.md.erb | 4 +- geode-docs/rest_apps/get_functions.html.md.erb | 4 +- geode-docs/rest_apps/get_queries.html.md.erb | 2 +- .../rest_apps/get_region_data.html.md.erb | 2 +- .../rest_apps/get_region_key_data.html.md.erb | 2 +- .../rest_apps/get_region_keys.html.md.erb | 2 +- geode-docs/rest_apps/get_regions.html.md.erb | 2 +- geode-docs/rest_apps/get_servers.html.md.erb | 2 +- .../rest_apps/head_region_size.html.md.erb | 4 +- geode-docs/rest_apps/ping_service.html.md.erb | 2 +- .../rest_apps/post_create_query.html.md.erb | 2 +- .../post_execute_functions.html.md.erb | 2 +- .../rest_apps/post_if_absent_data.html.md.erb | 2 +- .../put_multiple_values_for_keys.html.md.erb | 2 +- .../rest_apps/put_replace_data.html.md.erb | 2 +- .../rest_apps/put_update_cas_data.html.md.erb | 2 +- .../rest_apps/put_update_data.html.md.erb | 2 +- .../rest_apps/put_update_query.html.md.erb | 2 +- geode-docs/rest_apps/rest_admin.html.md.erb | 4 +- .../rest_apps/rest_api_reference.html.md.erb | 14 +++---- geode-docs/rest_apps/rest_examples.html.md.erb | 6 +-- geode-docs/rest_apps/rest_functions.html.md.erb | 10 ++--- geode-docs/rest_apps/rest_prereqs.html.md.erb | 14 +++---- geode-docs/rest_apps/rest_queries.html.md.erb | 14 +++---- geode-docs/rest_apps/rest_regions.html.md.erb | 32 ++++++++-------- geode-docs/rest_apps/setup_config.html.md.erb | 16 ++++---- .../rest_apps/troubleshooting.html.md.erb | 8 ++-- geode-docs/rest_apps/using_swagger.html.md.erb | 10 ++--- 34 files changed, 134 insertions(+), 140 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/book_intro.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/book_intro.html.md.erb b/geode-docs/rest_apps/book_intro.html.md.erb index c909dc7..b8b6596 100644 --- a/geode-docs/rest_apps/book_intro.html.md.erb +++ b/geode-docs/rest_apps/book_intro.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Developing REST Applications for Apache Geode ---- +<% set_title("Developing REST Applications for", product_name_long) %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -19,41 +17,41 @@ See the License for the specific language governing permissions and limitations under the License. --> -*Developing REST Applications for Apache Geode* provides background and instructions on how to program REST applications with Apache Geode. Geode REST APIs allow you to access region data, queries and functions in your Geode deployment in wide variety of programming languages. +*Developing REST Applications for <%=vars.product_name_long%>* provides background and instructions on how to program REST applications with <%=vars.product_name_long%>. <%=vars.product_name%> REST APIs allow you to access region data, queries and functions in your <%=vars.product_name%> deployment in wide variety of programming languages. **Note:** -This documentation covers the **v1** release of Geode REST APIs for developing applications. +This documentation covers the **v1** release of <%=vars.product_name%> REST APIs for developing applications. -- **[Geode REST API Overview](../rest_apps/chapter_overview.html)** +- **[<%=vars.product_name%> REST API Overview](chapter_overview.html)** - By using the Geode REST application interface, you can immediately access Geode's data management capabilities in languages other than the natively supported Java language. + By using the <%=vars.product_name%> REST application interface, you can immediately access <%=vars.product_name%>'s data management capabilities in languages other than the natively supported Java language. -- **[Prerequisites and Limitations for Writing REST Applications](../rest_apps/rest_prereqs.html)** +- **[Prerequisites and Limitations for Writing REST Applications](rest_prereqs.html)** - Before development, understand the prerequisites and limitations of the current REST implementation in Geode. + Before development, understand the prerequisites and limitations of the current REST implementation in <%=vars.product_name%>. -- **[Setup and Configuration](../rest_apps/setup_config.html)** +- **[Setup and Configuration](setup_config.html)** - The Apache Geode developer REST interface runs as an embedded HTTP or HTTPS service (Jetty server) within a Geode data node. + The <%=vars.product_name_long%> developer REST interface runs as an embedded HTTP or HTTPS service (Jetty server) within a <%=vars.product_name%> data node. -- **[Using the Swagger UI to Browse REST APIs](../rest_apps/using_swagger.html)** +- **[Using the Swagger UI to Browse REST APIs](using_swagger.html)** - Apache Geode Developer REST APIs are integrated with the Swagger⢠framework. This framework provides a browser-based test client that allows you to visualize and try out Geode REST APIs. + <%=vars.product_name_long%> Developer REST APIs are integrated with the Swagger⢠framework. This framework provides a browser-based test client that allows you to visualize and try out <%=vars.product_name%> REST APIs. -- **[Developing REST Applications](../rest_apps/develop_rest_apps.html)** +- **[Developing REST Applications](develop_rest_apps.html)** - This section provides guidelines on writing REST client applications for Geode. + This section provides guidelines on writing REST client applications for <%=vars.product_name%>. -- **[Sample REST Applications](../rest_apps/rest_examples.html)** +- **[Sample REST Applications](rest_examples.html)** - This section provides examples that illustrate how multiple clients, both REST and native, can access the same Geode region data. + This section provides examples that illustrate how multiple clients, both REST and native, can access the same <%=vars.product_name%> region data. -- **[Troubleshooting and FAQ](../rest_apps/troubleshooting.html)** +- **[Troubleshooting and FAQ](troubleshooting.html)** - This section provides troubleshooting guidance and frequently asked questions about Geode Developer REST APIs. + This section provides troubleshooting guidance and frequently asked questions about <%=vars.product_name%> Developer REST APIs. -- **[Apache Geode REST API Reference](../rest_apps/rest_api_reference.html)** +- **[<%=vars.product_name_long%> REST API Reference](rest_api_reference.html)** - This section summarizes all available Apache Geode REST API resources and endpoints. + This section summarizes all available <%=vars.product_name_long%> REST API resources and endpoints. http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/chapter_overview.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/chapter_overview.html.md.erb b/geode-docs/rest_apps/chapter_overview.html.md.erb index 8f29c08..5eec90f 100644 --- a/geode-docs/rest_apps/chapter_overview.html.md.erb +++ b/geode-docs/rest_apps/chapter_overview.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Geode REST API Overview ---- +<% set_title(product_name, "REST API Overview") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -19,23 +17,23 @@ See the License for the specific language governing permissions and limitations under the License. --> -By using the Geode REST application interface, you can immediately access Geode's data management capabilities in languages other than the natively supported Java language. +By using the <%=vars.product_name%> REST application interface, you can immediately access <%=vars.product_name%>'s data management capabilities in languages other than the natively supported Java language. -You can write REST-enabled client applications for Geode in a variety of languages that use the open +You can write REST-enabled client applications for <%=vars.product_name%> in a variety of languages that use the open and standard HTTP protocol—for example, Ruby, Python, JavaScript and Scala—as well as already supported languages such as Java. -When you access Geode through the REST interface, objects are stored in Geode as PdxInstances. A PdxInstance is a light-weight wrapper around PDX serialized bytes. It provides applications with run-time access to fields of a PDX serialized object. This interoperable format allows your Java applications to operate on the same data as your REST applications. +When you access <%=vars.product_name%> through the REST interface, objects are stored in <%=vars.product_name%> as PdxInstances. A PdxInstance is a light-weight wrapper around PDX serialized bytes. It provides applications with run-time access to fields of a PDX serialized object. This interoperable format allows your Java applications to operate on the same data as your REST applications. -As an added benefit, because Geode's REST interface stores objects as PdxInstances, you do not need +As an added benefit, because <%=vars.product_name%>'s REST interface stores objects as PdxInstances, you do not need to write corresponding Java classes to translate JSON data (which you must do with other REST interface providers such as Oracle Coherence). For example, consider the use case where a non-Java -REST client application (Python, Ruby or Scala) performs Geode region operations with JSON data that -represents employee data. Since the object is stored in Geode as a PdxInstance that can be +REST client application (Python, Ruby or Scala) performs <%=vars.product_name%> region operations with JSON data that +represents employee data. Since the object is stored in <%=vars.product_name%> as a PdxInstance that can be automatically mapped to JSON, the user does not need to write a corresponding Employee.java class and also does not need to worry about related issues such as keeping the Employee object in the CLASSPATH. -See [Geode PDX Serialization](../developing/data_serialization/gemfire_pdx_serialization.html#gemfire_pdx_serialization) for more information on PDX serialization. +See [<%=vars.product_name%> PDX Serialization](../developing/data_serialization/gemfire_pdx_serialization.html#gemfire_pdx_serialization) for more information on PDX serialization. http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/delete_all_data.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/delete_all_data.html.md.erb b/geode-docs/rest_apps/delete_all_data.html.md.erb index a7a7e1a..32ea8eb 100644 --- a/geode-docs/rest_apps/delete_all_data.html.md.erb +++ b/geode-docs/rest_apps/delete_all_data.html.md.erb @@ -51,6 +51,6 @@ Response Payload: null | Status Code | Description | |---------------------------|----------------------------------------------------------------------------------------------------------------------------------| | 404 NOT FOUND | Returned if the region is not found. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | +| 500 INTERNAL SERVER ERROR | Error encountered at <%=vars.product_name%> server. Check the HTTP response body for a stack trace of the exception. | http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/delete_data_for_key.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/delete_data_for_key.html.md.erb b/geode-docs/rest_apps/delete_data_for_key.html.md.erb index 339942e..1c5f4a7 100644 --- a/geode-docs/rest_apps/delete_data_for_key.html.md.erb +++ b/geode-docs/rest_apps/delete_data_for_key.html.md.erb @@ -51,6 +51,6 @@ Response Payload: null | Status Code | Description | |---------------------------|----------------------------------------------------------------------------------------------------------------------------------| | 404 NOT FOUND | Returned if the region or specified key is not found. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | +| 500 INTERNAL SERVER ERROR | Error encountered at <%=vars.product_name%> server. Check the HTTP response body for a stack trace of the exception. | http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/delete_data_for_multiple_keys.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/delete_data_for_multiple_keys.html.md.erb b/geode-docs/rest_apps/delete_data_for_multiple_keys.html.md.erb index 8a7071d..1c4016b 100644 --- a/geode-docs/rest_apps/delete_data_for_multiple_keys.html.md.erb +++ b/geode-docs/rest_apps/delete_data_for_multiple_keys.html.md.erb @@ -51,6 +51,6 @@ Response Payload: null | Status Code | Description | |---------------------------|----------------------------------------------------------------------------------------------------------------------------------| | 404 NOT FOUND | Returned if either the region or one or more of the specified keys is not found. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | +| 500 INTERNAL SERVER ERROR | Error encountered at <%=vars.product_name%> server. Check the HTTP response body for a stack trace of the exception. | http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/develop_rest_apps.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/develop_rest_apps.html.md.erb b/geode-docs/rest_apps/develop_rest_apps.html.md.erb index d48dcb1..336488f 100644 --- a/geode-docs/rest_apps/develop_rest_apps.html.md.erb +++ b/geode-docs/rest_apps/develop_rest_apps.html.md.erb @@ -21,33 +21,33 @@ limitations under the License. <a id="topic_lvp_cd5_m4"></a> -This section provides guidelines on writing REST client applications for Geode. +This section provides guidelines on writing REST client applications for <%=vars.product_name%>. -You can browse, query, update and delete data stored in your Geode deployment. You can also manage and execute pre-deployed functions on Geode members. +You can browse, query, update and delete data stored in your <%=vars.product_name%> deployment. You can also manage and execute pre-deployed functions on <%=vars.product_name%> members. -- **[Working with Regions](../rest_apps/develop_rest_apps.html#topic_qhs_f25_m4)** +- **[Working with Regions](#topic_qhs_f25_m4)** - The Geode REST APIs provide basic CRUD (create, read, update and delete) operations for data entries stored in your regions. + The <%=vars.product_name%> REST APIs provide basic CRUD (create, read, update and delete) operations for data entries stored in your regions. -- **[Working with Queries](../rest_apps/develop_rest_apps.html#topic_fcn_g25_m4)** +- **[Working with Queries](#topic_fcn_g25_m4)** - Geode supports the use of queries to extract data from its regions. Using REST APIs, you can create and execute either prepared or ad-hoc queries on Geode regions. You can also update and delete prepared queries. + <%=vars.product_name%> supports the use of queries to extract data from its regions. Using REST APIs, you can create and execute either prepared or ad-hoc queries on <%=vars.product_name%> regions. You can also update and delete prepared queries. -- **[Working with Functions](../rest_apps/develop_rest_apps.html#topic_rbc_h25_m4)** +- **[Working with Functions](#topic_rbc_h25_m4)** - Geode REST APIs support the discovery and execution of predefined Geode functions on your cluster deployments. + <%=vars.product_name%> REST APIs support the discovery and execution of predefined <%=vars.product_name%> functions on your cluster deployments. ## <a id="topic_qhs_f25_m4" class="no-quick-link"></a>Working with Regions -The Geode REST APIs provide basic CRUD (create, read, update and delete) operations for data entries stored in your regions. +The <%=vars.product_name%> REST APIs provide basic CRUD (create, read, update and delete) operations for data entries stored in your regions. -Regions are the resources of the Geode REST API. Each region represents a resource or a collection of resources. +Regions are the resources of the <%=vars.product_name%> REST API. Each region represents a resource or a collection of resources. -You cannot create or delete the regions themselves with the REST APIs, but you can work with the data stored within predefined Geode regions. Use the [gfsh](../tools_modules/gfsh/chapter_overview.html) command utility to add, configure or delete regions in your Geode deployment. Any additions or modifications to regions made through `gfsh` are then accessible by the REST APIs. +You cannot create or delete the regions themselves with the REST APIs, but you can work with the data stored within predefined <%=vars.product_name%> regions. Use the [gfsh](../tools_modules/gfsh/chapter_overview.html) command utility to add, configure or delete regions in your <%=vars.product_name%> deployment. Any additions or modifications to regions made through `gfsh` are then accessible by the REST APIs. ## Listing Available Regions -The main resource endpoint to the Geode API is [GET /gemfire-api/v1](get_regions.html#topic_itv_mg5_m4). Use this endpoint to discover which regions are available in your cluster. +The main resource endpoint to the <%=vars.product_name%> API is [GET /gemfire-api/v1](get_regions.html#topic_itv_mg5_m4). Use this endpoint to discover which regions are available in your cluster. Example call: @@ -307,7 +307,7 @@ Accept: application/json **Modifying existing entries** -Geode provides three different options for this type of operation. To update a value for the key, you can use: +<%=vars.product_name%> provides three different options for this type of operation. To update a value for the key, you can use: ``` pre PUT /gemfire/v1/{region}/{key} @@ -438,7 +438,7 @@ If any of the supplied keys are not found in the region, the request will fail a ## <a id="topic_fcn_g25_m4" class="no-quick-link"></a>Working with Queries -Geode supports the use of queries to extract data from its regions. Using REST APIs, you can create and execute either prepared or ad-hoc queries on Geode regions. You can also update and delete prepared queries. +<%=vars.product_name%> supports the use of queries to extract data from its regions. Using REST APIs, you can create and execute either prepared or ad-hoc queries on <%=vars.product_name%> regions. You can also update and delete prepared queries. ## Listing Queries @@ -448,7 +448,7 @@ To find out which predefined and named queries are available in your deployment, GET /gemfire-api/v1/queries ``` -All queries that have been predefined and assigned IDs in Geode are listed. +All queries that have been predefined and assigned IDs in <%=vars.product_name%> are listed. ## <a id="topic_fcn_g25_m4__section_t4h_wtp_y4" class="no-quick-link"></a>Creating a New Query @@ -623,18 +623,18 @@ http://localhost:7070/gemfire-api/v1/queries/adhoc?q="SELECT * FROM /customers" ## <a id="topic_rbc_h25_m4" class="no-quick-link"></a>Working with Functions -Geode REST APIs support the discovery and execution of predefined Geode functions on your cluster deployments. +<%=vars.product_name%> REST APIs support the discovery and execution of predefined <%=vars.product_name%> functions on your cluster deployments. -Before you can access functions using REST APIs, you must have already defined and registered the functions in your Geode deployment. Additionally, any domain objects that are being accessed by the functions must be available on the CLASSPATH of the server running the REST endpoint service. +Before you can access functions using REST APIs, you must have already defined and registered the functions in your <%=vars.product_name%> deployment. Additionally, any domain objects that are being accessed by the functions must be available on the CLASSPATH of the server running the REST endpoint service. You can do the following with functions: -- List all functions available in the Geode cluster. +- List all functions available in the <%=vars.product_name%> cluster. - Execute a function, optionally specifying the region and members and/or member groups that are targeted by the function ## Listing Functions -To list all functions that are currently registered and deployed in the Geode cluster, use the following endpoint: +To list all functions that are currently registered and deployed in the <%=vars.product_name%> cluster, use the following endpoint: ``` pre GET /gemfire-api/v1/functions @@ -644,7 +644,7 @@ The list of returned functions includes the functionId, which you can use to exe ## Executing Functions -To execute a function on a Geode cluster, use the following endpoint: +To execute a function on a <%=vars.product_name%> cluster, use the following endpoint: ``` pre POST /gemfire-api/v1/functions/{functionId}?[&onRegion=regionname|&onMembers=member1,member2,...,memberN|&onGroups=group1,group2,...,groupN] http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/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 dc31407..5d13c45 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 @@ -113,7 +113,7 @@ Content-Type: application/json </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: +<td>Error encountered at <%=vars.product_name%> 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> @@ -123,7 +123,7 @@ Content-Type: application/json <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> <li>Query execution gets canceled due to low memory conditions and the resource manager critical heap percentage has been set!</li> -<li>Server has encountered while executing Adhoc query!</li> +<li>Server has encountered an error while executing Adhoc query!</li> </ul></td> </tr> </tbody> http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/get_functions.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/get_functions.html.md.erb b/geode-docs/rest_apps/get_functions.html.md.erb index 9ae6867..3fa54a1 100644 --- a/geode-docs/rest_apps/get_functions.html.md.erb +++ b/geode-docs/rest_apps/get_functions.html.md.erb @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -List all registered Geode functions in the cluster. +List all registered <%=vars.product_name%> functions in the cluster. ## Resource URL @@ -62,6 +62,6 @@ Location: https://localhost:8080/gemfire-api/v1/functions | Status Code | Description | |---------------------------|----------------------------------------------------------------------------------------------------------------------------------| | 404 NOT FOUND | Returned if no functions are found in the cluster. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | +| 500 INTERNAL SERVER ERROR | Error encountered at <%=vars.product_name%> server. Check the HTTP response body for a stack trace of the exception. | http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/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 ba86e55..54ff487 100644 --- a/geode-docs/rest_apps/get_queries.html.md.erb +++ b/geode-docs/rest_apps/get_queries.html.md.erb @@ -87,7 +87,7 @@ Location: http://localhost:8080/gemfire-api/v1/queries </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> +<td>Error encountered at <%=vars.product_name%> 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/d291a457/geode-docs/rest_apps/get_region_data.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/get_region_data.html.md.erb b/geode-docs/rest_apps/get_region_data.html.md.erb index 4cae9cd..1a20d4d 100644 --- a/geode-docs/rest_apps/get_region_data.html.md.erb +++ b/geode-docs/rest_apps/get_region_data.html.md.erb @@ -129,4 +129,4 @@ Date: Sat, 18 Jan 2014 21:03:08 GMT |--------------------|----------------------------------------------------------------------------------------------------------------------------------| | 400 BAD REQUEST | Limit parameter **X** is not valid! The specified limit value must be ALL or an integer. | | 404 NOT FOUND | Returned if region does not exist. | -| 500 INTERNAL ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | +| 500 INTERNAL ERROR | Error encountered at <%=vars.product_name%> server. Check the HTTP response body for a stack trace of the exception. | http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/get_region_key_data.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/get_region_key_data.html.md.erb b/geode-docs/rest_apps/get_region_key_data.html.md.erb index fce7501..e8cbb7e 100644 --- a/geode-docs/rest_apps/get_region_key_data.html.md.erb +++ b/geode-docs/rest_apps/get_region_key_data.html.md.erb @@ -84,4 +84,4 @@ Date: Sat, 18 Jan 2014 21:27:59 GMT |---------------------------|-----------------------------------------------------------------------------------------------------| | 400 BAD REQUEST | Returned if the supplied key is not found in the region. | | 404 NOT FOUND | Returned if the region or specified key is not found. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | +| 500 INTERNAL SERVER ERROR | Error encountered at <%=vars.product_name%> server. Check the HTTP response body for a stack trace of the exception. | http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/get_region_keys.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/get_region_keys.html.md.erb b/geode-docs/rest_apps/get_region_keys.html.md.erb index fa7bbd0..1d50da3 100644 --- a/geode-docs/rest_apps/get_region_keys.html.md.erb +++ b/geode-docs/rest_apps/get_region_keys.html.md.erb @@ -62,6 +62,6 @@ Date: Sat, 18 Jan 2014 21:20:05 GMT |---------------------------|----------------------------------------------------------------------------------------------------------------------------------| | 404 NOT FOUND | Specified region does not exist. | | 405 METHOD NOT ALLOWED | Returned if any HTTP request method other than GET (for example, POST, PUT, DELETE, etc.) is used. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | +| 500 INTERNAL SERVER ERROR | Error encountered at <%=vars.product_name%> server. Check the HTTP response body for a stack trace of the exception. | http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/get_regions.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/get_regions.html.md.erb b/geode-docs/rest_apps/get_regions.html.md.erb index b8e6add..fee8e11 100644 --- a/geode-docs/rest_apps/get_regions.html.md.erb +++ b/geode-docs/rest_apps/get_regions.html.md.erb @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -List all available resources (regions) in the Geode cluster. +List all available resources (regions) in the <%=vars.product_name%> cluster. ## Resource URL http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/get_servers.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/get_servers.html.md.erb b/geode-docs/rest_apps/get_servers.html.md.erb index 1ac585f..efc4205 100644 --- a/geode-docs/rest_apps/get_servers.html.md.erb +++ b/geode-docs/rest_apps/get_servers.html.md.erb @@ -59,6 +59,6 @@ Content-Type: application/json; charset=utf-8 | Status Code | Description | |---------------------------|---------------------------------------------------------------------------------------------| -| 500 INTERNAL SERVER ERROR | Returned if Geode throws an error while executing the request. | +| 500 INTERNAL SERVER ERROR | Returned if <%=vars.product_name%> throws an error while executing the request. | http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/head_region_size.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/head_region_size.html.md.erb b/geode-docs/rest_apps/head_region_size.html.md.erb index 3a83bb6..c332d07 100644 --- a/geode-docs/rest_apps/head_region_size.html.md.erb +++ b/geode-docs/rest_apps/head_region_size.html.md.erb @@ -55,8 +55,8 @@ Resource-Count: 8192 | Status Code | Description | |---------------------------|---------------------------------------------------------------------------------------------| -| 400 Bad Request | Returned if Geode throws an error while executing the request. | +| 400 Bad Request | Returned if <%=vars.product_name%> throws an error while executing the request. | | 404 Resource Not Found | Region does not exist. | -| 500 Internal Server Error | Geode has thown an error or exception. | +| 500 Internal Server Error | <%=vars.product_name%> has thown an error or exception. | http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/ping_service.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/ping_service.html.md.erb b/geode-docs/rest_apps/ping_service.html.md.erb index d6339e3..690aad9 100644 --- a/geode-docs/rest_apps/ping_service.html.md.erb +++ b/geode-docs/rest_apps/ping_service.html.md.erb @@ -49,6 +49,6 @@ GET /gemfire/v1/ping | Status Code | Description | |---------------------------|--------------------------------------------------------------------------------------------| | 404 NOT FOUND | The Developer REST API service is not available. | -| 500 INTERNAL SERVER ERROR | Encountered error at server. Check the Geode exception trace. | +| 500 INTERNAL SERVER ERROR | Encountered error at server. Check the <%=vars.product_name%> exception trace. | http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/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 9fdba2a..4e3b3a0 100644 --- a/geode-docs/rest_apps/post_create_query.html.md.erb +++ b/geode-docs/rest_apps/post_create_query.html.md.erb @@ -107,7 +107,7 @@ Location: http://localhost:8080/gemfire-api/v1/queries/selectOrders </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>Error encountered at <%=vars.product_name%> server. Check the HTTP response body for a stack trace of the exception. <ul> <li>Query store does not exist!</li> </ul></td> http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/post_execute_functions.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/post_execute_functions.html.md.erb b/geode-docs/rest_apps/post_execute_functions.html.md.erb index 32d8cd7..816d8fc 100644 --- a/geode-docs/rest_apps/post_execute_functions.html.md.erb +++ b/geode-docs/rest_apps/post_execute_functions.html.md.erb @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -Execute Geode function on entire cluster or on a specified region, members and member groups. +Execute <%=vars.product_name%> function on entire cluster or on a specified region, members and member groups. ## Resource URL http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/post_if_absent_data.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/post_if_absent_data.html.md.erb b/geode-docs/rest_apps/post_if_absent_data.html.md.erb index 89925e3..7c4c347 100644 --- a/geode-docs/rest_apps/post_if_absent_data.html.md.erb +++ b/geode-docs/rest_apps/post_if_absent_data.html.md.erb @@ -105,7 +105,7 @@ Location: http://localhost:8080/gemfire-api/v1/orders/2 | 400 BAD REQUEST | Returned if JSON content is malformed. | | 404 NOT FOUND | Returned if the specified region does not exist. | | 409 CONFLICT | Returned if the provided key already exists in the region. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | +| 500 INTERNAL SERVER ERROR | Error encountered at <%=vars.product_name%> server. Check the HTTP response body for a stack trace of the exception. | ## Example Error Response http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/put_multiple_values_for_keys.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/put_multiple_values_for_keys.html.md.erb b/geode-docs/rest_apps/put_multiple_values_for_keys.html.md.erb index e0e0c03..1c305dd 100644 --- a/geode-docs/rest_apps/put_multiple_values_for_keys.html.md.erb +++ b/geode-docs/rest_apps/put_multiple_values_for_keys.html.md.erb @@ -101,4 +101,4 @@ Response-payload: null | 400 BAD REQUEST | Returned if one or more of the supplied keys is an invalid format. | | 404 NOT FOUND | Returned if the region is not found. | | 414 REQUEST URI TOO LONG | Returned if the URI is longer than the system component can handle. Limiting the size to 2000 bytes will work for most components. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | +| 500 INTERNAL SERVER ERROR | Error encountered at <%=vars.product_name%> server. Check the HTTP response body for a stack trace of the exception. | http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/put_replace_data.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/put_replace_data.html.md.erb b/geode-docs/rest_apps/put_replace_data.html.md.erb index 323ce0c..12e8dd6 100644 --- a/geode-docs/rest_apps/put_replace_data.html.md.erb +++ b/geode-docs/rest_apps/put_replace_data.html.md.erb @@ -80,4 +80,4 @@ Response Payload: null |---------------------------|----------------------------------------------------------------------------------------------------------------------------------| | 400 BAD REQUEST | Returned if the supplied key is not present in the region. | | 404 NOT FOUND | Returned if the region is not found. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | +| 500 INTERNAL SERVER ERROR | Error encountered at <%=vars.product_name%> server. Check the HTTP response body for a stack trace of the exception. | http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/put_update_cas_data.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/put_update_cas_data.html.md.erb b/geode-docs/rest_apps/put_update_cas_data.html.md.erb index 05360af..d900055 100644 --- a/geode-docs/rest_apps/put_update_cas_data.html.md.erb +++ b/geode-docs/rest_apps/put_update_cas_data.html.md.erb @@ -177,7 +177,7 @@ Response Payload: null | 400 BAD REQUEST | Returned if the supplied key is not present in the region. | | 404 NOT FOUND | Returned if the region is not found. | | 409 CONFLICT | Returned if the provided @old value of the key does not match the current value of the key. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | +| 500 INTERNAL SERVER ERROR | Error encountered at <%=vars.product_name%> server. Check the HTTP response body for a stack trace of the exception. | ## Example Error Response http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/put_update_data.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/put_update_data.html.md.erb b/geode-docs/rest_apps/put_update_data.html.md.erb index d6c68c4..9285e0e 100644 --- a/geode-docs/rest_apps/put_update_data.html.md.erb +++ b/geode-docs/rest_apps/put_update_data.html.md.erb @@ -75,7 +75,7 @@ Response Payload: null |---------------------------|----------------------------------------------------------------------------------------------------------------------------------| | 400 BAD REQUEST | Returned if supplied key is an invalid format. | | 404 NOT FOUND | Returned if the region is not found. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | +| 500 INTERNAL SERVER ERROR | Error encountered at <%=vars.product_name%> server. Check the HTTP response body for a stack trace of the exception. | ## Implementation Notes http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/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 339f4d7..c96e14e 100644 --- a/geode-docs/rest_apps/put_update_query.html.md.erb +++ b/geode-docs/rest_apps/put_update_query.html.md.erb @@ -99,7 +99,7 @@ Response Payload: null </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> +<td>Error encountered at <%=vars.product_name%> 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/d291a457/geode-docs/rest_apps/rest_admin.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/rest_admin.html.md.erb b/geode-docs/rest_apps/rest_admin.html.md.erb index 527a835..9d6cbd5 100644 --- a/geode-docs/rest_apps/rest_admin.html.md.erb +++ b/geode-docs/rest_apps/rest_admin.html.md.erb @@ -21,11 +21,11 @@ limitations under the License. Administrative endpoints provide management and monitoring functionality for the REST API interface. -- **[\[HEAD | GET\] /gemfire-api/v1/ping](../rest_apps/ping_service.html)** +- **[\[HEAD | GET\] /gemfire-api/v1/ping](ping_service.html)** Mechanism to check for REST API server and service availability. -- **[GET /gemfire-api/v1/servers](../rest_apps/get_servers.html)** +- **[GET /gemfire-api/v1/servers](get_servers.html)** Mechanism to obtain a list of all members in the distributed system that are running the REST API service. http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/rest_api_reference.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/rest_api_reference.html.md.erb b/geode-docs/rest_apps/rest_api_reference.html.md.erb index 15f75e5..d39aba5 100644 --- a/geode-docs/rest_apps/rest_api_reference.html.md.erb +++ b/geode-docs/rest_apps/rest_api_reference.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Apache Geode REST API Reference ---- +<% set_title(product_name_long, "REST API Reference") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -19,22 +17,22 @@ See the License for the specific language governing permissions and limitations under the License. --> -This section summarizes all available Apache Geode REST API resources and endpoints. +This section summarizes all available <%=vars.product_name_long%> REST API resources and endpoints. **Note:** -This documentation covers the **v1** release of Geode REST APIs for developing applications. +This documentation covers the **v1** release of <%=vars.product_name%> REST APIs for developing applications. - **[Region Endpoints](rest_regions.html)** - A Geode region is how Geode logically groups data within its cache. Regions stores data as entries, which are key-value pairs. Using the REST APIs you can read, add (or update), and delete region data. + A <%=vars.product_name%> region is how <%=vars.product_name%> logically groups data within its cache. Regions stores data as entries, which are key-value pairs. Using the REST APIs you can read, add (or update), and delete region data. - **[Query Endpoints](rest_queries.html)** - Geode uses a query syntax based on OQL (Object Query Language) to query region data. Since Geode regions are key-value stores, values can range from simple byte arrays to complex nested objects. + <%=vars.product_name%> uses a query syntax based on OQL (Object Query Language) to query region data. Since <%=vars.product_name%> regions are key-value stores, values can range from simple byte arrays to complex nested objects. - **[Function Endpoints](rest_functions.html)** - Geode functions allows you to write and execute server-side transactions and data operations. These may include anything ranging from initializing components or third-party services or aggregating data. + <%=vars.product_name%> functions allows you to write and execute server-side transactions and data operations. These may include anything ranging from initializing components or third-party services or aggregating data. - **[Administrative Endpoints](rest_admin.html)** http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/rest_examples.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/rest_examples.html.md.erb b/geode-docs/rest_apps/rest_examples.html.md.erb index afa4f70..e40393d 100644 --- a/geode-docs/rest_apps/rest_examples.html.md.erb +++ b/geode-docs/rest_apps/rest_examples.html.md.erb @@ -22,7 +22,7 @@ limitations under the License. <a id="topic_lvp_cd5_m4"></a> -This section provides examples that illustrate how multiple clients, both REST and native, can access the same Geode region data. +This section provides examples that illustrate how multiple clients, both REST and native, can access the same <%=vars.product_name%> region data. **Note:** You must set PDX read-serialized to true when starting the cache server to achieve interoperability between different clients. See [Setup and Configuration](setup_config.html#topic_e21_qc5_m4) for instructions on starting up REST-enabled cache servers. @@ -30,7 +30,7 @@ You must set PDX read-serialized to true when starting the cache server to achie The following examples demonstrate the following: 1. A Java REST client creates a Person object on key 1. This client references the following supporting examples (also provided): - 1. Geode cache client + 1. <%=vars.product_name%> cache client 2. REST client utility 3. Date Time utility 4. Person class @@ -109,7 +109,7 @@ package org.apache.geode.restclient; } ``` -## \#1a. Geode Cache Java Client (MyJavaClient.java) +## \#1a. <%=vars.product_name%> Cache Java Client (MyJavaClient.java) ``` pre package org.apache.geode.javaclient; http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/rest_functions.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/rest_functions.html.md.erb b/geode-docs/rest_apps/rest_functions.html.md.erb index f7ad25c..3f5c4fb 100644 --- a/geode-docs/rest_apps/rest_functions.html.md.erb +++ b/geode-docs/rest_apps/rest_functions.html.md.erb @@ -19,14 +19,14 @@ See the License for the specific language governing permissions and limitations under the License. --> -Geode functions allows you to write and execute server-side transactions and data operations. These may include anything ranging from initializing components or third-party services or aggregating data. +<%=vars.product_name%> functions allows you to write and execute server-side transactions and data operations. These may include anything ranging from initializing components or third-party services or aggregating data. -- **[GET /gemfire-api/v1/functions](../rest_apps/get_functions.html)** +- **[GET /gemfire-api/v1/functions](get_functions.html)** - List all registered Geode functions in the cluster. + List all registered <%=vars.product_name%> functions in the cluster. -- **[POST /gemfire-api/v1/functions/{functionId}](../rest_apps/post_execute_functions.html)** +- **[POST /gemfire-api/v1/functions/{functionId}](post_execute_functions.html)** - Execute Geode function on entire cluster or on a specified region, members and member groups. + Execute <%=vars.product_name%> function on entire cluster or on a specified region, members and member groups. http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/rest_prereqs.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/rest_prereqs.html.md.erb b/geode-docs/rest_apps/rest_prereqs.html.md.erb index 55fe050..08c0f4d 100644 --- a/geode-docs/rest_apps/rest_prereqs.html.md.erb +++ b/geode-docs/rest_apps/rest_prereqs.html.md.erb @@ -19,17 +19,17 @@ See the License for the specific language governing permissions and limitations under the License. --> -Before development, it is important to understand the prerequisites and limitations of the Geode REST implementation. +Before development, it is important to understand the prerequisites and limitations of the <%=vars.product_name%> REST implementation. -Geode and REST-enabled applications accessing Geode are subject to the following rules and limitations: +<%=vars.product_name%> and REST-enabled applications accessing <%=vars.product_name%> are subject to the following rules and limitations: -- All domain objects, functions and function-arg classes must be properly configured and registered in the Geode deployment. Any functions that you wish to execute through the REST API must be available on the target memberâs CLASSPATH. +- All domain objects, functions and function-arg classes must be properly configured and registered in the <%=vars.product_name%> deployment. Any functions that you wish to execute through the REST API must be available on the target memberâs CLASSPATH. - The current implementation supports only the **application/json** MIME type. Other return types (XML, objects, and so on) are not supported. Plain text is supported as a return type for some error messages. - Keys are strictly of type String. For example, the request `PUT http://localhost:8080/gemfire-api/v1/customers/123.456` will add an entry for key ("123.456") of type String. -- Some special formats of JSON documents are not supported in Geode REST. See [Key Types and JSON Support](troubleshooting.html#concept_gsv_zd5_m4) for examples. -- To achieve interoperability between Geode Java clients (or Geode native clients) and REST clients, the following rules must be followed: - - All Geode Java and native client classes operating on data also accessed by the REST interface must be PDX serialized, either via PDX autoserialization or by implementing `PdxSerializable`. - - Geode Java clients and native clients can retrieve REST-enabled data either as a `PdxInstance` or as an actual object by using the `PdxInstance.getObject` method. If you use the latter method, you must first declare the object type (@type) in your POST or PUT request payload when creating the object in REST; and secondly, the Java client must have the actual domain class in its CLASSPATH. +- Some special formats of JSON documents are not supported in <%=vars.product_name%> REST. See [Key Types and JSON Support](troubleshooting.html#concept_gsv_zd5_m4) for examples. +- To achieve interoperability between <%=vars.product_name%> Java clients (or <%=vars.product_name%> native clients) and REST clients, the following rules must be followed: + - All <%=vars.product_name%> Java and native client classes operating on data also accessed by the REST interface must be PDX serialized, either via PDX autoserialization or by implementing `PdxSerializable`. + - <%=vars.product_name%> Java clients and native clients can retrieve REST-enabled data either as a `PdxInstance` or as an actual object by using the `PdxInstance.getObject` method. If you use the latter method, you must first declare the object type (@type) in your POST or PUT request payload when creating the object in REST; and secondly, the Java client must have the actual domain class in its CLASSPATH. - Objects returned by REST-invoked functions must be returned as PdxInstance objects or other data types that can be written to JSON. You cannot return Java objects. - REST client applications do not support single hop access or notification features. - Specifying subregions as endpoints is not supported. http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/rest_queries.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/rest_queries.html.md.erb b/geode-docs/rest_apps/rest_queries.html.md.erb index 529d5f4..cf1de3e 100644 --- a/geode-docs/rest_apps/rest_queries.html.md.erb +++ b/geode-docs/rest_apps/rest_queries.html.md.erb @@ -19,29 +19,29 @@ See the License for the specific language governing permissions and limitations under the License. --> -Geode uses a query syntax based on OQL (Object Query Language) to query region data. Since Geode regions are key-value stores, values can range from simple byte arrays to complex nested objects. +<%=vars.product_name%> uses a query syntax based on OQL (Object Query Language) to query region data. Since <%=vars.product_name%> regions are key-value stores, values can range from simple byte arrays to complex nested objects. -- **[GET /gemfire-api/v1/queries](../rest_apps/get_queries.html)** +- **[GET /gemfire-api/v1/queries](get_queries.html)** List all parameterized queries by ID or name. -- **[POST /gemfire-api/v1/queries?id=<queryId>&q=<OQL-statement>](../rest_apps/post_create_query.html)** +- **[POST /gemfire-api/v1/queries?id=<queryId>&q=<OQL-statement>](post_create_query.html)** Create (prepare) the specified parameterized query and assign the corresponding ID for lookup. -- **[POST /gemfire-api/v1/queries/{queryId}](../rest_apps/post_execute_query.html)** +- **[POST /gemfire-api/v1/queries/{queryId}](post_execute_query.html)** Execute the specified named query passing in scalar values for query parameters in the POST body. -- **[PUT /gemfire-api/v1/queries/{queryId}](../rest_apps/put_update_query.html)** +- **[PUT /gemfire-api/v1/queries/{queryId}](put_update_query.html)** Update a named, parameterized query. -- **[DELETE /gemfire-api/v1/queries/{queryId}](../rest_apps/delete_named_query.html)** +- **[DELETE /gemfire-api/v1/queries/{queryId}](delete_named_query.html)** Delete the specified named query. -- **[GET /gemfire-api/v1/queries/adhoc?q=<OQL-statement>](../rest_apps/get_execute_adhoc_query.html)** +- **[GET /gemfire-api/v1/queries/adhoc?q=<OQL-statement>](get_execute_adhoc_query.html)** Run an unnamed (unidentified), ad-hoc query passed as a URL parameter. http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/rest_regions.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/rest_regions.html.md.erb b/geode-docs/rest_apps/rest_regions.html.md.erb index dd49f6f..47a8a45 100644 --- a/geode-docs/rest_apps/rest_regions.html.md.erb +++ b/geode-docs/rest_apps/rest_regions.html.md.erb @@ -19,63 +19,63 @@ See the License for the specific language governing permissions and limitations under the License. --> -A Geode region is how Geode logically groups data within its cache. Regions stores data as entries, which are key-value pairs. Using the REST APIs you can read, add (or update), and delete region data. +A <%=vars.product_name%> region is how <%=vars.product_name%> logically groups data within its cache. Regions stores data as entries, which are key-value pairs. Using the REST APIs you can read, add (or update), and delete region data. See also [Data Regions](../basic_config/data_regions/chapter_overview.html#data_regions) for more information on working with regions. -- **[GET /gemfire-api/v1](../rest_apps/get_regions.html)** +- **[GET /gemfire-api/v1](get_regions.html)** - List all available resources (regions) in the Geode cluster. + List all available resources (regions) in the <%=vars.product_name%> cluster. -- **[GET /gemfire-api/v1/{region}](../rest_apps/get_region_data.html)** +- **[GET /gemfire-api/v1/{region}](get_region_data.html)** Read data for the region. The optional limit URL query parameter specifies the number of values from the Region that will be returned. The default limit is 50. If the user specifies a limit of âALLâ, then all entry values for the region will be returned. -- **[GET /gemfire-api/v1/{region}/keys](../rest_apps/get_region_keys.html)** +- **[GET /gemfire-api/v1/{region}/keys](get_region_keys.html)** List all keys for the specified region. -- **[GET /gemfire-api/v1/{region}/{key}](../rest_apps/get_region_key_data.html)** +- **[GET /gemfire-api/v1/{region}/{key}](get_region_key_data.html)** Read data for a specific key in the region. -- **[GET /gemfire-api/v1/{region}/{key1},{key2},...,{keyN}](../rest_apps/get_region_data_for_multiple_keys.html)** +- **[GET /gemfire-api/v1/{region}/{key1},{key2},...,{keyN}](get_region_data_for_multiple_keys.html)** Read data for multiple keys in the region. -- **[HEAD /gemfire-api/v1/{region}](../rest_apps/head_region_size.html)** +- **[HEAD /gemfire-api/v1/{region}](head_region_size.html)** An HTTP HEAD request that returns region's size (number of entries) within the HEADERS, which is a response without the content-body. Region size is specified in the pre-defined header named "Resource-Count". -- **[POST /gemfire-api/v1/{region}?key=<key>](../rest_apps/post_if_absent_data.html)** +- **[POST /gemfire-api/v1/{region}?key=<key>](post_if_absent_data.html)** Create (put-if-absent) data in region. -- **[PUT /gemfire-api/v1/{region}/{key}](../rest_apps/put_update_data.html)** +- **[PUT /gemfire-api/v1/{region}/{key}](put_update_data.html)** Update or insert (put) data for key in region. -- **[PUT /gemfire-api/v1/{region}/{key1},{key2},...{keyN}](../rest_apps/put_multiple_values_for_keys.html)** +- **[PUT /gemfire-api/v1/{region}/{key1},{key2},...{keyN}](put_multiple_values_for_keys.html)** Update or insert (put) data for multiple keys in the region. -- **[PUT /gemfire-api/v1/{region}/{key}?op=REPLACE](../rest_apps/put_replace_data.html)** +- **[PUT /gemfire-api/v1/{region}/{key}?op=REPLACE](put_replace_data.html)** Update (replace) data with key(s) if and only if the key(s) exists in region. The Key(s) must be present in the Region for the update to occur. -- **[PUT /gemfire-api/v1/{region}/{key}?op=CAS](../rest_apps/put_update_cas_data.html)** +- **[PUT /gemfire-api/v1/{region}/{key}?op=CAS](put_update_cas_data.html)** Update (compare-and-set) value having key with a new value if and only if the "@old" value sent matches the current value having key in region. -- **[DELETE /gemfire-api/v1/{region}](../rest_apps/delete_all_data.html)** +- **[DELETE /gemfire-api/v1/{region}](delete_all_data.html)** Delete all entries in the region. -- **[DELETE /gemfire-api/v1/{region}/{key}](../rest_apps/delete_data_for_key.html)** +- **[DELETE /gemfire-api/v1/{region}/{key}](delete_data_for_key.html)** Delete entry for specified key in the region. -- **[DELETE /gemfire-api/v1/{region}/{key1},{key2},...{keyN}](../rest_apps/delete_data_for_multiple_keys.html)** +- **[DELETE /gemfire-api/v1/{region}/{key1},{key2},...{keyN}](delete_data_for_multiple_keys.html)** Delete entries for multiple keys in the region. http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/setup_config.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/setup_config.html.md.erb b/geode-docs/rest_apps/setup_config.html.md.erb index 7ba24ea..ba2445f 100644 --- a/geode-docs/rest_apps/setup_config.html.md.erb +++ b/geode-docs/rest_apps/setup_config.html.md.erb @@ -19,12 +19,12 @@ See the License for the specific language governing permissions and limitations under the License. --> -The Apache Geode Developer REST interface runs as an embedded HTTP or HTTPS service (Jetty server) within one -or more Geode servers. +The <%=vars.product_name_long%> Developer REST interface runs as an embedded HTTP or HTTPS service (Jetty server) within one +or more <%=vars.product_name%> servers. # REST API Libraries -All Geode REST interface classes and required JAR files are distributed as a WAR file with the Geode product distribution. You can find the file in the following location: +All <%=vars.product_name%> REST interface classes and required JAR files are distributed as a WAR file with the <%=vars.product_name%> product distribution. You can find the file in the following location: <code> <i>install-dir</i>/tools/Extensions/geode-web-api-<i>n.n.n.</i>war @@ -59,7 +59,7 @@ following: # <a id="setup_config_starting_rest" class="no-quick-link"></a> Starting the REST API Service -To start a REST API service-enabled Geode deployment, configure PDX serialization for your +To start a REST API service-enabled <%=vars.product_name%> deployment, configure PDX serialization for your cluster, then start the service on one or more server nodes. ## Configure PDX for your cluster @@ -104,7 +104,7 @@ To configure PDX in your cluster, perform the following steps: ## Start the REST API Service on One or More Servers As described above, you can start the REST API service on a server by using `gfsh start server --start-rest-api`, -or by setting the Geode property `start-dev-rest-api` to `true`. +or by setting the <%=vars.product_name%> property `start-dev-rest-api` to `true`. If you wish to start the service on multiple servers, use `http-service-bind-address` and `http-service-port` to identify the cache server and specific port that will host REST services. If you do not specify the `http-service-port`, the default port is 7070, which may collide with other locators and servers. @@ -157,7 +157,7 @@ start-dev-rest-api=true ## Verify That The Service is Running -Verify that the Geode REST API service is up and running. To validate this, you can perform the following checks: +Verify that the <%=vars.product_name%> REST API service is up and running. To validate this, you can perform the following checks: 1. Test the list resources endpoint (this step assumes that you have regions defined on your cluster): @@ -192,7 +192,7 @@ APIs](using_swagger.html#concept_rlr_y3c_54) for more information. To turn on integrated security, start your servers and locators with the security-manager property set in your gemfire.properties file or on the gfsh command-line. -The following example uses the sample implementation that is included in the Geode source, +The following example uses the sample implementation that is included in the <%=vars.product_name%> source, `org.apache.geode.examples.security.ExampleSecurityManager`. This implementation requires a JSON security configuration file which defines the allowed users and their corresponding @@ -230,7 +230,7 @@ http://super-user:1234567@localhost:8080/geode/v1 # <a id="setup_config_implementing_auth" class="no-quick-link"></a>Programmatic Startup -You can also start and configure Geode REST services programmatically. For example: +You can also start and configure <%=vars.product_name%> REST services programmatically. For example: ``` pre import org.apache.geode.distributed.ServerLauncher; http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/troubleshooting.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/troubleshooting.html.md.erb b/geode-docs/rest_apps/troubleshooting.html.md.erb index 0f47fff..5177311 100644 --- a/geode-docs/rest_apps/troubleshooting.html.md.erb +++ b/geode-docs/rest_apps/troubleshooting.html.md.erb @@ -21,7 +21,7 @@ limitations under the License. <a id="topic_r5z_lj5_m4"></a> -This section provides troubleshooting guidance and frequently asked questions about Geode Developer REST APIs. +This section provides troubleshooting guidance and frequently asked questions about <%=vars.product_name%> Developer REST APIs. ## Checking if the REST API Service is Up and Running @@ -45,15 +45,15 @@ If the server is not available, your client will receive an HTTP error code and ## Key Types and JSON Support -When defining regions (your REST resources), you must only use scalar values for keys and also set value constraints in order to avoid producing JSON that cannot be parsed by Geode. +When defining regions (your REST resources), you must only use scalar values for keys and also set value constraints in order to avoid producing JSON that cannot be parsed by <%=vars.product_name%>. -If Geode regions are not defined with scalar values as keys and value constraints, then you may receive the following error message (even though the JSON is technically valid) in your REST client applications: +If <%=vars.product_name%> regions are not defined with scalar values as keys and value constraints, then you may receive the following error message (even though the JSON is technically valid) in your REST client applications: ``` pre Json doc specified in request body is malformed..!!' ``` -For example, the following JSON documents are not supported by Geode: +For example, the following JSON documents are not supported by <%=vars.product_name%>: ## Unsupported JSON Example 1 http://git-wip-us.apache.org/repos/asf/geode/blob/d291a457/geode-docs/rest_apps/using_swagger.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/using_swagger.html.md.erb b/geode-docs/rest_apps/using_swagger.html.md.erb index 995f33a..70f0d96 100644 --- a/geode-docs/rest_apps/using_swagger.html.md.erb +++ b/geode-docs/rest_apps/using_swagger.html.md.erb @@ -19,18 +19,18 @@ See the License for the specific language governing permissions and limitations under the License. --> -Apache Geode Developer REST APIs are integrated with the Swagger⢠framework. This framework provides a browser-based test client that allows you to visualize and try out Geode REST APIs. +<%=vars.product_name_long%> Developer REST APIs are integrated with the Swagger⢠framework. This framework provides a browser-based test client that allows you to visualize and try out <%=vars.product_name%> REST APIs. -Swagger application JARs are included in the Geode REST application WAR; you do not need to install any additional libraries to use Swagger. +Swagger application JARs are included in the <%=vars.product_name%> REST application WAR; you do not need to install any additional libraries to use Swagger. The following example demonstrates how to access the Swagger UI to browse the APIs. -1. Start a Geode Locator and a Developer REST API-enabled server as described in [Setup and Configuration](setup_config.html#topic_e21_qc5_m4). +1. Start a <%=vars.product_name%> Locator and a Developer REST API-enabled server as described in [Setup and Configuration](setup_config.html#topic_e21_qc5_m4). Specify an `http-service-port` for the developer REST service, as the default port, 7070, is already taken by the locator. For example: ``` pre gfsh>start locator --name=locator1 - Starting a Geode Locator in /Users/admin/apache-geode-1.2.0/locator1... + Starting a <%=vars.product_name%> Locator in /Users/admin/apache-geode-1.2.0/locator1... .... gfsh>start server --name=server1 --start-rest-api=true \ --http-service-bind-address=localhost --J=-Dgemfire.http-service-port=8080 @@ -60,7 +60,7 @@ Specify an `http-service-port` for the developer REST service, as the default po 7. Add an entry to the region by expanding the **POST /v1/{region}** endpoint. <img src="../images/swagger_post_region.png" id="concept_rlr_y3c_54__image_sfk_c2m_x4" class="image" /> 8. Click the **Try it out!** button to see the response body and response code. <img src="../images/swagger_post_region_response.png" id="concept_rlr_y3c_54__image_pmx_k2m_x4" class="image" /> -You can use the Swagger interface to try out additional Geode API endpoints and view sample responses. +You can use the Swagger interface to try out additional <%=vars.product_name%> API endpoints and view sample responses. For more information on Swagger, see the [Swagger website](http://swagger.io/) and the [OpenAPI specification](https://github.com/OAI/OpenAPI-Specification).
