NYCPlanning / ae-zoning-api

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

Allow name property for agency to be nullable in Open Api documentation #290

Closed pratishta closed 1 month ago

pratishta commented 1 month ago

Description

The name field on the agency schema is allowed to be null in the database. In the Open API schema where we define this property, we currently only allow it to be of type string. When we generate the types and zod schemas from the Open API documentation, the agency type and schema won't be able to have a null value either, resulting in an endpoint implementation that sends a response that's inconsistent with the database type definition.

Relevant context: https://github.com/NYCPlanning/ae-zoning-api/pull/288#discussion_r1611844156

Acceptance criteria