maplibre/martin
1
1
Fork 0
mirror of https://github.com/maplibre/martin.git synced 2024-12-21 05:41:55 +03:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

fix font docs

Browse Source
This commit is contained in:
Yuri Astrakhan 2023-10-30 18:18:03 -04:00
parent 163b44982a
commit 127c989f37
2 changed files with 44 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -86,19 +86,21 @@ docker run -p 3000:3000 \
``` ```
## API ## API
_See [API documentation](https://maplibre.org/martin/40-using.html) in the Martin book._ _See [API documentation](https://maplibre.org/martin/40-using-endpoints.html) in the Martin book._
Martin data is available via the HTTP `GET` endpoints: Martin data is available via the HTTP `GET` endpoints:
| URL | Description | | URL | Description |
|----------------------------------------|-----------------------------------------------| |-----------------------------------------|-----------------------------------------------|
| `/` | Status text, that will eventually show web UI | | `/` | Status text, that will eventually show web UI |
| `/catalog` | List of all sources | | `/catalog` | List of all sources |
| `/{sourceID}` | Source TileJSON | | `/{sourceID}` | Source TileJSON |
| `/{sourceID}/{z}/{x}/{y}` | Map Tiles | | `/{sourceID}/{z}/{x}/{y}` | Map Tiles |
| `/{source1},...,{sourceN}` | Composite Source TileJSON | | `/{source1},…,{sourceN}` | Composite Source TileJSON |
| `/{source1},...,{sourceN}/{z}/{x}/{y}` | Composite Source Tiles | | `/{source1},…,{sourceN}/{z}/{x}/{y}` | Composite Source Tiles |
| `/sprite/{spriteID}[@2x].{json,png}` | Sprites (low and high DPI, index/png) | | `/sprite/{spriteID}[@2x].{json,png}` | Sprites (low and high DPI, index/png) |
| `/font/{font}/{start}-{end}` | Font source |
| `/font/{font1},…,{fontN}/{start}-{end}` | Composite Font source |
| `/health` | Martin server health check: returns 200 `OK` | | `/health` | Martin server health check: returns 200 `OK` |
## Documentation ## Documentation

27
docs/src/40-using-endpoints.md
View File

@ -3,14 +3,16 @@
Martin data is available via the HTTP `GET` endpoints: Martin data is available via the HTTP `GET` endpoints:
| URL | Description | | URL | Description |
|----------------------------------------|------------------------------------------------| |-----------------------------------------|-----------------------------------------------|
| `/` | Status text, that will eventually show web UI | | `/` | Status text, that will eventually show web UI |
| `/catalog` | [List of all sources](#catalog) | | `/catalog` | [List of all sources](#catalog) |
| `/{sourceID}` | [Source TileJSON](#source-tilejson) | | `/{sourceID}` | [Source TileJSON](#source-tilejson) |
| `/{sourceID}/{z}/{x}/{y}` | Map Tiles | | `/{sourceID}/{z}/{x}/{y}` | Map Tiles |
| `/{source1},...,{sourceN}` | [Composite Source TileJSON](#source-tilejson) | | `/{source1},…,{sourceN}` | [Composite Source TileJSON](#source-tilejson) |
| `/{source1},...,{sourceN}/{z}/{x}/{y}` | [Composite Source Tiles](30-config-file.md) | | `/{source1},…,{sourceN}/{z}/{x}/{y}` | [Composite Source Tiles](30-config-file.md) |
| `/sprite/{spriteID}[@2x].{json,png}` | [Sprite sources](36-sources-spritess.md) | | `/sprite/{spriteID}[@2x].{json,png}` | [Sprite sources](36-sources-spritess.md) |
| `/font/{font}/{start}-{end}` | [Font source](#37-sources-fonts.md) |
| `/font/{font1},…,{fontN}/{start}-{end}` | [Composite Font source](#37-sources-fonts.md) |
| `/health` | Martin server health check: returns 200 `OK` | | `/health` | Martin server health check: returns 200 `OK` |
### Duplicate Source ID ### Duplicate Source ID
@ -43,6 +45,25 @@ curl localhost:3000/catalog | jq
}, },
... ...
}, },
"sprites": {
"cool_icons": {
"images": [
"bicycle",
"bear",
]
},
...
},
"fonts": {
"Noto Mono Regular": {
"family": "Noto Mono",
"style": "Regular",
"glyphs": 875,
"start": 0,
"end": 65533
},
...
}
} }
``` ```