Skip to content

Commit a9c6aa1

Browse files
Merge pull request #31 from geoadmin/feat-PB-1810-talk-about-endpoints-instead-of-services
PB-1810 Replace "service" by "endpoint" #patch
2 parents b11cf04 + d9c4686 commit a9c6aa1

3 files changed

Lines changed: 14 additions & 14 deletions

File tree

docs/get-layer-legend.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Get Layer Legend
22

3-
With a layer ID (or technical name), this service can be used to
4-
retrieve a legend.
3+
This endpoint provides the legend of a given layer in the form of HTML markup.
4+
A legend is what is shown when you click the info button on a layer in the map viewer.
5+
It contains a description of the layer, the actual legend explaining the meaning of the different colors and symbols, and additional metadata.
56

67
<ApiCodeBlock url="https://api3.geo.admin.ch/rest/services/api/MapServer/{layerBodId}/legend" method="GET" />
78

89
## Request Details
910

10-
To interact with the Layer Legend service, you need to provide specific parameters in your request.
11+
To interact with the legend endpoint, you need to provide specific parameters in your request.
1112
These parameters are divided into **Path Parameters**, which are required and part of the URL, and **Query Parameters**, which are optional and modify the behavior of the request.
1213

1314
### Path Parameters

docs/get-layer-metadata.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
# Get Layer Metadata
22

3-
This service provides metadata for all the available layers in the
4-
GeoAdmin API.
3+
This endpoint provides metadata for all layers that match a search query.
54

65
<ApiCodeBlock url="https://api3.geo.admin.ch/rest/services/api/MapServer" method="GET" />
76

87
## Request Details
98

10-
To interact with the Layer Metadata service, you need to provide specific parameters in your request.
9+
To interact with the metadata endpoint, you need to provide specific parameters in your request.
1110
This endpoint only has **Query Parameters**, which are optional and modify the behavior of the request.
1211

1312
### Query Parameters
@@ -21,9 +20,8 @@ This endpoint only has **Query Parameters**, which are optional and modify the b
2120

2221
## Response Details
2322

24-
A request to the Layer Metadata service returns a **JSON** composed by a list of object literals representing the **layers** and a set of metadata **attributes** associated to each layer.
25-
26-
Here is a description of the data one can find in the above response.
23+
The response constains a list of all the layers matching the query.
24+
For each layer, there are some general identification properties
2725

2826
| Field | Description |
2927
| ------------ | --------------------------------------------------------------------------------------- |
@@ -32,7 +30,8 @@ Here is a description of the data one can find in the above response.
3230
| `idGeoCat` | The associated metadata ID in [GeoCat](http://www.geocat.ch/geonetwork/srv/eng/geocat). |
3331
| `layerBodId` | The technical name or BOD ID. |
3432

35-
**Attributes:** Metadata attributes associated with a given layer.
33+
and attributes listing more metaadata
34+
3635
| Field | Description |
3736
| ------------ | --------------------------------------------------------------------------------------- |
3837
| `wmsResource` | The WMS resource of the layer. |

docs/identify-features.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Identify Features
22

3-
Use this service to discover features at a specific location.
3+
Use this endpoint to discover features at a specific location.
44

55
<ApiCodeBlock url="https://api3.geo.admin.ch/rest/services/api/MapServer/identify" method="GET" />
66

@@ -10,7 +10,7 @@ No more than 50 features can be retrieved per request.
1010

1111
## Request Details
1212

13-
To interact with the identify features service, you need to provide specific parameters in your request.
13+
To interact with the `identify` endpoint, you need to provide specific parameters in your request.
1414
This endpoint only has query parameters that modify the behavior of the request, some are required and some are optional.
1515

1616
### Query Parameters
@@ -44,7 +44,7 @@ The following table summarize the various combinations:
4444

4545
### layerDefs syntax
4646

47-
To list the available attributes together with their types and examples values, use the layer [attribute service](/docs/get-layer-attributes).
47+
To list the available attributes together with their types and examples values, use the [layer attribute endpoint](/docs/get-layer-attributes).
4848

4949
Define the `layerDefs` parameter in JSON format like `{"<layername>":"<filter_expression>"}`.
5050

@@ -428,7 +428,7 @@ example='{
428428

429429
## Examples: Reverse Geocoding
430430

431-
The service identify can be used for Reverse Geocoding operations.
431+
The `identify` endpoint can be used for reverse geocoding operations.
432432

433433
Perform an identify request to find the districts intersecting a given envelope geometry (no buffer):
434434

0 commit comments

Comments
 (0)