docs(API Stats): Ajout des filtres dans la documentation #5091
+19
−6
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
raphodn
approved these changes
Mar 5, 2025
| include_in_documentation = True | ||
| serializer_class = CanteenStatisticsSerializer | ||
|
|
||
| @extend_schema( |
There was a problem hiding this comment.
j'ai un peu re-regardé pour utiliser des filterset_class, mais ca semble effectivement nécessairement rattaché à un model, et ca va filtrer le queryset en amont de la view. donc OpenApiParameter it is..
| @@ -40,11 +53,11 @@ def get(self, request): | |||
| canteens = self._filter_canteens(regions, departments, city_insee_codes, sector_categories) | |||
| diagnostics = self._filter_diagnostics(year, regions, departments, city_insee_codes, sector_categories) | |||
|
|
|||
| data = CanteenStatisticsSerializer.calculate_statistics(canteens, diagnostics) | |||
| data = self.serializer_class.calculate_statistics(canteens, diagnostics) | |||
There was a problem hiding this comment.
je ne sais pas si t'as prévu des refacto supplémentaires, mais sortir calculate_statistics de CanteenStatisticsSerializer serait une bonne chose je pense (réduire au max la logique dans les serializer, pour la basculer dans les modèles ou des utils, et à la rigueur la view)
|
|
||
| @extend_schema( | ||
| parameters=[ | ||
| OpenApiParameter(name="year", type=str, description="Filter by year of declared data", required=True), |
There was a problem hiding this comment.
dans l'UI il les classe par ordre alphabétique on dirait
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.