From 434dadf6e025939b0134b9aee2c43a8547f2d42c Mon Sep 17 00:00:00 2001 From: indyandie <1058837+Indyandie@users.noreply.github.com> Date: Sat, 11 May 2024 02:28:19 -0500 Subject: [PATCH] refactor(oas): add decorators to `PokeapiCommonViewset` class --- openapi.yml | 16 +-- pokemon_v2/api.py | 354 +++++++++++++--------------------------------- 2 files changed, 108 insertions(+), 262 deletions(-) diff --git a/openapi.yml b/openapi.yml index c570943d..e2c77654 100644 --- a/openapi.yml +++ b/openapi.yml @@ -34,6 +34,12 @@ paths: description: The initial index from which to return the results. schema: type: integer + - in: query + name: q + schema: + type: string + description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ + Case-insensitive query applied on the `name` property. " tags: - pokemon security: @@ -1501,12 +1507,6 @@ paths: description: The initial index from which to return the results. schema: type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " tags: - location security: @@ -1530,8 +1530,8 @@ paths: - in: path name: id schema: - type: string - description: This parameter can be a string or an integer. + type: integer + description: A unique integer value identifying this location area. required: true tags: - location diff --git a/pokemon_v2/api.py b/pokemon_v2/api.py index 7a7a7304..dac98772 100644 --- a/pokemon_v2/api.py +++ b/pokemon_v2/api.py @@ -71,15 +71,12 @@ class NameOrIdRetrieval: return resp -class PokeapiCommonViewset( - ListOrDetailSerialRelation, NameOrIdRetrieval, viewsets.ReadOnlyModelViewSet -): - pass - - -########## -# APIS # -########## +q_query_string_parameter = OpenApiParameter( + name="q", + description="> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\nCase-insensitive query applied on the `name` property. ", + location=OpenApiParameter.QUERY, + type=OpenApiTypes.STR, +) retrieve_path_parameter = OpenApiParameter( name="id", @@ -89,12 +86,21 @@ retrieve_path_parameter = OpenApiParameter( required=True, ) -q_query_string_parameter = OpenApiParameter( - name="q", - description="> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\nCase-insensitive query applied on the `name` property. ", - location=OpenApiParameter.QUERY, - type=OpenApiTypes.STR, -) + +@extend_schema_view(list=extend_schema(parameters=[q_query_string_parameter])) +class PokeapiCommonViewset( + ListOrDetailSerialRelation, NameOrIdRetrieval, viewsets.ReadOnlyModelViewSet +): + @extend_schema(parameters=[retrieve_path_parameter]) + def retrieve(self, request, pk=None): + return super().retrieve(request, pk) + + pass + + +########## +# APIS # +########## @extend_schema( @@ -106,10 +112,6 @@ class AbilityResource(PokeapiCommonViewset): serializer_class = AbilityDetailSerializer list_serializer_class = AbilitySummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by Pokémon. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail.", @@ -117,17 +119,15 @@ class AbilityResource(PokeapiCommonViewset): summary="Get a berry", ) @extend_schema_view( - list=extend_schema(summary="List berries", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List berries", + ) ) class BerryResource(PokeapiCommonViewset): queryset = Berry.objects.all() serializer_class = BerryDetailSerializer list_serializer_class = BerrySummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail.", @@ -136,7 +136,7 @@ class BerryResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List berry firmness", parameters=[q_query_string_parameter] + summary="List berry firmness", ) ) class BerryFirmnessResource(PokeapiCommonViewset): @@ -144,10 +144,6 @@ class BerryFirmnessResource(PokeapiCommonViewset): serializer_class = BerryFirmnessDetailSerializer list_serializer_class = BerryFirmnessSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their **nature**. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail.", @@ -156,7 +152,7 @@ class BerryFirmnessResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List berry flavors", parameters=[q_query_string_parameter] + summary="List berry flavors", ) ) class BerryFlavorResource(PokeapiCommonViewset): @@ -164,10 +160,6 @@ class BerryFlavorResource(PokeapiCommonViewset): serializer_class = BerryFlavorDetailSerializer list_serializer_class = BerryFlavorSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) for greater detail.", @@ -176,7 +168,7 @@ class BerryFlavorResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List charecterictics", parameters=[q_query_string_parameter] + summary="List charecterictics", ) ) class CharacteristicResource(PokeapiCommonViewset): @@ -184,10 +176,6 @@ class CharacteristicResource(PokeapiCommonViewset): serializer_class = CharacteristicDetailSerializer list_serializer_class = CharacteristicSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Contest effects refer to the effects of moves when used in contests.", @@ -196,7 +184,7 @@ class CharacteristicResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List contest effects", parameters=[q_query_string_parameter] + summary="List contest effects", ) ) class ContestEffectResource(PokeapiCommonViewset): @@ -204,10 +192,6 @@ class ContestEffectResource(PokeapiCommonViewset): serializer_class = ContestEffectDetailSerializer list_serializer_class = ContestEffectSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Contest types are categories judges used to weigh a Pokémon's condition in Pokémon contests. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Contest_condition) for greater detail.", @@ -216,7 +200,7 @@ class ContestEffectResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List contest types", parameters=[q_query_string_parameter] + summary="List contest types", ) ) class ContestTypeResource(PokeapiCommonViewset): @@ -224,10 +208,6 @@ class ContestTypeResource(PokeapiCommonViewset): serializer_class = ContestTypeDetailSerializer list_serializer_class = ContestTypeSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater detail.", @@ -235,17 +215,15 @@ class ContestTypeResource(PokeapiCommonViewset): tags=["pokemon"], ) @extend_schema_view( - list=extend_schema(summary="List egg groups", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List egg groups", + ) ) class EggGroupResource(PokeapiCommonViewset): queryset = EggGroup.objects.all() serializer_class = EggGroupDetailSerializer list_serializer_class = EggGroupSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Conditions which affect what pokemon might appear in the wild, e.g., day or night.", @@ -254,7 +232,7 @@ class EggGroupResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List encounter conditions", parameters=[q_query_string_parameter] + summary="List encounter conditions", ) ) class EncounterConditionResource(PokeapiCommonViewset): @@ -262,10 +240,6 @@ class EncounterConditionResource(PokeapiCommonViewset): serializer_class = EncounterConditionDetailSerializer list_serializer_class = EncounterConditionSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Encounter condition values are the various states that an encounter condition can have, i.e., time of day can be either day or night.", @@ -274,7 +248,7 @@ class EncounterConditionResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List encounter condition values", parameters=[q_query_string_parameter] + summary="List encounter condition values", ) ) class EncounterConditionValueResource(PokeapiCommonViewset): @@ -282,10 +256,6 @@ class EncounterConditionValueResource(PokeapiCommonViewset): serializer_class = EncounterConditionValueDetailSerializer list_serializer_class = EncounterConditionValueSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Methods by which the player might can encounter Pokémon in the wild, e.g., walking in tall grass. Check out Bulbapedia for greater detail.", @@ -294,7 +264,7 @@ class EncounterConditionValueResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List encounter methods", parameters=[q_query_string_parameter] + summary="List encounter methods", ) ) class EncounterMethodResource(PokeapiCommonViewset): @@ -302,10 +272,6 @@ class EncounterMethodResource(PokeapiCommonViewset): serializer_class = EncounterMethodDetailSerializer list_serializer_class = EncounterMethodSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as Pokémon they can evolve into up through the hierarchy.", @@ -314,7 +280,7 @@ class EncounterMethodResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List evolution chains", parameters=[q_query_string_parameter] + summary="List evolution chains", ) ) class EvolutionChainResource(PokeapiCommonViewset): @@ -322,10 +288,6 @@ class EvolutionChainResource(PokeapiCommonViewset): serializer_class = EvolutionChainDetailSerializer list_serializer_class = EvolutionChainSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) for greater detail.", @@ -334,7 +296,7 @@ class EvolutionChainResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List evolution triggers", parameters=[q_query_string_parameter] + summary="List evolution triggers", ) ) class EvolutionTriggerResource(PokeapiCommonViewset): @@ -342,10 +304,6 @@ class EvolutionTriggerResource(PokeapiCommonViewset): serializer_class = EvolutionTriggerDetailSerializer list_serializer_class = EvolutionTriggerSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released.", @@ -353,17 +311,15 @@ class EvolutionTriggerResource(PokeapiCommonViewset): tags=["games"], ) @extend_schema_view( - list=extend_schema(summary="List genrations", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List genrations", + ) ) class GenerationResource(PokeapiCommonViewset): queryset = Generation.objects.all() serializer_class = GenerationDetailSerializer list_serializer_class = GenerationSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Genders were introduced in Generation II for the purposes of breeding Pokémon but can also result in visual differences or even different evolutionary lines. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Gender) for greater detail.", @@ -371,17 +327,15 @@ class GenerationResource(PokeapiCommonViewset): tags=["pokemon"], ) @extend_schema_view( - list=extend_schema(summary="List genders", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List genders", + ) ) class GenderResource(PokeapiCommonViewset): queryset = Gender.objects.all() serializer_class = GenderDetailSerializer list_serializer_class = GenderSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Growth rates are the speed with which Pokémon gain levels through experience. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Experience) for greater detail.", @@ -390,7 +344,7 @@ class GenderResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List growth rates", parameters=[q_query_string_parameter] + summary="List growth rates", ) ) class GrowthRateResource(PokeapiCommonViewset): @@ -398,10 +352,6 @@ class GrowthRateResource(PokeapiCommonViewset): serializer_class = GrowthRateDetailSerializer list_serializer_class = GrowthRateSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area.", @@ -409,17 +359,15 @@ class GrowthRateResource(PokeapiCommonViewset): tags=["items"], ) @extend_schema_view( - list=extend_schema(summary="List items", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List items", + ) ) class ItemResource(PokeapiCommonViewset): queryset = Item.objects.all() serializer_class = ItemDetailSerializer list_serializer_class = ItemSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Item categories determine where items will be placed in the players bag.", @@ -428,7 +376,7 @@ class ItemResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List item categories", parameters=[q_query_string_parameter] + summary="List item categories", ) ) class ItemCategoryResource(PokeapiCommonViewset): @@ -436,10 +384,6 @@ class ItemCategoryResource(PokeapiCommonViewset): serializer_class = ItemCategoryDetailSerializer list_serializer_class = ItemCategorySummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description='Item attributes define particular aspects of items, e.g."usable in battle" or "consumable".', @@ -448,7 +392,7 @@ class ItemCategoryResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List item attributes", parameters=[q_query_string_parameter] + summary="List item attributes", ) ) class ItemAttributeResource(PokeapiCommonViewset): @@ -456,10 +400,6 @@ class ItemAttributeResource(PokeapiCommonViewset): serializer_class = ItemAttributeDetailSerializer list_serializer_class = ItemAttributeSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description='The various effects of the move"Fling" when used with different items.', @@ -468,7 +408,7 @@ class ItemAttributeResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List item fling effects", parameters=[q_query_string_parameter] + summary="List item fling effects", ) ) class ItemFlingEffectResource(PokeapiCommonViewset): @@ -476,10 +416,6 @@ class ItemFlingEffectResource(PokeapiCommonViewset): serializer_class = ItemFlingEffectDetailSerializer list_serializer_class = ItemFlingEffectSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Pockets within the players bag used for storing items by category.", @@ -488,7 +424,7 @@ class ItemFlingEffectResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List item pockets", parameters=[q_query_string_parameter] + summary="List item pockets", ) ) class ItemPocketResource(PokeapiCommonViewset): @@ -496,10 +432,6 @@ class ItemPocketResource(PokeapiCommonViewset): serializer_class = ItemPocketDetailSerializer list_serializer_class = ItemPocketSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Languages for translations of API resource information.", @@ -507,17 +439,15 @@ class ItemPocketResource(PokeapiCommonViewset): tags=["utility"], ) @extend_schema_view( - list=extend_schema(summary="List languages", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List languages", + ) ) class LanguageResource(PokeapiCommonViewset): queryset = Language.objects.all() serializer_class = LanguageDetailSerializer list_serializer_class = LanguageSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.", @@ -525,17 +455,15 @@ class LanguageResource(PokeapiCommonViewset): tags=["location"], ) @extend_schema_view( - list=extend_schema(summary="List locations", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List locations", + ) ) class LocationResource(PokeapiCommonViewset): queryset = Location.objects.all() serializer_class = LocationDetailSerializer list_serializer_class = LocationSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters.", @@ -544,7 +472,7 @@ class LocationResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List location areas", parameters=[q_query_string_parameter] + summary="List location areas", ) ) class LocationAreaResource(ListOrDetailSerialRelation, viewsets.ReadOnlyModelViewSet): @@ -552,10 +480,6 @@ class LocationAreaResource(ListOrDetailSerialRelation, viewsets.ReadOnlyModelVie serializer_class = LocationAreaDetailSerializer list_serializer_class = LocationAreaSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine.", @@ -563,17 +487,15 @@ class LocationAreaResource(ListOrDetailSerialRelation, viewsets.ReadOnlyModelVie tags=["machines"], ) @extend_schema_view( - list=extend_schema(summary="List machines", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List machines", + ) ) class MachineResource(PokeapiCommonViewset): queryset = Machine.objects.all() serializer_class = MachineDetailSerializer list_serializer_class = MachineSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas.", @@ -581,17 +503,15 @@ class MachineResource(PokeapiCommonViewset): tags=["moves"], ) @extend_schema_view( - list=extend_schema(summary="List moves", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List moves", + ) ) class MoveResource(PokeapiCommonViewset): queryset = Move.objects.all() serializer_class = MoveDetailSerializer list_serializer_class = MoveSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Damage classes moves can have, e.g. physical, special, or non-damaging.", @@ -600,7 +520,7 @@ class MoveResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List move damage classes", parameters=[q_query_string_parameter] + summary="List move damage classes", ) ) class MoveDamageClassResource(PokeapiCommonViewset): @@ -608,10 +528,6 @@ class MoveDamageClassResource(PokeapiCommonViewset): serializer_class = MoveDamageClassDetailSerializer list_serializer_class = MoveDamageClassSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Move Ailments are status conditions caused by moves used during battle. See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Status_condition) for greater detail.", @@ -620,7 +536,7 @@ class MoveDamageClassResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List move meta ailments", parameters=[q_query_string_parameter] + summary="List move meta ailments", ) ) class MoveMetaAilmentResource(PokeapiCommonViewset): @@ -628,10 +544,6 @@ class MoveMetaAilmentResource(PokeapiCommonViewset): serializer_class = MoveMetaAilmentDetailSerializer list_serializer_class = MoveMetaAilmentSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Styles of moves when used in the Battle Palace. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III)) for greater detail.", @@ -640,7 +552,7 @@ class MoveMetaAilmentResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List move battle styles", parameters=[q_query_string_parameter] + summary="List move battle styles", ) ) class MoveBattleStyleResource(PokeapiCommonViewset): @@ -648,10 +560,6 @@ class MoveBattleStyleResource(PokeapiCommonViewset): serializer_class = MoveBattleStyleDetailSerializer list_serializer_class = MoveBattleStyleSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Very general categories that loosely group move effects.", @@ -660,7 +568,7 @@ class MoveBattleStyleResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List move meta categories", parameters=[q_query_string_parameter] + summary="List move meta categories", ) ) class MoveMetaCategoryResource(PokeapiCommonViewset): @@ -668,10 +576,6 @@ class MoveMetaCategoryResource(PokeapiCommonViewset): serializer_class = MoveMetaCategoryDetailSerializer list_serializer_class = MoveMetaCategorySummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Methods by which Pokémon can learn moves.", @@ -680,7 +584,7 @@ class MoveMetaCategoryResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List move learn methods", parameters=[q_query_string_parameter] + summary="List move learn methods", ) ) class MoveLearnMethodResource(PokeapiCommonViewset): @@ -688,10 +592,6 @@ class MoveLearnMethodResource(PokeapiCommonViewset): serializer_class = MoveLearnMethodDetailSerializer list_serializer_class = MoveLearnMethodSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Targets moves can be directed at during battle. Targets can be Pokémon, environments or even other moves.", @@ -700,7 +600,7 @@ class MoveLearnMethodResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List move targets", parameters=[q_query_string_parameter] + summary="List move targets", ) ) class MoveTargetResource(PokeapiCommonViewset): @@ -708,10 +608,6 @@ class MoveTargetResource(PokeapiCommonViewset): serializer_class = MoveTargetDetailSerializer list_serializer_class = MoveTargetSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Natures influence how a Pokémon's stats grow. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Nature) for greater detail.", @@ -719,17 +615,15 @@ class MoveTargetResource(PokeapiCommonViewset): tags=["pokemon"], ) @extend_schema_view( - list=extend_schema(summary="List natures", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List natures", + ) ) class NatureResource(PokeapiCommonViewset): queryset = Nature.objects.all() serializer_class = NatureDetailSerializer list_serializer_class = NatureSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park.", @@ -738,7 +632,7 @@ class NatureResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List pal park areas", parameters=[q_query_string_parameter] + summary="List pal park areas", ) ) class PalParkAreaResource(PokeapiCommonViewset): @@ -746,10 +640,6 @@ class PalParkAreaResource(PokeapiCommonViewset): serializer_class = PalParkAreaDetailSerializer list_serializer_class = PalParkAreaSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Pokeathlon Stats are different attributes of a Pokémon's performance in Pokéathlons. In Pokéathlons, competitions happen on different courses; one for each of the different Pokéathlon stats. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9athlon) for greater detail.", @@ -758,7 +648,7 @@ class PalParkAreaResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List pokeathlon stats", parameters=[q_query_string_parameter] + summary="List pokeathlon stats", ) ) class PokeathlonStatResource(PokeapiCommonViewset): @@ -766,10 +656,6 @@ class PokeathlonStatResource(PokeapiCommonViewset): serializer_class = PokeathlonStatDetailSerializer list_serializer_class = PokeathlonStatSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) for greater detail.", @@ -777,17 +663,15 @@ class PokeathlonStatResource(PokeapiCommonViewset): tags=["games"], ) @extend_schema_view( - list=extend_schema(summary="List pokedex", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List pokedex", + ) ) class PokedexResource(PokeapiCommonViewset): queryset = Pokedex.objects.all() serializer_class = PokedexDetailSerializer list_serializer_class = PokedexSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Colors used for sorting Pokémon in a Pokédex. The color listed in the Pokédex is usually the color most apparent or covering each Pokémon's body. No orange category exists; Pokémon that are primarily orange are listed as red or brown.", @@ -796,7 +680,7 @@ class PokedexResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List pokemon colors", parameters=[q_query_string_parameter] + summary="List pokemon colors", ) ) class PokemonColorResource(PokeapiCommonViewset): @@ -804,10 +688,6 @@ class PokemonColorResource(PokeapiCommonViewset): serializer_class = PokemonColorDetailSerializer list_serializer_class = PokemonColorSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Some Pokémon may appear in one of multiple, visually different forms. These differences are purely cosmetic. For variations within a Pokémon species, which do differ in more than just visuals, the 'Pokémon' entity is used to represent such a variety.", @@ -816,7 +696,7 @@ class PokemonColorResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List pokemon forms", parameters=[q_query_string_parameter] + summary="List pokemon forms", ) ) class PokemonFormResource(PokeapiCommonViewset): @@ -824,10 +704,6 @@ class PokemonFormResource(PokeapiCommonViewset): serializer_class = PokemonFormDetailSerializer list_serializer_class = PokemonFormSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Habitats are generally different terrain Pokémon can be found in but can also be areas designated for rare or legendary Pokémon.", @@ -836,7 +712,7 @@ class PokemonFormResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List pokemom habitas", parameters=[q_query_string_parameter] + summary="List pokemom habitas", ) ) class PokemonHabitatResource(PokeapiCommonViewset): @@ -844,10 +720,6 @@ class PokemonHabitatResource(PokeapiCommonViewset): serializer_class = PokemonHabitatDetailSerializer list_serializer_class = PokemonHabitatSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Shapes used for sorting Pokémon in a Pokédex.", @@ -856,7 +728,7 @@ class PokemonHabitatResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List pokemon shapes", parameters=[q_query_string_parameter] + summary="List pokemon shapes", ) ) class PokemonShapeResource(PokeapiCommonViewset): @@ -864,10 +736,6 @@ class PokemonShapeResource(PokeapiCommonViewset): serializer_class = PokemonShapeDetailSerializer list_serializer_class = PokemonShapeSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon. Each Pokémon belongs to a specific species but may take on a variant which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) for greater detail.", @@ -875,17 +743,15 @@ class PokemonShapeResource(PokeapiCommonViewset): tags=["pokemon"], ) @extend_schema_view( - list=extend_schema(summary="List pokemon", parameters=[q_query_string_parameter]), + list=extend_schema( + summary="List pokemon", + ), ) class PokemonResource(PokeapiCommonViewset): queryset = Pokemon.objects.all() serializer_class = PokemonDetailSerializer list_serializer_class = PokemonSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="A Pokémon Species forms the basis for at least one Pokémon. Attributes of a Pokémon species are shared across all varieties of Pokémon within the species. A good example is Wormadam; Wormadam is the species which can be found in three different varieties, Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant.", @@ -894,7 +760,7 @@ class PokemonResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List pokemon species", parameters=[q_query_string_parameter] + summary="List pokemon species", ) ) class PokemonSpeciesResource(PokeapiCommonViewset): @@ -902,10 +768,6 @@ class PokemonSpeciesResource(PokeapiCommonViewset): serializer_class = PokemonSpeciesDetailSerializer list_serializer_class = PokemonSpeciesSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them.", @@ -913,17 +775,15 @@ class PokemonSpeciesResource(PokeapiCommonViewset): tags=["location"], ) @extend_schema_view( - list=extend_schema(summary="List regions", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List regions", + ) ) class RegionResource(PokeapiCommonViewset): queryset = Region.objects.all() serializer_class = RegionDetailSerializer list_serializer_class = RegionSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Stats determine certain aspects of battles. Each Pokémon has a value for each stat which grows as they gain levels and can be altered momentarily by effects in battles.", @@ -931,17 +791,15 @@ class RegionResource(PokeapiCommonViewset): tags=["pokemon"], ) @extend_schema_view( - list=extend_schema(summary="List stats", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List stats", + ) ) class StatResource(PokeapiCommonViewset): queryset = Stat.objects.all() serializer_class = StatDetailSerializer list_serializer_class = StatSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Super contest effects refer to the effects of moves when used in super contests.", @@ -950,7 +808,7 @@ class StatResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List super contest effects", parameters=[q_query_string_parameter] + summary="List super contest effects", ) ) class SuperContestEffectResource(PokeapiCommonViewset): @@ -958,10 +816,6 @@ class SuperContestEffectResource(PokeapiCommonViewset): serializer_class = SuperContestEffectDetailSerializer list_serializer_class = SuperContestEffectSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Types are properties for Pokémon and their moves. Each type has three properties: which types of Pokémon it is super effective against, which types of Pokémon it is not very effective against, and which types of Pokémon it is completely ineffective against.", @@ -969,17 +823,15 @@ class SuperContestEffectResource(PokeapiCommonViewset): tags=["pokemon"], ) @extend_schema_view( - list=extend_schema(summary="List types", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List types", + ) ) class TypeResource(PokeapiCommonViewset): queryset = Type.objects.all() serializer_class = TypeDetailSerializer list_serializer_class = TypeSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Versions of the games, e.g., Red, Blue or Yellow.", @@ -987,17 +839,15 @@ class TypeResource(PokeapiCommonViewset): tags=["games"], ) @extend_schema_view( - list=extend_schema(summary="List versions", parameters=[q_query_string_parameter]) + list=extend_schema( + summary="List versions", + ) ) class VersionResource(PokeapiCommonViewset): queryset = Version.objects.all() serializer_class = VersionDetailSerializer list_serializer_class = VersionSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Version groups categorize highly similar versions of the games.", @@ -1006,7 +856,7 @@ class VersionResource(PokeapiCommonViewset): ) @extend_schema_view( list=extend_schema( - summary="List version groups", parameters=[q_query_string_parameter] + summary="List version groups", ) ) class VersionGroupResource(PokeapiCommonViewset): @@ -1014,10 +864,6 @@ class VersionGroupResource(PokeapiCommonViewset): serializer_class = VersionGroupDetailSerializer list_serializer_class = VersionGroupSummarySerializer - @extend_schema(parameters=[retrieve_path_parameter]) - def retrieve(self, request, pk=None): - return super().retrieve(request, pk) - @extend_schema( description="Handles Pokemon Encounters as a sub-resource.",