Skip to content

Commit c663599

Browse files
committed
Markdown linting
Signed-off-by: Daniel Kastl <[email protected]>
1 parent fb7f25d commit c663599

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

doc/api.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
# GTT API
22

33
## Global Level API Endpoint
4-
### API Endpoint
5-
```
4+
5+
### Plugin settings API Endpoint
6+
7+
```text
68
GET /gtt/settings.json
79
```
10+
811
Get all the GTT default settings and also all the global GTT layers data.
912

1013
***Request***
11-
```
14+
15+
```text
1216
http://localhost:3000/gtt/settings.json
1317
```
1418

1519
***Response***
20+
1621
```json
1722
{
1823
"gttDefaultSetting": {
@@ -61,7 +66,7 @@ http://localhost:3000/gtt/settings.json
6166
},
6267
{
6368
"id": 2,
64-
"name": "GIS Satellite Map",
69+
"name": "Satellite Map",
6570
"type": "ol.source.XYZ",
6671
"options": {
6772
"url": "https://cyberjapandata.gsi.go.jp/xyz/seamlessphoto/{z}/{x}/{y}.jpg",
@@ -75,23 +80,29 @@ http://localhost:3000/gtt/settings.json
7580
```
7681

7782
## Project Level API Endpoint
78-
### API Endpoint
79-
```
83+
84+
### Project settings API Endpoint
85+
86+
```text
8087
GET /projects/{project_identifier}.json
8188
```
89+
8290
Get project and selected GTT layer data of a specific project.
8391

8492
***Request***
85-
```
93+
94+
```text
8695
http://localhost:3000/projects/1.json
8796
```
97+
8898
***Response***
99+
89100
```json
90101
{
91102
"project": {
92103
"id": 1,
93-
"name": "first testing project ",
94-
"identifier": "first-testing-project",
104+
"name": "My Project ",
105+
"identifier": "my-project",
95106
"description": "",
96107
"homepage": "",
97108
"status": 1,
@@ -121,4 +132,3 @@ http://localhost:3000/projects/1.json
121132
}
122133
}
123134
```
124-

0 commit comments

Comments
 (0)