NYCPlanning / ae-zoning-api

This application is API for serving data related to zoning and tax lots.
1 stars 0 forks source link

Open API: create schemas for viewport path parameters. #225

Closed TangoYankee closed 2 months ago

TangoYankee commented 2 months ago

Description

Mapbox vector tile endpoints will have path parameters to request tiles at the specified zoom, x, and y. We what to create reusable schemas for these parameters. A example of the general structure for these parameters is available on the 132/on-demand-tilesets branch. Though, the example incorrectly describes them as strings.

example viewportParam

Acceptance Criteria

Helper code

Copy and paste this into components/parameters. It has the configuration that was already written on the prototype branch, updated to define them as numbers

    viewportZoomParam:
      name: z
      in: path
      description: viewport zoom component
      required: true
      schema:
        type: integer
        example: 7
    viewportXParam:
      name: x
      in: path
      description: viewport x component
      required: true
      schema:
        type: integer
        example: 1000
    viewportYParam:
      name: y
      in: path
      description: viewport y component
      required: true
      schema:
        type: integer
        example: 1000