Document spatial filter for tax lots endpoint

[TangoYankee]

Description

As part of discussion #97

Document a spatial filter for the endpoint which accesses many tax lots. This extension filters the tax lots based on a geometry passed through the query parameters. The endpoint will accept the geometry type, coordinates, and a buffer. It will the tax lots which intersect the geometry

Acceptance criteria

• create a geometryParam that:
  • [x] describes the type of geometry being requested with this query param
  • [x] is optional
  • [x] is an enum with options of Point, LineString, and Polygon
  • [x] has a description that politely informs the user
  • the role of the parameter
  • that it must be provided when using the spatial filter
  • that it adds additional restrictions to the coordinates based on the type
    • Point type must be of length one
    • LineString must be of length between 2 and 5, inclusive
    • Polygon must be of length between 4 and 5, inclusive
• create a lonsParam that
  • [x] specifies the longitude coordinates being requested with this query param
  • [x] is optional
  • [x] is an array of numbers in the format of an "unexploded form array" with length between 1 and 5, inclusive
  • [x] has a description that politely informs the user
  • the role of the parameter
  • that it must be provided when using the spatial filter
  • that it must form a valid geometry when combined with data from the other spatial parameters
• create a latsParam that
  • [x] specifies the latitude coordinates being requested with this query param
  • [x] is optional
  • [x] is an array of numbers in the format of an "unexploded form array" with length between 1 and 5, inclusive
  • [x] has a description that politely informs the user
  • the role of the parameter
  • that it must be provided when using the spatial filter
  • that it must form a valid geometry when combined with data from the other spatial parameters
• create a bufferParam that:
  • [x] specifies the spatial buffer being requested with this query param
  • [x] is optional
  • [x] is a number
  • [x] has a description that politely informs the user
  • it provides a spatial buffer around the geometry
  • is in feet
  • that it is optional when using the spatial buffer
• update the tax-lots endpoint
  • [x] Add the geometryParam, lonsParam, latsParam, and bufferParam query parameters
  • [x] Add instructions to the description regarding the spatial filter
  • It is useful for finding the tax lots that intersect a geometry
  • When applying the spatial filter, results are sorted by distance from the center of the largest portion of the shape.
  • Geometry, lats, and lons are required when using the spatial filter. Omitting one of these types, or providing a set of types that create an invalid geometry, will cause a client request error.
  • The buffer is optional when using the spatial filter.
• generate the documentation page
  • npm run redoc:build

[TangoYankee]

@bmarchena, I ran into a roadblock with the query params. They'll block this until we get them sorted out.

blocking ticket: #186

EDIT: The acceptance criteria reflect that we will now be able to support query params of the desired type, rather than a string formatted in the shape of the desired type.