openapi: 3.2.0
info:
  title: Tile Server Cesium Terrain API
  description: A microservice for serving the map tiles
  version: 0.1.0
tags:
- name: Cesium Terrain
paths:
  /cesium-terrain/layer.json:
    get:
      summary: Get the cesium terrain's layer.json for a COG
      description: Get the dynamically generated cesium terrain's layer.json for a COG
      operationId: cesium_terrain_metadata_view_cesium_terrain_layer_json_get
      parameters:
      - name: cog
        in: query
        required: false
        schema:
          type: string
          title: Path to cog
          description: Path to cog (.tif, .tiff, .vrt, .json, .mosaic) file, can be local or over http
        description: Path to cog (.tif, .tiff, .vrt, .json, .mosaic) file, can be local or over http
      - name: minZoom
        in: query
        required: false
        schema:
          type: integer
          title: Minimum Zoomlevel
          description: When set CTOD returns empty tiles for zoom < minZoom, Default (1)
        description: When set CTOD returns empty tiles for zoom < minZoom, Default (1)
      - name: maxZoom
        in: query
        required: false
        schema:
          type: integer
          title: Max Zoom
          description: Maximum zoom level that will be requested by the client, Default (18)
        description: Maximum zoom level that will be requested by the client, Default (18)
      - name: resamplingMethod
        in: query
        required: false
        schema:
          type: string
          title: Resampling Method
          description: 'Resampling method for COG: ''nearest'', ''bilinear'', ''cubic'', ''cubic_spline'', ''lanczos'', ''average'', ''mode'', ''gauss'', ''rms''. Default (''none'')'
        description: 'Resampling method for COG: ''nearest'', ''bilinear'', ''cubic'', ''cubic_spline'', ''lanczos'', ''average'', ''mode'', ''gauss'', ''rms''. Default (''none'')'
      - name: meshingMethod
        in: query
        required: false
        schema:
          type: string
          title: Meshing Method
          description: 'Meshing method to use: grid, martini, delatin, Default (grid)'
        description: 'Meshing method to use: grid, martini, delatin, Default (grid)'
      - name: skipCache
        in: query
        required: false
        schema:
          type: boolean
          title: Skip Cache
          description: Set to true to prevent loading tiles from the cache. Default (False)
        description: Set to true to prevent loading tiles from the cache. Default (False)
      - name: defaultGridSize
        in: query
        required: false
        schema:
          type: integer
          title: Default Grid Size
          description: The default grid size (amount of rows/cols) to use if there is no specific zoomGridSizes defined for a requested tile, Default (20)
        description: The default grid size (amount of rows/cols) to use if there is no specific zoomGridSizes defined for a requested tile, Default (20)
      - name: zoomGridSizes
        in: query
        required: false
        schema:
          type: string
          title: Default Grid Size
          description: Default grid size for terrain tiles
        description: Default grid size for terrain tiles
      - name: defaultMaxError
        in: query
        required: false
        schema:
          type: integer
          title: Default Max Error
          description: The default max triangulation error in meters to use, Default (4)
        description: The default max triangulation error in meters to use, Default (4)
      - name: zoomMaxErrors
        in: query
        required: false
        schema:
          type: string
          title: Default Grid Size
          description: 'Per level defined max error, when requested zoom for tile not specified use defaultMaxError. Default (`{''15'': 8, ''16'': 5, ''17'': 3, ''18'': 2, ''19'': 1, ''20'': 0.5, ''21'': 0.3, ''22'': 0.1}`)'
        description: 'Per level defined max error, when requested zoom for tile not specified use defaultMaxError. Default (`{''15'': 8, ''16'': 5, ''17'': 3, ''18'': 2, ''19'': 1, ''20'': 0.5, ''21'': 0.3, ''22'': 0.1}`)'
      - name: extensions
        in: query
        required: false
        schema:
          type: string
          title: Quantized Mesh Extensions
          description: Normally supplied trough Accept header but can be set and overridden here, by multiple extensions user separator '-' (octvertexnormals-watermask) Currently only octvertexnormals is supported
        description: Normally supplied trough Accept header but can be set and overridden here, by multiple extensions user separator '-' (octvertexnormals-watermask) Currently only octvertexnormals is supported
      - name: with_master_server
        in: query
        required: false
        schema:
          default: false
          title: With Master Server
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Cesium Terrain
  /cesium-terrain/{z}/{x}/{y}.terrain:
    get:
      summary: Get a terrain tile
      description: Generates and returns a terrain tile from a COG
      operationId: cesium_terrain_tile_view_cesium_terrain__z___x___y__terrain_get
      parameters:
      - name: z
        in: path
        required: true
        schema:
          type: integer
          title: Z
      - name: x
        in: path
        required: true
        schema:
          type: integer
          title: X
      - name: y
        in: path
        required: true
        schema:
          type: integer
          title: Y
      - name: cog
        in: query
        required: false
        schema:
          type: string
          title: Path to cog
          description: Path to cog (.tif, .tiff, .vrt, .json, .mosaic) file, can be local or over http
        description: Path to cog (.tif, .tiff, .vrt, .json, .mosaic) file, can be local or over http
      - name: minZoom
        in: query
        required: false
        schema:
          type: integer
          title: Minimum Zoomlevel
          description: When set CTOD returns empty tiles for zoom < minZoom, Default (1)
        description: When set CTOD returns empty tiles for zoom < minZoom, Default (1)
      - name: resamplingMethod
        in: query
        required: false
        schema:
          type: string
          title: Resampling Method
          description: 'Resampling method for COG: ''nearest'', ''bilinear'', ''cubic'', ''cubic_spline'', ''lanczos'', ''average'', ''mode'', ''gauss'', ''rms''. Default (''none'')'
        description: 'Resampling method for COG: ''nearest'', ''bilinear'', ''cubic'', ''cubic_spline'', ''lanczos'', ''average'', ''mode'', ''gauss'', ''rms''. Default (''none'')'
      - name: meshingMethod
        in: query
        required: false
        schema:
          type: string
          title: Meshing Method
          description: 'Meshing method to use: grid, martini, delatin, Default (grid)'
        description: 'Meshing method to use: grid, martini, delatin, Default (grid)'
      - name: skipCache
        in: query
        required: false
        schema:
          type: boolean
          title: Skip Cache
          description: Set to true to prevent loading tiles from the cache. Default (False)
        description: Set to true to prevent loading tiles from the cache. Default (False)
      - name: defaultGridSize
        in: query
        required: false
        schema:
          type: integer
          title: Default Grid Size
          description: The default grid size (amount of rows/cols) to use if there is no specific zoomGridSizes defined for a requested tile, Default (20)
        description: The default grid size (amount of rows/cols) to use if there is no specific zoomGridSizes defined for a requested tile, Default (20)
      - name: zoomGridSizes
        in: query
        required: false
        schema:
          type: string
          title: Default Grid Size
          description: Default grid size for terrain tiles
        description: Default grid size for terrain tiles
      - name: defaultMaxError
        in: query
        required: false
        schema:
          type: integer
          title: Default Max Error
          description: The default max triangulation error in meters to use, Default (4)
        description: The default max triangulation error in meters to use, Default (4)
      - name: zoomMaxErrors
        in: query
        required: false
        schema:
          type: string
          title: Default Grid Size
          description: 'Per level defined max error, when requested zoom for tile not specified use defaultMaxError. Default (`{''15'': 8, ''16'': 5, ''17'': 3, ''18'': 2, ''19'': 1, ''20'': 0.5, ''21'': 0.3, ''22'': 0.1}`)'
        description: 'Per level defined max error, when requested zoom for tile not specified use defaultMaxError. Default (`{''15'': 8, ''16'': 5, ''17'': 3, ''18'': 2, ''19'': 1, ''20'': 0.5, ''21'': 0.3, ''22'': 0.1}`)'
      - name: extensions
        in: query
        required: false
        schema:
          type: string
          title: Quantized Mesh Extensions
          description: Normally supplied trough Accept header but can be set and overridden here, by multiple extensions user separator '-' (octvertexnormals-watermask) Currently only octvertexnormals is supported
        description: Normally supplied trough Accept header but can be set and overridden here, by multiple extensions user separator '-' (octvertexnormals-watermask) Currently only octvertexnormals is supported
      - name: fastMode
        in: query
        required: false
        schema:
          type: boolean
          title: Fast Mode
          description: When true, skips loading neighbor tiles for edge smoothing. Faster response (~1-2s vs 5-8s) but edges between tiles may have visible seams.
        description: When true, skips loading neighbor tiles for edge smoothing. Faster response (~1-2s vs 5-8s) but edges between tiles may have visible seams.
      - name: with_master_server
        in: query
        required: false
        schema:
          default: false
          title: With Master Server
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Cesium Terrain
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError