diff --git a/src/docs/evolution.json b/src/docs/evolution.json index 2a1a98b..b6d6184 100644 --- a/src/docs/evolution.json +++ b/src/docs/evolution.json @@ -1,331 +1,345 @@ [ - { - "name": "Evolution Chains", - "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.", - "exampleRequest": "/v2/evolution-chain/{id}/", - "exampleResponse": { - "id": 7, - "baby_trigger_item": null, - "chain": { - "is_baby": false, - "species": { - "name": "rattata", - "url": "$BASE_URL/v2/pokemon-species/19/" - }, - "evolution_details": null, - "evolves_to": [{ - "is_baby": false, - "species": { - "name": "raticate", - "url": "$BASE_URL/v2/pokemon-species/20/" - }, - "evolution_details": [{ - "item": null, - "trigger": { - "name": "level-up", - "url": "$BASE_URL/v2/evolution-trigger/1/" - }, - "gender": null, - "held_item": null, - "known_move": null, - "known_move_type": null, - "location": null, - "min_level": 20, - "min_happiness": null, - "min_beauty": null, - "min_affection": null, - "needs_overworld_rain": false, - "party_species": null, - "party_type": null, - "relative_physical_stats": null, - "time_of_day": "", - "trade_species": null, - "turn_upside_down": false - }], - "evolves_to": [] - }] - } + { + "name": "Evolution Chains", + "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.", + "exampleRequest": "/v2/evolution-chain/{id}/", + "exampleResponse": { + "id": 7, + "baby_trigger_item": null, + "chain": { + "is_baby": false, + "species": { + "name": "rattata", + "url": "$BASE_URL/v2/pokemon-species/19/" }, - "responseModels": [ - { - "name": "EvolutionChain", - "fields": [ - { - "name": "id", - "description": "The identifier for this resource.", - "type": "integer" - }, - { - "name": "baby_trigger_item", - "description": "The item that a Pokémon would be holding when mating that would trigger the egg hatching a baby Pokémon rather than a basic Pokémon.", - "type": { - "type": "NamedAPIResource", - "of": "Item" - } - }, - { - "name": "chain", - "description": "The base chain link object. Each link contains evolution details for a Pokémon in the chain. Each link references the next Pokémon in the natural evolution order.", - "type": "ChainLink" - } - ] + "evolution_details": null, + "evolves_to": [ + { + "is_baby": false, + "species": { + "name": "raticate", + "url": "$BASE_URL/v2/pokemon-species/20/" }, - { - "name": "ChainLink", - "fields": [ - { - "name": "is_baby", - "description": "Whether or not this link is for a baby Pokémon. This would only ever be true on the base link.", - "type": "boolean" - }, - { - "name": "species", - "description": "The Pokémon species at this point in the evolution chain.", - "type": { - "type": "NamedAPIResource", - "of": "PokemonSpecies" - } - }, - { - "name": "evolution_details", - "description": "All details regarding the specific details of the referenced Pokémon species evolution.", - "type": { - "type": "list", - "of": "EvolutionDetail" - } - }, - { - "name": "evolves_to", - "description": "A List of chain objects.", - "type": { - "type": "list", - "of": "ChainLink" - } - } - ] - }, - { - "name": "EvolutionDetail", - "fields": [ - { - "name": "item", - "description": "The item required to cause evolution this into Pokémon species.", - "type": { - "type": "NamedAPIResource", - "of": "Item" - } - }, - { - "name": "trigger", - "description": "The type of event that triggers evolution into this Pokémon species.", - "type": { - "type": "NamedAPIResource", - "of": "EvolutionTrigger" - } - }, - { - "name": "gender", - "description": "The id of the gender of the evolving Pokémon species must be in order to evolve into this Pokémon species.", - "type": "integer" - }, - { - "name": "held_item", - "description": "The item the evolving Pokémon species must be holding during the evolution trigger event to evolve into this Pokémon species.", - "type": { - "type": "NamedAPIResource", - "of": "Item" - } - }, - { - "name": "known_move", - "description": "The move that must be known by the evolving Pokémon species during the evolution trigger event in order to evolve into this Pokémon species.", - "type": { - "type": "NamedAPIResource", - "of": "Move" - } - }, - { - "name": "known_move_type", - "description": "The evolving Pokémon species must know a move with this type during the evolution trigger event in order to evolve into this Pokémon species.", - "type": { - "type": "NamedAPIResource", - "of": "Type" - } - }, - { - "name": "location", - "description": "The location the evolution must be triggered at.", - "type": { - "type": "NamedAPIResource", - "of": "Location" - } - }, - { - "name": "min_level", - "description": "The minimum required level of the evolving Pokémon species to evolve into this Pokémon species.", - "type": "integer" - }, - { - "name": "min_happiness", - "description": "The minimum required level of happiness the evolving Pokémon species to evolve into this Pokémon species.", - "type": "integer" - }, - { - "name": "min_beauty", - "description": "The minimum required level of beauty the evolving Pokémon species to evolve into this Pokémon species.", - "type": "integer" - }, - { - "name": "min_affection", - "description": "The minimum required level of affection the evolving Pokémon species to evolve into this Pokémon species.", - "type": "integer" - }, - { - "name": "needs_multiplayer", - "description": "Whether or not multiplayer link play is needed to evolve into this Pokémon species (e.g. Union Circle).", - "type": "boolean" - }, - { - "name": "needs_overworld_rain", - "description": "Whether or not it must be raining in the overworld to cause evolution this Pokémon species.", - "type": "boolean" - }, - { - "name": "party_species", - "description": "The Pokémon species that must be in the players party in order for the evolving Pokémon species to evolve into this Pokémon species.", - "type": { - "type": "NamedAPIResource", - "of": "PokemonSpecies" - } - }, - { - "name": "party_type", - "description": "The player must have a Pokémon of this type in their party during the evolution trigger event in order for the evolving Pokémon species to evolve into this Pokémon species.", - "type": { - "type": "NamedAPIResource", - "of": "Type" - } - }, - { - "name": "relative_physical_stats", - "description": "The required relation between the Pokémon's Attack and Defense stats. 1 means Attack > Defense. 0 means Attack = Defense. -1 means Attack < Defense.", - "type": "integer" - }, - { - "name": "time_of_day", - "description": "The required time of day. Day or night.", - "type": "string" - }, - { - "name": "trade_species", - "description": "Pokémon species for which this one must be traded.", - "type": { - "type": "NamedAPIResource", - "of": "PokemonSpecies" - } - }, - { - "name": "turn_upside_down", - "description": "Whether or not the 3DS needs to be turned upside-down as this Pokémon levels up.", - "type": "boolean" - }, - { - "name": "region", - "description": "The required region in which this evolution can occur.", - "type": { - "type": "NamedAPIResource", - "of": "Region" - } - }, - { - "name": "base_form", - "description": "The required form for which this evolution can occur.", - "type": { - "type": "NamedAPIResource", - "of": "Pokemon" - } - }, - { - "name": "used_move", - "description": "The move that must be used by the evolving Pokémon species during the evolution trigger event in order to evolve into this Pokémon species.", - "type": { - "type": "NamedAPIResource", - "of": "Move" - } - }, - { - "name": "min_move_count", - "description": "The minimum number of times a move must be used in order to evolve into this Pokémon species.", - "type": "integer" - }, - { - "name": "min_steps", - "description": "The minimum number of steps that must be taken in order to evolve into this Pokémon species.", - "type": "integer" - }, - { - "name": "min_damage_taken", - "description": "The minimum amount of damage taken during the evolution trigger event in order to evolve into this Pokémon species.", - "type": "integer" - } - ] + "evolution_details": [ + { + "item": null, + "trigger": { + "name": "level-up", + "url": "$BASE_URL/v2/evolution-trigger/1/" + }, + "gender": null, + "held_item": null, + "known_move": null, + "known_move_type": null, + "location": null, + "min_level": 20, + "min_happiness": null, + "min_beauty": null, + "min_affection": null, + "near_special_rock": false, + "needs_overworld_rain": false, + "party_species": null, + "party_type": null, + "relative_physical_stats": null, + "time_of_day": "", + "trade_species": null, + "turn_upside_down": false + } + ], + "evolves_to": [] + } + ] + } + }, + "responseModels": [ + { + "name": "EvolutionChain", + "fields": [ + { + "name": "id", + "description": "The identifier for this resource.", + "type": "integer" + }, + { + "name": "baby_trigger_item", + "description": "The item that a Pokémon would be holding when mating that would trigger the egg hatching a baby Pokémon rather than a basic Pokémon.", + "type": { + "type": "NamedAPIResource", + "of": "Item" } + }, + { + "name": "chain", + "description": "The base chain link object. Each link contains evolution details for a Pokémon in the chain. Each link references the next Pokémon in the natural evolution order.", + "type": "ChainLink" + } ] + }, + { + "name": "ChainLink", + "fields": [ + { + "name": "is_baby", + "description": "Whether or not this link is for a baby Pokémon. This would only ever be true on the base link.", + "type": "boolean" + }, + { + "name": "species", + "description": "The Pokémon species at this point in the evolution chain.", + "type": { + "type": "NamedAPIResource", + "of": "PokemonSpecies" + } + }, + { + "name": "evolution_details", + "description": "All details regarding the specific details of the referenced Pokémon species evolution.", + "type": { + "type": "list", + "of": "EvolutionDetail" + } + }, + { + "name": "evolves_to", + "description": "A List of chain objects.", + "type": { + "type": "list", + "of": "ChainLink" + } + } + ] + }, + { + "name": "EvolutionDetail", + "fields": [ + { + "name": "item", + "description": "The item required to cause evolution this into Pokémon species.", + "type": { + "type": "NamedAPIResource", + "of": "Item" + } + }, + { + "name": "trigger", + "description": "The type of event that triggers evolution into this Pokémon species.", + "type": { + "type": "NamedAPIResource", + "of": "EvolutionTrigger" + } + }, + { + "name": "gender", + "description": "The id of the gender of the evolving Pokémon species must be in order to evolve into this Pokémon species.", + "type": "integer" + }, + { + "name": "held_item", + "description": "The item the evolving Pokémon species must be holding during the evolution trigger event to evolve into this Pokémon species.", + "type": { + "type": "NamedAPIResource", + "of": "Item" + } + }, + { + "name": "known_move", + "description": "The move that must be known by the evolving Pokémon species during the evolution trigger event in order to evolve into this Pokémon species.", + "type": { + "type": "NamedAPIResource", + "of": "Move" + } + }, + { + "name": "known_move_type", + "description": "The evolving Pokémon species must know a move with this type during the evolution trigger event in order to evolve into this Pokémon species.", + "type": { + "type": "NamedAPIResource", + "of": "Type" + } + }, + { + "name": "location", + "description": "The location the evolution must be triggered at.", + "type": { + "type": "NamedAPIResource", + "of": "Location" + } + }, + { + "name": "min_level", + "description": "The minimum required level of the evolving Pokémon species to evolve into this Pokémon species.", + "type": "integer" + }, + { + "name": "min_happiness", + "description": "The minimum required level of happiness the evolving Pokémon species to evolve into this Pokémon species.", + "type": "integer" + }, + { + "name": "min_beauty", + "description": "The minimum required level of beauty the evolving Pokémon species to evolve into this Pokémon species.", + "type": "integer" + }, + { + "name": "min_affection", + "description": "The minimum required level of affection the evolving Pokémon species to evolve into this Pokémon species.", + "type": "integer" + }, + { + "name": "near_special_rock", + "description": "Whether or not you need to be near a Moss Rock or Icy Rock to evolve into this Pokémon species.", + "type": "boolean" + }, + { + "name": "needs_multiplayer", + "description": "Whether or not multiplayer link play is needed to evolve into this Pokémon species (e.g. Union Circle).", + "type": "boolean" + }, + { + "name": "needs_overworld_rain", + "description": "Whether or not it must be raining in the overworld to cause evolution this Pokémon species.", + "type": "boolean" + }, + { + "name": "party_species", + "description": "The Pokémon species that must be in the players party in order for the evolving Pokémon species to evolve into this Pokémon species.", + "type": { + "type": "NamedAPIResource", + "of": "PokemonSpecies" + } + }, + { + "name": "party_type", + "description": "The player must have a Pokémon of this type in their party during the evolution trigger event in order for the evolving Pokémon species to evolve into this Pokémon species.", + "type": { + "type": "NamedAPIResource", + "of": "Type" + } + }, + { + "name": "relative_physical_stats", + "description": "The required relation between the Pokémon's Attack and Defense stats. 1 means Attack > Defense. 0 means Attack = Defense. -1 means Attack < Defense.", + "type": "integer" + }, + { + "name": "time_of_day", + "description": "The required time of day. Day or night.", + "type": "string" + }, + { + "name": "trade_species", + "description": "Pokémon species for which this one must be traded.", + "type": { + "type": "NamedAPIResource", + "of": "PokemonSpecies" + } + }, + { + "name": "turn_upside_down", + "description": "Whether or not the 3DS needs to be turned upside-down as this Pokémon levels up.", + "type": "boolean" + }, + { + "name": "region", + "description": "The required region in which this evolution can occur.", + "type": { + "type": "NamedAPIResource", + "of": "Region" + } + }, + { + "name": "base_form", + "description": "The required form for which this evolution can occur.", + "type": { + "type": "NamedAPIResource", + "of": "Pokemon" + } + }, + { + "name": "used_move", + "description": "The move that must be used by the evolving Pokémon species during the evolution trigger event in order to evolve into this Pokémon species.", + "type": { + "type": "NamedAPIResource", + "of": "Move" + } + }, + { + "name": "min_move_count", + "description": "The minimum number of times a move must be used in order to evolve into this Pokémon species.", + "type": "integer" + }, + { + "name": "min_steps", + "description": "The minimum number of steps that must be taken in order to evolve into this Pokémon species.", + "type": "integer" + }, + { + "name": "min_damage_taken", + "description": "The minimum amount of damage taken during the evolution trigger event in order to evolve into this Pokémon species.", + "type": "integer" + } + ] + } + ] + }, + { + "name": "Evolution Triggers", + "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.", + "exampleRequest": "/v2/evolution-trigger/{id or name}/", + "exampleResponse": { + "id": 1, + "name": "level-up", + "names": [ + { + "name": "Level up", + "language": { + "name": "en", + "url": "$BASE_URL/v2/language/9/" + } + } + ], + "pokemon_species": [ + { + "name": "ivysaur", + "url": "$BASE_URL/v2/pokemon-species/2/" + } + ] }, - { - "name": "Evolution Triggers", - "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.", - "exampleRequest": "/v2/evolution-trigger/{id or name}/", - "exampleResponse": { - "id": 1, - "name": "level-up", - "names": [{ - "name": "Level up", - "language": { - "name": "en", - "url": "$BASE_URL/v2/language/9/" - } - }], - "pokemon_species": [{ - "name": "ivysaur", - "url": "$BASE_URL/v2/pokemon-species/2/" - }] - }, - "responseModels": [ - { - "name": "EvolutionTrigger", - "fields": [ - { - "name": "id", - "description": "The identifier for this resource.", - "type": "integer" - }, - { - "name": "name", - "description": "The name for this resource.", - "type": "string" - }, - { - "name": "names", - "description": "The name of this resource listed in different languages.", - "type": { - "type": "list", - "of": "Name" - } - }, - { - "name": "pokemon_species", - "description": "A list of pokemon species that result from this evolution trigger.", - "type": { - "type": "list", - "of": { - "type": "NamedAPIResource", - "of": "PokemonSpecies" - } - } - } - ] + "responseModels": [ + { + "name": "EvolutionTrigger", + "fields": [ + { + "name": "id", + "description": "The identifier for this resource.", + "type": "integer" + }, + { + "name": "name", + "description": "The name for this resource.", + "type": "string" + }, + { + "name": "names", + "description": "The name of this resource listed in different languages.", + "type": { + "type": "list", + "of": "Name" + } + }, + { + "name": "pokemon_species", + "description": "A list of pokemon species that result from this evolution trigger.", + "type": { + "type": "list", + "of": { + "type": "NamedAPIResource", + "of": "PokemonSpecies" + } } + } ] - } + } + ] + } ]