search

NYCPlanning / ae-zoning-api

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

165: standardize zd names #181

Closed TangoYankee closed 7 months ago

TangoYankee commented 7 months ago

standardize names for zoning district and zoning district class domains

closes #165

TylerMatteo commented 7 months ago

Leaving my two cents - LGTM. The method names and operationIds are consistent with what we talked about in the discussion. To @horatiorosa's point, some of them do feel a little jarring now that I'm seeing how chonky they got in practice, but I still feel like it's the best decision.

The one that stood out to me is findZoningDistrictByZoningDistrictId because it feels like it's including the domain twice and could be shortened to findZoningDistrictById, but it makes sense when see it in in context next to ones like findZoningDistrictClassesByZoningDistrictId.

TangoYankee commented 7 months ago

The one that stood out to me is findZoningDistrictByZoningDistrictId because it feels like it's including the domain twice and could be shortened to findZoningDistrictById, but it makes sense when see it in in context next to ones like findZoningDistrictClassesByZoningDistrictId.

I also felt clunky writing them until I remembered findZoningDistrictsByTaxLotBbl will also be a thing. Explicitly mentioning both the object retrieved and the criteria used is helpful to keep everything straight.