GEODE-3207 Swagger library updates: update user guide
Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/3b32a331 Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/3b32a331 Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/3b32a331 Branch: refs/heads/feature/GEM-1483 Commit: 3b32a331918b92e986d5872a649f497104f8fd7b Parents: e086892 Author: Dave Barnes <dbar...@pivotal.io> Authored: Fri Jul 14 12:51:52 2017 -0700 Committer: Dave Barnes <dbar...@pivotal.io> Committed: Mon Jul 17 11:33:13 2017 -0700 ---------------------------------------------------------------------- geode-docs/rest_apps/setup_config.html.md.erb | 9 +++++---- geode-docs/rest_apps/using_swagger.html.md.erb | 4 ++-- 2 files changed, 7 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/3b32a331/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 c557f4f..7ba24ea 100644 --- a/geode-docs/rest_apps/setup_config.html.md.erb +++ b/geode-docs/rest_apps/setup_config.html.md.erb @@ -36,8 +36,8 @@ where _install-dir_ is the server installation directory and _n.n.n_ is a versio The REST API service for application development runs only on servers; you cannot run the service on a locator. -To enable the Developer REST API service on a given server, set the `start-dev-rest-api` property -to `true` for the server, using either the `gfsh start server` command or the ServerLauncher API. +To enable the Developer REST API service on a given server, use the `gfsh start server` command with the `--start-rest-api` option, +or set the `start-dev-rest-api` property to `true` for the server via the ServerLauncher API. This starts an embedded Jetty server and deploys the Developer REST API WAR file on that server. ## Enabling the REST API on Multiple Servers @@ -103,8 +103,9 @@ 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 setting the Geode property `start-dev-rest-api` set to `true`. -If you wish to start the service on multiple servers, use a `http-service-bind-address` and `http-service-port` to +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`. +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. If you do not specify `http-service-bind-address`, the HTTP service will bind to all local addresses by default. http://git-wip-us.apache.org/repos/asf/geode/blob/3b32a331/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 ab0d84b..995f33a 100644 --- a/geode-docs/rest_apps/using_swagger.html.md.erb +++ b/geode-docs/rest_apps/using_swagger.html.md.erb @@ -32,8 +32,8 @@ Specify an `http-service-port` for the developer REST service, as the default po gfsh>start locator --name=locator1 Starting a Geode Locator in /Users/admin/apache-geode-1.2.0/locator1... .... - gfsh>start server --name=server1 --J=-Dgemfire.start-dev-rest-api=true \ - --J=-Dgemfire.http-service-bind-address=localhost --J=-Dgemfire.http-service-port=8080 + gfsh>start server --name=server1 --start-rest-api=true \ + --http-service-bind-address=localhost --J=-Dgemfire.http-service-port=8080 ``` 2. To access Swagger, open a browser and enter the following URL. For example:
