docs(openapi): define get_type_sprites function

PokeAPI · Jan 22, 2025 · 4964ed9 · 4964ed9
1 parent 015a464
commit 4964ed9
Showing 1 changed file with 59 additions and 0 deletions.
diff --git a/pokemon_v2/serializers.py b/pokemon_v2/serializers.py
@@ -2381,6 +2381,65 @@ class Meta:
             "sprites",
         )
 
+    @extend_schema_field(
+        field={
+            "type": "object",
+            "additionalProperties": {
+                "type": "object",
+                "additionalProperties": {
+                    "type": "object",
+                    "properties": {
+                        "name-icon": {
+                            "type": "string",
+                            "format": "uri",
+                            "examples": [
+                                "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/colosseum/1.png"
+                            ],
+                        }
+                    },
+                    "examples": [
+                        {
+                            "colosseum": {
+                                "name_icon": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/colosseum/1.png"
+                            }
+                        }
+                    ],
+                },
+                "examples": [
+                    {
+                        "generation-ix": {
+                            "scarlet-violet": {
+                                "name_icon": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-ix/scarlet-violet/1.png"
+                            }
+                        }
+                    }
+                ],
+            },
+            "examples": [
+                {
+                    "sprites": {
+                        "generation-iii": {
+                            "colosseum": {
+                                "name_icon": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/colosseum/1.png"
+                            },
+                            "emerald": {
+                                "name_icon": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/emerald/1.png"
+                            },
+                            "firered-leafgreen": {
+                                "name_icon": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/firered-leafgreen/1.png"
+                            },
+                            "ruby-saphire": {
+                                "name_icon": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/ruby-saphire/1.png"
+                            },
+                            "xd": {
+                                "name_icon": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/xd/1.png"
+                            },
+                        }
+                    }
+                }
+            ],
+        }
+    )
     def get_type_sprites(self, obj):
         sprites_object = TypeSprites.objects.get(type_id=obj)
         return sprites_object.sprites