From 9a2dac06997e6525ca615723c416503228d42866 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20M=C3=A9liani?= <m.meliani@neogeo-online.net>
Date: Tue, 8 Apr 2014 15:03:19 +0200
Subject: [PATCH] Updated docs...
---
docs/mra-reference.md | 30 +++++++++----------
docs/resources/delete-coveragestore.md | 3 ++
docs/resources/delete-datastore.md | 3 ++
docs/resources/delete-layerstyles.md | 3 ++
docs/resources/get-layerfields.md | 3 ++
docs/resources/get-layerstyles.md | 3 ++
...post-layergrpus.md => post-layergroups.md} | 0
7 files changed, 30 insertions(+), 15 deletions(-)
create mode 100644 docs/resources/delete-coveragestore.md
create mode 100644 docs/resources/delete-datastore.md
create mode 100644 docs/resources/delete-layerstyles.md
create mode 100644 docs/resources/get-layerfields.md
create mode 100644 docs/resources/get-layerstyles.md
rename docs/resources/{post-layergrpus.md => post-layergroups.md} (100%)
diff --git a/docs/mra-reference.md b/docs/mra-reference.md
index 532ea4d..fcafd88 100644
--- a/docs/mra-reference.md
+++ b/docs/mra-reference.md
@@ -3,26 +3,24 @@
This section describes the REST configuration API.
It is in process of writing...
-Nevertheless, you could refer to the GeoServer Rest API documentation cause MRA was designed to offer compatibility with this model.
-You will also find few _docstrings_ by reading the code, especially the module `server.py` which defines the URL mapping infrastructure and HTTP methods used by the REST API.
-
### Compatibility with GeoServer REST API
-MapServer REST API was designed to offer compatibility with the GeoServer REST API model because we believe that both should be able to communicate...
+MapServer REST API was designed to offer compatibility with the GeoServer REST API model because we believe that both should be able to communicate.
These two concepts should not be viewed as being mutually opposed.
-On the contrary, they can be mutually rewarding.
-This was helpful for us. So this can be used more widely.
+On the contrary, they can be mutually rewarding. This was helpful for us. So this can be used more widely.
-The pre-existence of GeoServer REST API obliges us to make choices, and hence depart from the MapServer model in favor of the GeoServer model.
-And that does not mean to say that it would be the best way to control MapServer.
-However, despite these still substantial differences between the two softwares,
+The pre-existence of GeoServer REST API obliges us to make choices, and hence depart from the MapServer logic in favor of the GeoServer model.
+That does not mean to say that it would be the best way to control MapServer.
+However, despite the substantial differences between the two softwares, MapServer REST API help to a certain extent to reduce the gap.
+MapServer REST API is not fully compatible with GeoServer.
+Either do we believe that it makes much sense to include elements which does not affect the good functioning of services provided.
-### Workspaces, data stores & featuretypes, coverage stores & coverages
+### Mapfiles & Workspaces, data stores, featuretypes, coverage stores, coverages
-A workspace is a grouping of data stores and coverage stores.
+In GeoServer, a workspace is a grouping of data stores and coverage stores.
A data store is a source of spatial data that is vector based.
It can be a file such as a _shapefile_ or a database such as _PostGIS_.
@@ -31,13 +29,15 @@ In cases of a _shapefile_, the feature type is unique and corresponds to the dat
In cases of a _PostGIS_ database, feature types corresponds to tables.
A coverage store is a source of spatial data that is raster based.
-In current version, it can only be a _GeoTIFF_ file.
-For this format file, the coverage is unique and corresponds to the coverage store.
+It can be a _GeoTIFF_ file and for this format file, the coverage is unique and corresponds to the coverage store.
The concept of _workspace_ comes from GeoServer and it does not exist in MapServer.
+This is the main difference between the two designs.
However, it is possible to assimilate this concept to a single _mapfile_.
-So a _workspace_ is a _mapfile_.
+So a MapServer' _mapfile_ is assimilated to GeoServer' _workspace_.
+And this contains layers which shall be regarded as connections to data stores or to coverage stores.
+That can be treated as a [layer](#layers) and that can be published as [OGC Web Service](#ogc-web-services) or not.
###### Workspaces
@@ -140,7 +140,7 @@ Resource | Description
[**POST layergroups**](resources/post-layergroups.md) | Creates a new layer group.
[**GET layergroups/\<lg\>**](resources/get-layergroup.md) | Returns layer group \<lg\>.
[**PUT layergroups/\<lg\>**](resources/put-layergroup.md) | Modifies layer group \<lg\> (i.e. adding or removing layers of the group).
-[**DELETE layergroups/\<lg\>**](resources/delete-layergroups.md) | Deletes layer group \<lg\>.
+[**DELETE layergroups/\<lg\>**](resources/delete-layergroup.md) | Deletes layer group \<lg\>.
### OGC Web Services
diff --git a/docs/resources/delete-coveragestore.md b/docs/resources/delete-coveragestore.md
new file mode 100644
index 0000000..70e45ed
--- /dev/null
+++ b/docs/resources/delete-coveragestore.md
@@ -0,0 +1,3 @@
+### DELETE workspaces/\<ws\>/coveragestores/\<cs\>
+
+`TODO`
\ No newline at end of file
diff --git a/docs/resources/delete-datastore.md b/docs/resources/delete-datastore.md
new file mode 100644
index 0000000..2e74c5f
--- /dev/null
+++ b/docs/resources/delete-datastore.md
@@ -0,0 +1,3 @@
+### DELETE workspaces/\<ws\>/datastores/\<ds\>
+
+`TODO`
\ No newline at end of file
diff --git a/docs/resources/delete-layerstyles.md b/docs/resources/delete-layerstyles.md
new file mode 100644
index 0000000..2a56c03
--- /dev/null
+++ b/docs/resources/delete-layerstyles.md
@@ -0,0 +1,3 @@
+### DELETE layers/\<l\>/styles/\<s\>
+
+`TODO`
\ No newline at end of file
diff --git a/docs/resources/get-layerfields.md b/docs/resources/get-layerfields.md
new file mode 100644
index 0000000..dfdad2b
--- /dev/null
+++ b/docs/resources/get-layerfields.md
@@ -0,0 +1,3 @@
+### GET layers/\<l\>/fields
+
+`TODO`
\ No newline at end of file
diff --git a/docs/resources/get-layerstyles.md b/docs/resources/get-layerstyles.md
new file mode 100644
index 0000000..db70295
--- /dev/null
+++ b/docs/resources/get-layerstyles.md
@@ -0,0 +1,3 @@
+### GET layers/\<l\>/styles
+
+`TODO`
\ No newline at end of file
diff --git a/docs/resources/post-layergrpus.md b/docs/resources/post-layergroups.md
similarity index 100%
rename from docs/resources/post-layergrpus.md
rename to docs/resources/post-layergroups.md
--
GitLab