#3817 Fixing documentation (#4023)

Tobia Di Pisa · mbarto · web-flow · commit 1955b41292af · 2019-07-29T17:55:15.000+02:00
* #3817 fixing documentation * Update docs/developer-guide/map-query-parameters.md Co-Authored-By: mbarto <maurobartolomeoli@gmail.com> * Update docs/developer-guide/map-query-parameters.md Co-Authored-By: mbarto <maurobartolomeoli@gmail.com>
diff --git a/docs/developer-guide/API-usage.md b/docs/developer-guide/API-usage.md
@@ -1,5 +1,5 @@
 # MapStore API usage
-You can include MapStore in your application and interact with it via its JavaScript API
+You can include MapStore in your application and interact with it via its [JavaScript API](https://mapstore2.geo-solutions.it/mapstore/docs/api/jsapi)
 
 ## How to use
 
diff --git a/docs/developer-guide/map-query-parameters.md b/docs/developer-guide/map-query-parameters.md
@@ -1,24 +1,25 @@
 # MapViewer query parameters
 
-In this section we will describe the available MapViewer query parameters
-that can be used when the map is loaded.
+In this section we will describe the available MapViewer query parameters that can be used when the map is loaded.
 
 ## Retro-compatibility
-In the past a **bbox** query param has been introduced whose value corresponds to extent in the viewport.
+In latest releases the **bbox** query param has been introduced whose value corresponds to the extent in the viewport.
 
 for example:
 `?bbox=-177.84667968750014,-1.8234225930143395,-9.096679687500114,61.700290838326204`
 
-For more details on it see [sharing a map](../user-guide/share).
+For more details on it see [sharing a map](../user-guide/share). This **bbox** has been maintained as independent parameter for retro compatibility reasons since the URL query parameters logic is changing.
 
 ## Dynamically dispatching initial actions in MapStore
 
-To dispatch additional actions when the map viewer is started, the **actions** query param can be used.
-Only actions from a configured whitelist can be dispatched in this way.
+To dispatch additional actions when the map viewer is started, the **actions** query parameter can be used. Only actions from a configured whitelist can be dispatched in this way (see the [configuration section](../configuration-files/local-config) for more details).
 
-The value of this paramater is a JSON string containing an array with an object per action.
+```
+// list of actions types that are available to be launched dynamically from query param (#3817)
+  "initialActionsWhiteList": ["ZOOM_TO_EXTENT", "ADD_LAYER", ...]
+```
 
-The structure of the object consist of a property type and a bunch of other properties depending on the action.
+The value of this paramater is a JSON string containing an array with an object per action. The structure of the object consist of a property type and a bunch of other properties depending on the action.
 
 ### Available actions
 Only the following actions can be used in the **actions** json string.
@@ -35,27 +36,41 @@ Example:
     "maxZoom": 8
 }
 ```
+
 For more details check out the [zoomToExtent](https://mapstore2.geo-solutions.it/mapstore/docs/#actions.map.zoomToExtent) in the framework documentation.
 
 #### Map info
-It performs a [GetFeature](https://docs.geoserver.org/stable/en/user/services/wfs/reference.html#getfeature) request and then a [GetFeatureInfo](https://docs.geoserver.org/stable/en/user/services/wms/reference.html#getfeatureinfo) by taking a geometry from a feature retrieved. This action can be used can be used only for existing maps.
+It performs a [GetFeature](https://docs.geoserver.org/stable/en/user/services/wfs/reference.html#getfeature) request on the specified layer and then a [GetFeatureInfo](https://docs.geoserver.org/stable/en/user/services/wms/reference.html#getfeatureinfo) by taking a point from the retrieved features's geometry. This action can be used only for existing maps (map previously created).
 
-With the GetFeature request it takes the first coordinate of the geometry of the first feature.
-Then it uses it for the GFI request by creating an area of 101x101 px and by limiting it to the specified layer.
+With the GetFeature request it takes the first coordinate of the geometry of the first retrieved feature; that coordinates are then used for an usual GFI (WMS GetFeatureInfo) request by limiting it to the specified layer.
 
-You can add to the action a cql_filter that will be used in both request.
+A **cql_filter** is also **mandatory** for that action to properly filter required data: that filter will be used in both request (GetFeature and GFI). If you don't need to apply a filter, you can use the standard INCLUDE clause (cql_filter=INCLUDE) so the whole dataset will be queried. 
 
 Requirements:
-- the layer specified must be visible in the map
-- there must be a geometry that can be retrieved from the GetFeature request
+- The layer specified must be visible in the map
+- There must be a geometry that can be retrieved from the GetFeature request
 
 Example:
+
 ```
 {
     "type": "SEARCH:SEARCH_WITH_FILTER",
     "cql_filter": "ID=75",
     "layer": "WORKSPACE:LAYER_NAME"
 }
+
 ?actions=[{"type":"SEARCH:SEARCH_WITH_FILTER","cql_filter":"ID=75","layer":"WORKSPACE:LAYER_NAME"}]
 ```
+
+The sample request below illustrates how two actions can be concatenated:
+
+```
+https://dev.mapstore2.geo-solutions.it/mapstore/#/viewer/openlayers/4093?actions=[{"type":"SEARCH:SEARCH_WITH_FILTER","cql_filter":"STATE_FIPS=34","layer":"topp:states"},{"type":"ZOOM_TO_EXTENT","extent":[-77.48202256347649,38.74612266051003,-72.20858506347648,40.66664704515103],"crs":"EPSG:4326","maxZoom":8}]
+```
+
+The MapStore invocation URL above executes the following operations:
+
+- Execution of a search request filtering by **STATE_FIPS** with value 34 on the **topp:states** layer
+- Execution of a map zoom to the provided extent
+
 For more details check out the [searchLayerWithFilter](https://mapstore2.geo-solutions.it/mapstore/docs/#actions.search.exports.searchLayerWithFilter) in the framework documentation
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -90,6 +90,7 @@ pages:
     - Plugins:
       - Plugins Architecture: 'developer-guide/plugins-architecture.md'
       - Configuring Plugins: 'developer-guide/plugins-documentation.md'
-    - API:
+    - Communicating with MapStore:
+      - API usage: 'developer-guide/API-usage.md'
       - MapViewer query paramaters: 'developer-guide/map-query-parameters.md'
   - Quick Start: 'quick-start.md'
