Update the basemaps-mkdocs container using swagger ui plugin

.github/workflows/push.yml

@@ -29,7 +29,7 @@ jobs:
       - name: Build docs
         run: |
           cp packages/landing/node_modules/@linzjs/lui/dist/assets/images/linz-motif.svg docs/
-          docker run --rm -v ${PWD}:/docs squidfunk/mkdocs-material:9.4 build
+          docker run --rm -v ${PWD}:/docs ghcr.io/linz/basemaps-mkdocs:v1 build
 
       - name: Store docs artifact
         uses: actions/upload-artifact@v3

docs/user-guide/get-started.md → docs/user-guide/_get-started.md

@@ -6,10 +6,10 @@ The LINZ Basemaps API lets you build your own New Zealand-centric maps for mobil
 
 We've made getting started with LINZ Basemaps APIs easy.
 
-1. Pick a [LINZ Basemaps product](https://basemaps.linz.govt.nz/@-41.8899962,174.0492437,z5).
+1. Pick a [LINZ Basemaps product](https://basemaps.linz.govt.nz/).
 2. Grab a map tile API url from the menu bar.
 3. If you're a developer, email <[email protected]> for developer access
-4. Find the [Technical documentation](./technical-documentation.md), legals and how to's that will help you get mapping successfully.
+4. Find the [Technical documentation](./technical-documentation.md) and [API documentation](./api-documentation.md), legals and how to's that will help you get mapping successfully.
 
 ## Basics of our APIs
 

docs/user-guide/api-documentation.md

@@ -0,0 +1,5 @@
+# API documentation
+
+This page provide examples of Basemaps APIs that allow you to programmatically access LINZ map tile services to integrate into your mobile, web.
+
+<swagger-ui src="./swagger-api.json"/>

docs/user-guide/api.json → docs/user-guide/swagger-api.json

@@ -1,17 +1,5 @@
 {
   "openapi": "3.0.3",
-  "info": {
-    "title": "LINZ BASEMAPS APIs",
-    "description": "LINZ Basemaps APIs allow you to programmatically access LINZ map tile services to integrate into your mobile, web",
-    "contact": {
-      "email": "[email protected]"
-    },
-    "license": {
-      "name": "MIT License",
-      "url": "https://github.com/linz/basemaps/blob/master/LICENSE"
-    },
-    "version": "1.0.11"
-  },
   "servers": [
     {
       "url": "https://basemaps.linz.govt.nz/v1"

docs/user-guide/technical-documentation.md

@@ -13,7 +13,7 @@ At a platform level, the LINZ Basemaps APIs supports:
 | **Protocols**            | WMTS and XYZ                                                  |
 | **Output tiling scheme** | NZTM2000 and Web Mercator                                     |
 | **Zoom levels**          | NZTM 0 - 17 and Web Mercator 0 - 22                           |
-| **Output formats**       | WebP, Jpeg or PNG                                             |
+| **Output formats**       | WebP, Jpeg, PNG, or Avif                                             |
 | **Applications**         | GIS (e.g QGIS, ArcGIS), CAD and Javascript web or mobile apps |
 
 ### LINZ Topographic Basemap
@@ -108,7 +108,7 @@ Authentication is managed via API key for Developer level access. Developers do
 
 ## Aerial Imagery output format
 
-You can request raster tiles in WebP, PNG or JPEG format.
+You can request raster tiles in WebP, PNG, JPEG, or Avif format.
 
 Our recommended output format is WebP as it allows the quality of images to be maintained with relatively small file sizes and supports an alpha channel for transparency. This is also the default format in the XYZ URL you can copy from https://basemaps.linz.govt.nz
 

mkdocs.yml

@@ -72,4 +72,7 @@ markdown_extensions:
 extra:
   analytics:
     provider: google
-    property: !ENV [GOOGLE_ANALYTICS]
+    property: !ENV [GOOGLE_ANALYTICS]
+
+plugins:
+  - swagger-ui-tag