refactor(backend): remove extendApi not needed for documentation

incubateur-ademe · Jan 2, 2025 · 125a8d7 · 125a8d7
1 parent aba2c3e
commit 125a8d7
Show file tree

Hide file tree

Showing 49 changed files with 536 additions and 656 deletions.
diff --git a/backend/src/collectivites/collectivite.request.ts b/backend/src/collectivites/collectivite.request.ts
@@ -1,15 +1,12 @@
 import { createZodDto } from '@anatine/zod-nestjs';
-import { extendApi } from '@anatine/zod-openapi';
 import { z } from 'zod';
 
-export const collectiviteRequestSchema = extendApi(
-  z.object({
-    collectiviteId: z.coerce
-      .number()
-      .int()
-      .describe('Identifiant de la collectivité'),
-  })
-);
+export const collectiviteRequestSchema = z.object({
+  collectiviteId: z.coerce
+    .number()
+    .int()
+    .describe('Identifiant de la collectivité'),
+});
 export type CollectiviteRequestType = z.infer<typeof collectiviteRequestSchema>;
 
 export class CollectiviteRequestClass extends createZodDto(

diff --git a/backend/src/collectivites/documents/models/document-lien.dto.ts b/backend/src/collectivites/documents/models/document-lien.dto.ts
@@ -1,16 +1,13 @@
-import { extendApi } from '@anatine/zod-openapi';
 import { z } from 'zod';
 
 export type lienType = {
   label: string;
   url: string;
 };
 
-export const lienSchema = extendApi(
-  z
-    .object({
-      label: z.string().describe(`Nom descriptif du lien`),
-      url: z.string().describe(`URL du lien`),
-    })
-    .describe('Un lien URL.')
-);
+export const lienSchema = z
+  .object({
+    label: z.string().describe(`Nom descriptif du lien`),
+    url: z.string().describe(`URL du lien`),
+  })
+  .describe('Un lien URL.');
diff --git a/backend/src/indicateurs/models/calcul-trajectoire-response-donnees.dto.ts b/backend/src/indicateurs/models/calcul-trajectoire-response-donnees.dto.ts
@@ -1,16 +1,13 @@
-import { extendApi } from '@anatine/zod-openapi';
 import { z } from 'zod';
 import { indicateurAvecValeursSchema } from './indicateur-valeur.table';
 
-export const calculTrajectoireResponseDonneesSchema = extendApi(
-  z
-    .object({
-      emissionsGes: z.array(indicateurAvecValeursSchema),
-      consommationsFinales: z.array(indicateurAvecValeursSchema),
-      sequestrations: z.array(indicateurAvecValeursSchema),
-    })
-    .describe('Données de la trajectoire SNBC')
-);
+export const calculTrajectoireResponseDonneesSchema = z
+  .object({
+    emissionsGes: z.array(indicateurAvecValeursSchema),
+    consommationsFinales: z.array(indicateurAvecValeursSchema),
+    sequestrations: z.array(indicateurAvecValeursSchema),
+  })
+  .describe('Données de la trajectoire SNBC');
 export type CalculTrajectoireResponseDonneesType = z.infer<
   typeof calculTrajectoireResponseDonneesSchema
 >;
diff --git a/backend/src/indicateurs/models/calcul-trajectoire.request.ts b/backend/src/indicateurs/models/calcul-trajectoire.request.ts
@@ -1,4 +1,3 @@
-import { extendApi } from '@anatine/zod-openapi';
 import { z } from 'zod';
 import { collectiviteRequestSchema } from '../../collectivites/collectivite.request';
 
@@ -13,21 +12,19 @@ export enum CalculTrajectoireResultatMode {
   MAJ_SPREADSHEET_EXISTANT = 'maj_spreadsheet_existant',
 }
 
-export const calculTrajectoireRequestSchema = extendApi(
-  collectiviteRequestSchema.extend({
-    mode: z
-      .nativeEnum(CalculTrajectoireReset)
-      .optional()
-      .describe('Mode pour forcer la recréation de la trajectoire'),
-    forceUtilisationDonneesCollectivite: z
-      .enum(['true', 'false'])
-      .transform((value) => value === 'true')
-      .optional()
-      .describe(
-        "Force l'utilisation des données de la collectivité plutôt que celles du rare"
-      ),
-  })
-);
+export const calculTrajectoireRequestSchema = collectiviteRequestSchema.extend({
+  mode: z
+    .nativeEnum(CalculTrajectoireReset)
+    .optional()
+    .describe('Mode pour forcer la recréation de la trajectoire'),
+  forceUtilisationDonneesCollectivite: z
+    .enum(['true', 'false'])
+    .transform((value) => value === 'true')
+    .optional()
+    .describe(
+      "Force l'utilisation des données de la collectivité plutôt que celles du rare"
+    ),
+});
 export type CalculTrajectoireRequestType = z.infer<
   typeof calculTrajectoireRequestSchema
 >;
diff --git a/backend/src/indicateurs/models/calcul-trajectoire.response.ts b/backend/src/indicateurs/models/calcul-trajectoire.response.ts
@@ -1,18 +1,15 @@
-import { extendApi } from '@anatine/zod-openapi';
 import { z } from 'zod';
 import { calculTrajectoireResponseDonneesSchema } from './calcul-trajectoire-response-donnees.dto';
 import { CalculTrajectoireResultatMode } from './calcul-trajectoire.request';
 
-export const calculTrajectoireResponseSchema = extendApi(
-  z
-    .object({
-      mode: z.nativeEnum(CalculTrajectoireResultatMode),
-      sourcesDonneesEntree: z.string().array(),
-      indentifiantsReferentielManquantsDonneesEntree: z.array(z.string()),
-      trajectoire: calculTrajectoireResponseDonneesSchema,
-    })
-    .describe('Réponse du calcul de la trajectoire SNBC')
-);
+export const calculTrajectoireResponseSchema = z
+  .object({
+    mode: z.nativeEnum(CalculTrajectoireResultatMode),
+    sourcesDonneesEntree: z.string().array(),
+    indentifiantsReferentielManquantsDonneesEntree: z.array(z.string()),
+    trajectoire: calculTrajectoireResponseDonneesSchema,
+  })
+  .describe('Réponse du calcul de la trajectoire SNBC');
 export type CalculTrajectoireResponseType = z.infer<
   typeof calculTrajectoireResponseSchema
 >;

diff --git a/backend/src/indicateurs/models/delete-indicateurs.request.ts b/backend/src/indicateurs/models/delete-indicateurs.request.ts
@@ -1,28 +1,25 @@
-import { extendApi } from '@anatine/zod-openapi';
 import { z } from 'zod';
 
-export const deleteIndicateursValeursRequestSchema = extendApi(
-  z
-    .object({
-      collectiviteId: z.coerce
-        .number()
-        .int()
-        .describe('Identifiant de la collectivité'),
-      indicateurId: z.coerce
-        .number()
-        .int()
-        .optional()
-        .describe("Identifiant de l'indicateur"),
-      metadonneeId: z.coerce
-        .number()
-        .int()
-        .optional()
-        .describe(
-          'Identifiant de la métadonnée permettant de sélectionner une source'
-        ),
-    })
-    .describe('Filtre de suppression des valeurs des indicateurs')
-);
+export const deleteIndicateursValeursRequestSchema = z
+  .object({
+    collectiviteId: z.coerce
+      .number()
+      .int()
+      .describe('Identifiant de la collectivité'),
+    indicateurId: z.coerce
+      .number()
+      .int()
+      .optional()
+      .describe("Identifiant de l'indicateur"),
+    metadonneeId: z.coerce
+      .number()
+      .int()
+      .optional()
+      .describe(
+        'Identifiant de la métadonnée permettant de sélectionner une source'
+      ),
+  })
+  .describe('Filtre de suppression des valeurs des indicateurs');
 export type DeleteIndicateursValeursRequestType = z.infer<
   typeof deleteIndicateursValeursRequestSchema
 >;
diff --git a/backend/src/indicateurs/models/delete-indicateurs.response.ts b/backend/src/indicateurs/models/delete-indicateurs.response.ts
@@ -1,13 +1,10 @@
-import { extendApi } from '@anatine/zod-openapi';
 import { z } from 'zod';
 
-export const deleteIndicateursValeursResponseSchema = extendApi(
-  z
-    .object({
-      indicateurValeurIdsSupprimes: z.array(z.number().int()),
-    })
-    .describe('Identifiant des valeurs supprimées')
-);
+export const deleteIndicateursValeursResponseSchema = z
+  .object({
+    indicateurValeurIdsSupprimes: z.array(z.number().int()),
+  })
+  .describe('Identifiant des valeurs supprimées');
 
 export type DeleteIndicateursValeursResponseType = z.infer<
   typeof deleteIndicateursValeursResponseSchema

diff --git a/backend/src/indicateurs/models/donnees-a-remplir-result.dto.ts b/backend/src/indicateurs/models/donnees-a-remplir-result.dto.ts
@@ -1,13 +1,10 @@
-import { extendApi } from "@anatine/zod-openapi";
-import { z } from "zod";
-import { donneesARemplirValeurSchema } from "./donnees-a-remplir-valeur.dto";
+import { z } from 'zod';
+import { donneesARemplirValeurSchema } from './donnees-a-remplir-valeur.dto';
 
-export const donneesARemplirResultSchema = extendApi(
-    z.object({
-      valeurs: z.array(donneesARemplirValeurSchema),
-      identifiantsReferentielManquants: z.array(z.string()),
-    })
-  );
-  export type DonneesARemplirResultType = z.infer<
-    typeof donneesARemplirResultSchema
-  >;
+export const donneesARemplirResultSchema = z.object({
+  valeurs: z.array(donneesARemplirValeurSchema),
+  identifiantsReferentielManquants: z.array(z.string()),
+});
+export type DonneesARemplirResultType = z.infer<
+  typeof donneesARemplirResultSchema
+>;
diff --git a/backend/src/indicateurs/models/donnees-a-remplir-valeur.dto.ts b/backend/src/indicateurs/models/donnees-a-remplir-valeur.dto.ts
@@ -1,14 +1,11 @@
-import { extendApi } from "@anatine/zod-openapi";
-import { z } from "zod";
+import { z } from 'zod';
 
-export const donneesARemplirValeurSchema = extendApi(
-    z.object({
-      identifiantsReferentiel: z.array(z.string()),
-      valeur: z.number().nullable(),
-      dateMin: z.string().nullable(),
-      dateMax: z.string().nullable(),
-    })
-  );
-  export type DonneesARemplirValeurType = z.infer<
-    typeof donneesARemplirValeurSchema
-  >;
+export const donneesARemplirValeurSchema = z.object({
+  identifiantsReferentiel: z.array(z.string()),
+  valeur: z.number().nullable(),
+  dateMin: z.string().nullable(),
+  dateMax: z.string().nullable(),
+});
+export type DonneesARemplirValeurType = z.infer<
+  typeof donneesARemplirValeurSchema
+>;
diff --git a/backend/src/indicateurs/models/donnees-calcul-trajectoire-a-remplir.dto.ts b/backend/src/indicateurs/models/donnees-calcul-trajectoire-a-remplir.dto.ts
@@ -1,15 +1,12 @@
-import { extendApi } from '@anatine/zod-openapi';
 import { z } from 'zod';
 import { donneesARemplirResultSchema } from './donnees-a-remplir-result.dto';
 
-export const donneesCalculTrajectoireARemplirSchema = extendApi(
-  z.object({
-    sources: z.string().array(),
-    emissionsGes: donneesARemplirResultSchema,
-    consommationsFinales: donneesARemplirResultSchema,
-    sequestrations: donneesARemplirResultSchema,
-  })
-);
+export const donneesCalculTrajectoireARemplirSchema = z.object({
+  sources: z.string().array(),
+  emissionsGes: donneesARemplirResultSchema,
+  consommationsFinales: donneesARemplirResultSchema,
+  sequestrations: donneesARemplirResultSchema,
+});
 export type DonneesCalculTrajectoireARemplirType = z.infer<
   typeof donneesCalculTrajectoireARemplirSchema
 >;
diff --git a/backend/src/indicateurs/models/export-indicateurs.request.ts b/backend/src/indicateurs/models/export-indicateurs.request.ts
@@ -1,21 +1,15 @@
-import { extendApi } from '@anatine/zod-openapi';
 import { z } from 'zod';
 
-export const exportIndicateursRequestSchema = extendApi(
-  z
-    .object({
-      collectiviteId: z
-        .number()
-        .int()
-        .describe('Identifiant de la collectivité'),
-      indicateurIds: z
-        .number()
-        .int()
-        .array()
-        .describe('Identifiants des indicateurs'),
-    })
-    .describe('Export des indicateurs')
-);
+export const exportIndicateursRequestSchema = z
+  .object({
+    collectiviteId: z.number().int().describe('Identifiant de la collectivité'),
+    indicateurIds: z
+      .number()
+      .int()
+      .array()
+      .describe('Identifiants des indicateurs'),
+  })
+  .describe('Export des indicateurs');
 export type ExportIndicateursRequestType = z.infer<
   typeof exportIndicateursRequestSchema
 >;