From 09ea8560b88770018f9bbee3a9403ac880bf8439 Mon Sep 17 00:00:00 2001 From: Dave Barnes Date: Fri, 25 Mar 2022 14:05:08 -0700 Subject: [PATCH] GEODE-10172: User Guide: Escape braces and angle brackets for format consistency (#7495) --- .../rest_apps/rest_functions.html.md.erb | 2 +- geode-docs/rest_apps/rest_queries.html.md.erb | 6 ++--- geode-docs/rest_apps/rest_regions.html.md.erb | 26 +++++++++---------- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/geode-docs/rest_apps/rest_functions.html.md.erb b/geode-docs/rest_apps/rest_functions.html.md.erb index fc97b6e26bdf..54bf27d20b8c 100644 --- a/geode-docs/rest_apps/rest_functions.html.md.erb +++ b/geode-docs/rest_apps/rest_functions.html.md.erb @@ -25,7 +25,7 @@ limitations under the License. List all registered <%=vars.product_name%> functions in the cluster. -- **[POST /geode/v1/functions/{functionId}](post_execute_functions.html)** +- **[POST /geode/v1/functions/\{functionId\}](post_execute_functions.html)** Execute <%=vars.product_name%> function on entire cluster or on a specified region, members and member groups. diff --git a/geode-docs/rest_apps/rest_queries.html.md.erb b/geode-docs/rest_apps/rest_queries.html.md.erb index 7d424fd410d1..f251ce346344 100644 --- a/geode-docs/rest_apps/rest_queries.html.md.erb +++ b/geode-docs/rest_apps/rest_queries.html.md.erb @@ -29,15 +29,15 @@ limitations under the License. Create (prepare) the specified parameterized query and assign the corresponding ID for lookup. -- **[POST /geode/v1/queries/{queryId}](post_execute_query.html)** +- **[POST /geode/v1/queries/\{queryId\}](post_execute_query.html)** Execute the specified named query passing in scalar values for query parameters in the POST body. -- **[PUT /geode/v1/queries/{queryId}](put_update_query.html)** +- **[PUT /geode/v1/queries/\{queryId\}](put_update_query.html)** Update a named, parameterized query. -- **[DELETE /geode/v1/queries/{queryId}](delete_named_query.html)** +- **[DELETE /geode/v1/queries/\{queryId\}](delete_named_query.html)** Delete the specified named query. diff --git a/geode-docs/rest_apps/rest_regions.html.md.erb b/geode-docs/rest_apps/rest_regions.html.md.erb index edb2bd7c5cd5..ca4773df3f37 100644 --- a/geode-docs/rest_apps/rest_regions.html.md.erb +++ b/geode-docs/rest_apps/rest_regions.html.md.erb @@ -27,55 +27,55 @@ See also [Data Regions](../basic_config/data_regions/chapter_overview.html#data_ List all available resources (regions) in the <%=vars.product_name%> cluster. -- **[GET /geode/v1/{region}](get_region_data.html)** +- **[GET /geode/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 /geode/v1/{region}/keys](get_region_keys.html)** +- **[GET /geode/v1/\{region\}/keys](get_region_keys.html)** List all keys for the specified region. -- **[GET /geode/v1/{region}/{key}](get_region_key_data.html)** +- **[GET /geode/v1/\{region\}/\{key\}](get_region_key_data.html)** Read data for a specific key in the region. -- **[GET /geode/v1/{region}/{key1},{key2},...,{keyN}](get_region_data_for_multiple_keys.html)** +- **[GET /geode/v1/\{region\}/\{key1\},\{key2\},...,\{keyN\}](get_region_data_for_multiple_keys.html)** Read data for multiple keys in the region. -- **[HEAD /geode/v1/{region}](head_region_size.html)** +- **[HEAD /geode/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 /geode/v1/{region}?key=<key>](post_if_absent_data.html)** +- **[POST /geode/v1/\{region\}?key=<key>](post_if_absent_data.html)** Create (put-if-absent) data in region. -- **[PUT /geode/v1/{region}/{key}](put_update_data.html)** +- **[PUT /geode/v1/\{region\}/\{key\}](put_update_data.html)** Update or insert (put) data for key in region. -- **[PUT /geode/v1/{region}/{key1},{key2},...{keyN}](put_multiple_values_for_keys.html)** +- **[PUT /geode/v1/\{region\}/\{key1\},\{key2\},...\{keyN\}](put_multiple_values_for_keys.html)** Update or insert (put) data for multiple keys in the region. -- **[PUT /geode/v1/{region}/{key}?op=REPLACE](put_replace_data.html)** +- **[PUT /geode/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 /geode/v1/{region}/{key}?op=CAS](put_update_cas_data.html)** +- **[PUT /geode/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 /geode/v1/{region}](delete_all_data.html)** +- **[DELETE /geode/v1/\{region\}](delete_all_data.html)** Delete all entries in the region. -- **[DELETE /geode/v1/{region}/{key}](delete_data_for_key.html)** +- **[DELETE /geode/v1/\{region\}/\{key\}](delete_data_for_key.html)** Delete entry for specified key in the region. -- **[DELETE /geode/v1/{region}/{key1},{key2},...{keyN}](delete_data_for_multiple_keys.html)** +- **[DELETE /geode/v1/\{region\}/\{key1\},\{key2\},...\{keyN\}](delete_data_for_multiple_keys.html)** Delete entries for multiple keys in the region.