-
Notifications
You must be signed in to change notification settings - Fork 8
/
openapi.yaml
1510 lines (1483 loc) · 48.6 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: API Ecobalyse
description: L'API HTTP Ecobalyse permet de calculer les impacts environnementaux des produits textiles et alimentaires.
version: 0.0.1-alpha
externalDocs:
description: Visiter le site
url: https://ecobalyse.beta.gouv.fr
servers:
- url: https://ecobalyse.beta.gouv.fr/api
tags:
- name: Commun
description: Documentation de l'API multi-domaines au format OpenAPI
externalDocs:
description: À propos
url: https://fabrique-numerique.gitbook.io/ecobalyse
- name: Textile
description: Documentation de l'API pour le domaine textile au format OpenAPI
externalDocs:
description: À propos
url: https://fabrique-numerique.gitbook.io/ecobalyse
- name: Alimentaire
description: |
Documentation de l'API pour le domaine alimentaire au format OpenAPI
**⚠️ En construction, les résultats fournis sont incomplets et probablement invalides.**
externalDocs:
description: À propos
url: https://fabrique-numerique.gitbook.io/ecobalyse
security:
- token: []
paths:
/:
get:
tags:
- Commun
summary: Documentation OpenAPI de l'API
description: Sert la documentation de l'API au format [OpenAPI](https://swagger.io/specification/)
responses:
200:
description: Documentation de l'API au format OpenAPI.
/textile/countries:
get:
tags:
- Textile
summary: Liste des pays utilisables pour les simulations textiles.
responses:
200:
description: Opération réussie
content:
application/json:
schema:
$ref: "#/components/schemas/CountryListResponse"
/textile/materials:
get:
tags:
- Textile
summary: Liste des matières textile
responses:
200:
description: Opération réussie
content:
application/json:
schema:
$ref: "#/components/schemas/MaterialListResponse"
/textile/products:
get:
tags:
- Textile
summary: Liste des types de produits textiles
responses:
200:
description: Opération réussie
content:
application/json:
schema:
$ref: "#/components/schemas/ProductListResponse"
/textile/simulator:
get:
tags:
- Textile
summary: Calcul des impacts environnementaux d'un produit textile
parameters:
- $ref: "#/components/parameters/massParam"
- $ref: "#/components/parameters/materialsParam"
- $ref: "#/components/parameters/productParam"
- $ref: "#/components/parameters/countrySpinningParam"
- $ref: "#/components/parameters/countryFabricParam"
- $ref: "#/components/parameters/countryDyeingParam"
- $ref: "#/components/parameters/countryMakingParam"
- $ref: "#/components/parameters/fabricProcessParam"
- $ref: "#/components/parameters/airTransportRatioParam"
- $ref: "#/components/parameters/makingWasteParam"
- $ref: "#/components/parameters/makingDeadStockParam"
- $ref: "#/components/parameters/makingComplexityParam"
- $ref: "#/components/parameters/yarnSizeParam"
- $ref: "#/components/parameters/surfaceMassParam"
- $ref: "#/components/parameters/fadingParam"
- $ref: "#/components/parameters/disabledStepsParam"
- $ref: "#/components/parameters/dyeingMediumParam"
- $ref: "#/components/parameters/printingParam"
- $ref: "#/components/parameters/businessParam"
- $ref: "#/components/parameters/numberOfReferencesParam"
- $ref: "#/components/parameters/priceParam"
- $ref: "#/components/parameters/marketingDurationParam"
- $ref: "#/components/parameters/traceabilityParam"
responses:
200:
description: Opération réussie
content:
application/json:
schema:
$ref: "#/components/schemas/GenericImpactsResponse"
400:
description: Paramètres invalides
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParametersError"
post:
tags:
- Textile
summary: Calcul des impacts environnementaux d'un produit textile
requestBody:
description: Requête modélisant les paramètres du produit à évaluer
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/TextileQuery"
examples:
tShirtFrance:
$ref: "#/components/examples/tShirtFrance"
tShirtChina:
$ref: "#/components/examples/tShirtChina"
responses:
200:
description: Opération réussie
content:
application/json:
schema:
$ref: "#/components/schemas/GenericImpactsResponse"
400:
description: Paramètres invalides
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParametersError"
/textile/simulator/{impact}:
get:
tags:
- Textile
summary: Calcul d'un impact environnemental spécifique d'un produit textile
parameters:
- $ref: "#/components/parameters/impactUrlParam"
- $ref: "#/components/parameters/massParam"
- $ref: "#/components/parameters/materialsParam"
- $ref: "#/components/parameters/productParam"
- $ref: "#/components/parameters/countrySpinningParam"
- $ref: "#/components/parameters/countryFabricParam"
- $ref: "#/components/parameters/countryDyeingParam"
- $ref: "#/components/parameters/countryMakingParam"
- $ref: "#/components/parameters/fabricProcessParam"
- $ref: "#/components/parameters/airTransportRatioParam"
- $ref: "#/components/parameters/makingWasteParam"
- $ref: "#/components/parameters/makingDeadStockParam"
- $ref: "#/components/parameters/makingComplexityParam"
- $ref: "#/components/parameters/yarnSizeParam"
- $ref: "#/components/parameters/surfaceMassParam"
- $ref: "#/components/parameters/fadingParam"
- $ref: "#/components/parameters/disabledStepsParam"
- $ref: "#/components/parameters/dyeingMediumParam"
- $ref: "#/components/parameters/printingParam"
- $ref: "#/components/parameters/businessParam"
- $ref: "#/components/parameters/numberOfReferencesParam"
- $ref: "#/components/parameters/priceParam"
- $ref: "#/components/parameters/marketingDurationParam"
- $ref: "#/components/parameters/traceabilityParam"
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/SingleImpactResponse"
400:
description: Paramètres invalides
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParametersError"
post:
tags:
- Textile
summary: Calcul des impacts environnementaux d'un produit textile
parameters:
- $ref: "#/components/parameters/impactUrlParam"
requestBody:
description: Requête modélisant les paramètres du produit à évaluer
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/TextileQuery"
examples:
tShirtFrance:
$ref: "#/components/examples/tShirtFrance"
tShirtChina:
$ref: "#/components/examples/tShirtChina"
responses:
200:
description: Opération réussie
content:
application/json:
schema:
$ref: "#/components/schemas/GenericImpactsResponse"
400:
description: Paramètres invalides
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParametersError"
/textile/simulator/detailed:
get:
tags:
- Textile
summary: Calcul exhaustif des impacts environnementaux d'un produit textile
description: L'intégralité des calculs intermédiaires sont présentés dans une réponse détaillée
parameters:
- $ref: "#/components/parameters/massParam"
- $ref: "#/components/parameters/materialsParam"
- $ref: "#/components/parameters/productParam"
- $ref: "#/components/parameters/countrySpinningParam"
- $ref: "#/components/parameters/countryFabricParam"
- $ref: "#/components/parameters/countryDyeingParam"
- $ref: "#/components/parameters/countryMakingParam"
- $ref: "#/components/parameters/fabricProcessParam"
- $ref: "#/components/parameters/airTransportRatioParam"
- $ref: "#/components/parameters/makingWasteParam"
- $ref: "#/components/parameters/makingDeadStockParam"
- $ref: "#/components/parameters/makingComplexityParam"
- $ref: "#/components/parameters/yarnSizeParam"
- $ref: "#/components/parameters/surfaceMassParam"
- $ref: "#/components/parameters/fadingParam"
- $ref: "#/components/parameters/disabledStepsParam"
- $ref: "#/components/parameters/dyeingMediumParam"
- $ref: "#/components/parameters/printingParam"
- $ref: "#/components/parameters/businessParam"
- $ref: "#/components/parameters/numberOfReferencesParam"
- $ref: "#/components/parameters/priceParam"
- $ref: "#/components/parameters/marketingDurationParam"
- $ref: "#/components/parameters/traceabilityParam"
responses:
200:
description: Opération réussie
content:
application/json:
schema:
type: object
400:
description: Paramètres invalides
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParametersError"
post:
tags:
- Textile
summary: Calcul des impacts environnementaux d'un produit textile
requestBody:
description: Requête modélisant les paramètres du produit à évaluer
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/TextileQuery"
examples:
tShirtFrance:
$ref: "#/components/examples/tShirtFrance"
tShirtChina:
$ref: "#/components/examples/tShirtChina"
responses:
200:
description: Opération réussie
content:
application/json:
schema:
type: object
400:
description: Paramètres invalides
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParametersError"
# /food/countries:
# get:
# tags:
# - Alimentaire
# summary: Liste des pays utilisables pour les simulations alimentairess.
# responses:
# 200:
# description: Opération réussie
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/CountryListResponse"
# /food/ingredients:
# get:
# tags:
# - Alimentaire
# summary: Liste des ingrédients disponibles pour élaborer une recette
# responses:
# 200:
# description: Opération réussie
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/IngredientListResponse"
# /food/transforms:
# get:
# tags:
# - Alimentaire
# summary: Liste des procédés de transformation alimentaire
# responses:
# 200:
# description: Opération réussie
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/TransformListResponse"
# /food/packagings:
# get:
# tags:
# - Alimentaire
# summary: Liste des emballages disponibles pour conditionner une recette
# responses:
# 200:
# description: Opération réussie
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/PackagingListResponse"
# /food:
# get:
# tags:
# - Alimentaire
# summary: Calcul des impacts environnementaux d'une recette alimentaire
# parameters:
# - $ref: "#/components/parameters/ingredientsParam"
# - $ref: "#/components/parameters/transformParam"
# - $ref: "#/components/parameters/packagingParam"
# - $ref: "#/components/parameters/distributionParam"
# - $ref: "#/components/parameters/preparationParam"
# responses:
# 200:
# description: Opération réussie
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/RecipeResultsResponse"
# 400:
# description: Paramètres invalides
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/InvalidParametersError"
# post:
# tags:
# - Alimentaire
# summary: Calcul des impacts environnementaux d'une recette alimentaire
# requestBody:
# description: Requête modélisant les éléments de la recette à évaluer
# required: true
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/FoodQuery"
# examples:
# CarrotCake:
# summary: "Carrot cake conventionnel"
# value:
# ingredients:
# - id: egg
# mass: 120
# - id: wheat
# mass: 140
# - id: milk
# mass: 60
# - id: carrot
# mass: 225
# transform:
# code: AGRIBALU000000003103966
# mass: 545
# packaging:
# - code: AGRIBALU000000003104019
# mass: 105
# distribution: ambient
# preparation:
# - refrigeration
# SpanishOrganicCarrotCake:
# summary: "Carrot cake bio, origine Espagne"
# value:
# ingredients:
# - id: egg-organic
# mass: 120
# country: ES
# - id: wheat-organic
# mass: 140
# country: ES
# - id: milk-organic
# mass: 60
# country: ES
# - id: carrot-organic
# mass: 225
# country: ES
# transform:
# code: AGRIBALU000000003103966
# mass: 545
# packaging:
# - code: AGRIBALU000000003104019
# mass: 105
# distribution: ambient
# preparation:
# - refrigeration
# BrazilianMango:
# summary: "Mangue du Brésil"
# value:
# ingredients:
# - id: mango
# mass: 500
# country: BR
# transform: null
# packaging: []
# distribution: ambient
# preparation: []
# responses:
# 200:
# description: Opération réussie
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/RecipeResultsResponse"
# 400:
# description: Paramètres invalides
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/InvalidParametersError"
components:
securitySchemes:
token:
description: >
Ce token d'API, permettant d'obtenir les impacts détaillés des calculs effectués,
peut être obtenu après [inscription préalable](https://ecobalyse.beta.gouv.fr/#/auth)
sur le site Ecobalyse. Vous trouverez le token dans la section *Mon compte*.
type: apiKey
name: token
in: header
examples:
tShirtFrance:
summary: "T-Shirt France 100% Coton"
value:
mass: 0.17
materials:
- id: "ei-coton"
share: 1
country: "FR"
product: "tshirt"
countrySpinning: "FR"
countryFabric: "FR"
countryDyeing: "FR"
countryMaking: "FR"
fabricProcess: "knitting-mix"
tShirtChina:
summary: "T-Shirt Chine, low-cost, 100% Coton"
value:
mass: 0.17
materials:
- id: "ei-coton"
share: 1
product: "tshirt"
countrySpinning: "CN"
countryFabric: "CN"
countryDyeing: "CN"
countryMaking: "CN"
airTransportRatio: 0.33
makingWaste: null
makingDeadStock: null
makingComplexity: null
yarnSize: null
surfaceMass: null
fabricProcess: "knitting-mix"
disabledSteps:
- use
parameters:
impactUrlParam:
name: impact
in: path
description: |
Trigramme de l'impact étudié ([la liste est documenté ici](https://fabrique-numerique.gitbook.io/ecobalyse/methodologie/impacts-consideres))
required: true
schema:
type: string
minLength: 3
maxLength: 3
default: "cch"
enum:
- "acd"
- "bvi"
- "cch"
- "ecs"
- "etf"
- "fru"
- "fwe"
- "htc"
- "htn"
- "ior"
- "ldu"
- "mru"
- "ozd"
- "pco"
- "pef"
- "pma"
- "swe"
- "tre"
- "wtu"
massParam:
name: mass
in: query
description: Masse du produit fini, **exprimée en kilogrammes**
required: true
style: form
schema:
type: number
minimum: 0.01
example: 0.17
materialsParam:
name: "materials[]"
in: query
description: |
Liste des matières composant le produit (liste disponible sur le point d'entrée `/textile/materials`).
Le format de chaque entrée est composé de l'identifiant de la matière et de la part du produit
qu'elle représente, optionnellement du [procédé de filature ou filage pour la matière](https://fabrique-numerique.gitbook.io/ecobalyse/textile/etapes-du-cycle-de-vie/etape-2-fabrication-du-fil-new-draft#hypotheses-par-defaut), et optionnellement du code du pays d'origine de la matière :
- `ei-coton;0.3` signifie *30% coton*;
- `ei-coton-rdp;0.7` signifie *70% coton recyclé (déchets de production)*;
- `ei-coton;0.3;UnconventionalSpinning` signifie *30% coton avec un procédé de filature non conventionel*
- `ei-coton;0.3;UnconventionalSpinning;FR` signifie *30% coton avec un procédé de filature non conventionel en provenance de France*
- `ei-coton;0.3;;FR` signifie *30% coton avec un procédé de filature par défaut en provenance de France*
> Par exemple, les paramètres à passer pour un t-shirt 30% coton, 30% coton recyclé et 40% acrylique sont :
>
> ```js
> materials[]=ei-coton;0.3&materials[]=coton-rdp;0.3&materials[]=acrylique;0.4
> ```
Le procédé de filature ou filage est à choisir entre :
- `ConventionalSpinning` : filature conventionnelle (à anneaux : ring spun) pour les matières naturelles ou artificielles
- `UnconventionalSpinning` : filature non conventionnelle (à bouts libérées : open-end) pour les matières naturelles ou artificielles
- `SyntheticSpinning` : filage pour les matières synthétiques
required: true
style: form
schema:
type: array
items:
type: string
examples:
coton:
value: ["ei-coton;1"]
acrylique:
value: ["ei-coton;0.7", "ei-pet;0.3"]
mixed:
value: ["ei-coton;0.3", "coton-rdp;0.3", "ei-pet;0.4"]
spinning:
value: ["ei-coton;0.96;UnconventionalSpinning"]
productParam:
name: product
in: query
description: Identifiant du produit (liste disponible sur le point d'entrée `/textile/products`)
required: true
style: form
schema:
type: string
examples:
tshirt:
value: "tshirt"
pantalon:
value: "pantalon"
countrySpinningParam:
name: countrySpinning
in: query
description: |
Code pays pour l'étape de **Filature** (liste disponible sur le point d'entrée `textile/countries`).
Si non spécifié, le pays de filature pris en considération est celui de production de
la matière la plus représentée dans le mix.
required: false
style: form
schema:
type: string
minLength: 2
maxLength: 2
examples:
Default:
value: ""
Chine:
value: "CN"
France:
value: "FR"
countryFabricParam:
name: countryFabric
in: query
description: |
Code pays pour l'étape de **Tissage/Tricotage** (liste disponible sur le point d'entrée `textile/countries`)
required: true
style: form
schema:
type: string
minLength: 2
maxLength: 2
examples:
Chine:
value: "CN"
France:
value: "FR"
countryDyeingParam:
name: countryDyeing
in: query
description: "Code pays pour l'étape de **Teinture** (liste disponible sur le point d'entrée `textile/countries`)"
required: true
style: form
schema:
type: string
minLength: 2
maxLength: 2
examples:
Chine:
value: "CN"
France:
value: "FR"
countryMakingParam:
name: countryMaking
in: query
description: "Code pays pour l'étape de **Confection** (liste disponible sur le point d'entrée `textile/countries`)"
required: true
style: form
schema:
type: string
minLength: 2
maxLength: 2
examples:
Chine:
value: "CN"
France:
value: "FR"
airTransportRatioParam:
name: airTransportRatio
in: query
description: |
Part de **transport aérien** entre l'étape de **Confection** et l'étape de **Distribution**, entre `0` et `1`
required: false
style: form
schema:
type: number
minimum: 0
maximum: 1
businessParam:
name: business
in: query
description: |
Type d'entreprise et d'offre de services :
- `small-business`: PME/TPE
- `large-business-with-services`: Grande entreprise proposant un service de réparation et de prise en garantie
- `large-business-without-services` (par défaut): Grande entreprise ne proposant pas de service de réparation ou de prise en garantie
required: false
style: form
schema:
type: string
enum:
- small-business
- large-business-with-services
- large-business-without-services
numberOfReferencesParam:
name: numberOfReferences
in: query
description: |
Nombre de références au catalogue de la marque.
required: false
style: form
schema:
type: number
minimum: 1
maximum: 999999
priceParam:
name: price
in: query
description: |
Prix du produit, en Euros (€).
required: false
style: form
schema:
type: number
minimum: 1
maximum: 1000
marketingDurationParam:
name: marketingDuration
in: query
description: |
Durée de commercialisation, en jours.
required: false
style: form
schema:
type: number
minimum: 1
maximum: 999
traceabilityParam:
name: traceability
in: query
description: |
Traçabilité renforcée
required: false
style: form
schema:
type: string
enum: ["true", "false"]
makingWasteParam:
name: makingWaste
in: query
description: |
Taux de perte en confection (incluant la découpe), entre `0` et `0.4`.
**⚠️ Sur les produits tricotés en "fully fashioned / seamless", ce paramètre n'a aucun impact (valeur fixe: 0.02).**
**⚠️ Sur les produits tricotés en "integral / whole garment", ce paramètre n'a aucun impact (valeur fixe: 0).**
required: false
style: form
schema:
type: number
minimum: 0
maximum: 0.4
makingDeadStockParam:
name: makingDeadStock
in: query
description: |
Taux de stocks dormants lors de la confection, entre `0` et `0.3`.
required: false
style: form
schema:
type: number
minimum: 0
maximum: 0.3
makingComplexityParam:
name: makingComplexity
in: query
description: |
Complexité de la confection, parmi la liste de choix suivants :
- `very-high` : très élevée
- `high` : élevée
- `medium` : moyenne
- `low` : faible
- `very-low` : très faible
**⚠️ Sur les produits tricotés en "fully fashioned / seamless", ce paramètre n'a aucun impact (valeur fixe: very-low).**
**⚠️ Sur les produits tricotés en "integral / whole garment", ce paramètre n'a aucun impact (valeur fixe: vide, non applicable).**
required: false
style: form
schema:
type: string
enum: ["very-high", "high", "medium", "low", "very-low"]
yarnSizeParam:
name: yarnSize
in: query
description: |
Titrage du fil exprimé en **numéro métrique** (`Nm`).
Il est aussi possible de l'exprimer en décitex (`Dtex`) en spécifiant l'unité.
Exemples de saisie :
- `40` : 40Nm
- `40Nm` : 40Nm
- `250Dtex` : 250Dtex, équivalent à 40Nm
required: false
style: form
schema:
type: string
minimum: 9
maximum: 200
fabricProcessParam:
name: fabricProcess
in: query
description: |
Le processus utilisé pour tisser ou tricoter le tissu, parmi la liste de choix suivants :
- `knitting-mix` : Tricotage moyen (mix de métiers circulaire & rectiligne)
- `knitting-fully-fashioned` : Tricotage fully-fashioned / seamless
- `knitting-integral` : Tricotage intégral / whole garment
- `knitting-circular` : Tricotage circulaire, inventaire désagrégé
- `knitting-straight` : Tricotage rectiligne, inventaire désagrégé
- `weaving` : Tissage
required: false
style: form
schema:
type: string
enum:
- knitting-mix
- knitting-fully-fashioned
- knitting-integral
- knitting-circular
- knitting-straight
- weaving
examples:
knitting-mix:
value: "knitting-mix"
knitting-fully-fashioned:
value: "knitting-fully-fashioned"
knitting-integral:
value: "knitting-integral"
knitting-circular:
value: "knitting-circular"
knitting-straight:
value: "knitting-straight"
weaving:
value: "weaving"
surfaceMassParam:
name: surfaceMass
in: query
description: |
Le grammage de l'étoffe, exprimé en gr/m², représente sa masse surfacique.
**⚠️ Sur les produits tricotés, ce paramètre n'impacte que l'impression.**
required: false
style: form
schema:
type: number
minimum: 80
maximum: 500
fadingParam:
name: fading
in: query
description: |
Active l'application du **procédé de délavage** pour l'étape de confection d'un produit.
required: false
style: form
schema:
type: string
enum: ["true", "false"]
examples:
default:
value: ""
enabled:
value: "true"
disabled:
value: "false"
disabledStepsParam:
name: disabledSteps
in: query
description: |
Liste des étapes du cycle de vie à désactiver, séparée par des virgules. Chaque étape est identifiée par un code :
- `material`: Matière
- `spinning`: Filature
- `fabric`: Tissage ou Tricotage
- `ennobling`: Ennoblissement (incluant le pré-traitement, la teinture et la finition)
- `making`: Confection
- `distribution`: Distribution
- `use`: Utilisation
- `eol`: Fin de vie
Par exemple, pour désactiver l'étape de filature ainsi que celle d'ennoblissement, on peut passer `disabledSteps=spinning,ennobling`.
required: false
style: form
schema:
type: string
examples:
default:
summary: "Aucune étape désactivée"
value: ""
making:
summary: "Confection desactivée"
value: "making"
spinningDyeing:
summary: "Filature et ennoblissement désactivés"
value: "spinning,ennobling"
dyeingMediumParam:
name: dyeingMedium
in: query
description: |
Ce paramètre permet de préciser le support sur lequel s'effectue la teinture ; il peut prendre les valeurs
suivantes :
- `article` lorsque la teinture est effectuée sur l'article ;
- `fabric` lorsqu'elle est effectuée sur le tissu ;
- `yarn` lorsqu'elle est effectuée sur le fil.
⚠️ En l'absence d'utilisation explicite du paramètre, le support de teinture utilisé sera celui affecté par
défaut à la famille de produit.
required: false
style: form
schema:
type: string
examples:
default:
summary: "par défaut, sur tissu"
value: ""
surArticle:
summary: "sur article"
value: "article"
surTissu:
summary: "sur tissu"
value: "fabric"
surFil:
summary: "sur fil"
value: "yarn"
printingParam:
name: printing
in: query
description: |
Ce paramètre permet de préciser le type d'impression effectuée sur le produit, suivi du pourcentage de
surface teinte. Par exemple, `pigment;0.1` signifie impression pigmentaire sur 10% de la superficie du
vêtement. L'identifiant de procédé d'impression peut prendre les valeurs suivantes :
- `pigment` pour une impression pigmentaire ;
- `substantive` pour une impression fixé/lavé ;
required: false
style: form
schema:
type: string
examples:
default:
summary: "Aucune impression"
value: ""
pigment:
summary: "Pigmentaire sur 50% de la surface"
value: "pigment;0.5"
substantive:
summary: "Fixé/Lavé sur 20% de la surface"
value: "substantive;0.2"
ingredientsParam:
name: "ingredients[]"
in: query
description: |
Liste des ingrédients composant la recette (liste disponible sur le point d'entrée `/food/ingredients`).
Le format de chaque entrée est composé de :
- l'identifiant de la matière (pour avoir la liste, utiliser l'API de liste d'ingrédients)
- sa masse **exprimée en grammes**
- un éventuel code de pays d'origine (ex: `BR` pour le Brésil)
- un éventuel transport par avion *uniquement si c'est un [ingrédient de catégorie
"HORS EUROPE-MAGHREB (AVION)"](https://fabrique-numerique.gitbook.io/ecobalyse/alimentaire/transport#circuits-consideres)*
(valeurs possible: `<vide>`, `byPlane`, `noPlane`)
Quelques exemples :
- `milk;268` signifie *268g de lait*;
- `tomato;123;ES` signifie *123g de tomates conventionnelles en provenance d'Espagne*;
- `mango;123` signifie *123g de mangues en provenance de son origine par défaut (hors Europe-Maghreb, transport par avion)*;
- `mango;123;;noPlane` signifie *123g de mangues en provenance de son origine par défaut (hors Europe-Maghreb), par bateau*;
- `mango;123;BR` signifie *123g de mangues en provenance du Brésil, par avion*;
- `mango;123;BR;byPlane` signifie de la même manière *123g de mangues en provenance du Brésil, par avion*;
- `mango;123;BR;noPlane` signifie *123g de mangues en provenance du Brésil, par bateau (pas par avion)*;
> Par exemple, les paramètres à passer pour une recette à base de 268g de lait et 30g de carrotes bio d'espagne sont :
>
> ```js
> ingredients[]=milk;268&ingredients[]=carrot-organic;30;ES
> ```
required: true
style: form
schema:
type: array
items:
type: string
examples:
oneIngredient:
summary: Lait
value: ["milk;268"]
twoIngredients:
summary: Lait, carrotes bio
value: ["milk;268", "carrot-organic;30"]
threeIngredients:
summary: Lait, carrotes bio, oeuf
value: ["milk;268", "carrot-organic;30", "egg;149"]
fourIngredients:
summary: Lait, carrotes bio, oeuf, tomates d'espagne
value: ["milk;268", "carrot-organic;30", "egg;149", "tomato;123;;ES"]
byPlane:
summary: Mangue du Brésil par avion
value: ["mango;123;;BR"]
noPlane:
summary: Mangue du Brésil par bateau
value: ["mango;123;;BR;noPlane"]
packagingParam:
name: "packaging[]"
in: query
description: |
Liste des emballages composant la recette (liste disponible sur le point d'entrée `/food/packaging`).
Le format de chaque entrée est composé de l'identifiant de l'emballage et de sa masse **exprimée en grammes**.
required: true
style: form
schema:
type: array