GEODE-3044: User Manual: Update Swagger example and screen shots - remove redundant connect command
Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/3fa8bd40 Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/3fa8bd40 Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/3fa8bd40 Branch: refs/heads/feature/GEODE-3023 Commit: 3fa8bd405cef91e330da2fd164cb0e2caa5969f0 Parents: ee50662 Author: Dave Barnes <[email protected]> Authored: Wed Jun 7 14:52:57 2017 -0700 Committer: Udo Kohlmeyer <[email protected]> Committed: Fri Jun 9 13:12:03 2017 -0700 ---------------------------------------------------------------------- geode-docs/rest_apps/using_swagger.html.md.erb | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/3fa8bd40/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 10bc8d0..cc8d617 100644 --- a/geode-docs/rest_apps/using_swagger.html.md.erb +++ b/geode-docs/rest_apps/using_swagger.html.md.erb @@ -44,13 +44,7 @@ Specify an `http-service-port` for the developer REST service, as the default po The following Web page appears: <img src="../images/swagger_home.png" id="concept_rlr_y3c_54__image_m15_qcm_x4" class="image" /> -3. In gfsh, connect to the server running the JMX Manager. - - ``` pre - gfsh>connect --jmx-manager=localhost[1099] - ``` - -4. Using gfsh, create one or more regions on the REST API server. For example: +3. Using gfsh, create one or more regions on the REST API server. For example: ``` pre gfsh>create region --name=region1 --type=REPLICATE --key-constraint=java.lang.String @@ -59,12 +53,12 @@ Specify an `http-service-port` for the developer REST service, as the default po server1 | Region "/region1" created on "server1" ``` -5. In Swagger, click on **pdx-based-crud-controller : region CRUD operations** to list all the available endpoints for accessing regions. +4. In Swagger, click on **pdx-based-crud-controller : region CRUD operations** to list all the available endpoints for accessing regions. <img src="../images/swagger_region_endpoints.png" class="image" /> -6. In the list of **region** endpoints, click on the **GET /v1** endpoint link. The page displays additional request and response information about the API. <img src="../images/swagger_v1.png" id="concept_rlr_y3c_54__image_kx2_2dm_x4" class="image" /> -7. Click the **Try it out!** button. Any regions you added in step 5 are returned in the response body. <img src="../images/swagger_v1_response.png" id="concept_rlr_y3c_54__image_y2p_tdm_x4" class="image" /> -8. 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" /> -9. 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" /> +5. In the list of **region** endpoints, click on the **GET /v1** endpoint link. The page displays additional request and response information about the API. <img src="../images/swagger_v1.png" id="concept_rlr_y3c_54__image_kx2_2dm_x4" class="image" /> +6. Click the **Try it out!** button. Any regions you added in step 5 are returned in the response body. <img src="../images/swagger_v1_response.png" id="concept_rlr_y3c_54__image_y2p_tdm_x4" class="image" /> +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.
