368 Sort City Council District Find Many by Id

 - updated OpenAPI properties for CCD to include order variable
 - updated findMany to sort the CCDs by id as integers
 - updated CCD service spec to test `cityCouncilDistricts.order` value is `id`

openapi/openapi.yaml

@@ -311,8 +311,13 @@ paths:
                     type: array
                     items:
                       $ref: '#/components/schemas/CityCouncilDistrict'
+                  order: 
+                    type: string
+                    description: City council districts ids are sorted as if numbers in ascending order
+                    example: 'id'
                 required:
                  - cityCouncilDistricts
+                 - order
         '400':
           $ref: '#/components/responses/BadRequest'
         '500':
@@ -1067,8 +1072,8 @@ components:
         id:
           type: string
           description: One or two character code to represent city council districts.
-          pattern: '^([0-9]{1,2})$' 
-          example: 25
+          pattern: '^([0-9]{1,2})$'
+          example: '25'
       required:
         - id
     CityCouncilDistrictGeoJson:

src/city-council-district/city-council-district.repository.ts

@@ -50,6 +50,7 @@ export class CityCouncilDistrictRepository {
         columns: {
           id: true,
         },
+        orderBy: sql`${cityCouncilDistrict.id}::integer ASC`,
       });
     } catch {
       throw new DataRetrievalException();

src/city-council-district/city-council-district.service.spec.ts

@@ -37,6 +37,8 @@ describe("City Council District service unit", () => {
       expect(() =>
         findCityCouncilDistrictsQueryResponseSchema.parse(cityCouncilDistricts),
       ).not.toThrow();
+
+      expect(cityCouncilDistricts.order).toBe("id");
     });
   });
 

src/city-council-district/city-council-district.service.ts

@@ -27,6 +27,7 @@ export class CityCouncilDistrictService {
 
     return {
       cityCouncilDistricts,
+      order: "id",
     };
   }
 

src/gen/schemas/CityCouncilDistrict.json

@@ -4,7 +4,7 @@
     "id": {
       "description": "One or two character code to represent city council districts.",
       "type": "string",
-      "example": 25,
+      "example": "25",
       "pattern": "^([0-9]{1,2})$"
     }
   },

src/gen/schemas/CityCouncilDistrictGeoJson.json

@@ -14,7 +14,7 @@
         "id": {
           "description": "One or two character code to represent city council districts.",
           "type": "string",
-          "example": 25,
+          "example": "25",
           "pattern": "^([0-9]{1,2})$"
         }
       },

src/gen/types/FindCityCouncilDistricts.ts

@@ -9,6 +9,11 @@ export type FindCityCouncilDistricts200 = {
    * @type array
    */
   cityCouncilDistricts: CityCouncilDistrict[];
+  /**
+   * @description City council districts ids are sorted as if numbers in ascending order
+   * @type string
+   */
+  order: string;
 };
 /**
  * @description Invalid client request
@@ -26,6 +31,11 @@ export type FindCityCouncilDistrictsQueryResponse = {
    * @type array
    */
   cityCouncilDistricts: CityCouncilDistrict[];
+  /**
+   * @description City council districts ids are sorted as if numbers in ascending order
+   * @type string
+   */
+  order: string;
 };
 export type FindCityCouncilDistrictsQuery = {
   Response: FindCityCouncilDistrictsQueryResponse;

src/gen/zod/findCityCouncilDistrictsSchema.ts

@@ -7,6 +7,11 @@ import { errorSchema } from "./errorSchema";
  */
 export const findCityCouncilDistricts200Schema = z.object({
   cityCouncilDistricts: z.array(z.lazy(() => cityCouncilDistrictSchema)),
+  order: z.coerce
+    .string()
+    .describe(
+      "City council districts ids are sorted as if numbers in ascending order",
+    ),
 });
 /**
  * @description Invalid client request
@@ -21,4 +26,9 @@ export const findCityCouncilDistricts500Schema = z.lazy(() => errorSchema);
  */
 export const findCityCouncilDistrictsQueryResponseSchema = z.object({
   cityCouncilDistricts: z.array(z.lazy(() => cityCouncilDistrictSchema)),
+  order: z.coerce
+    .string()
+    .describe(
+      "City council districts ids are sorted as if numbers in ascending order",
+    ),
 });