From b036eacb86d46dfd9dc18f8b9f0b2972616c5d25 Mon Sep 17 00:00:00 2001 From: indyandie <1058837+Indyandie@users.noreply.github.com> Date: Fri, 31 May 2024 00:16:39 -0500 Subject: [PATCH] docs(openapi): generate spec --- openapi.yml | 55 +++++++++++++++++++++++++++++++---------------------- 1 file changed, 32 insertions(+), 23 deletions(-) diff --git a/openapi.yml b/openapi.yml index 92937cdf..5e45840d 100644 --- a/openapi.yml +++ b/openapi.yml @@ -9319,57 +9319,66 @@ servers: - url: https://pokeapi.co tags: - name: pokemon - description: Pokémon are the creatures that inhabit the world of the Pokémon games + 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. externalDocs: - description: Fine more info here + description: Find more info here url: https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon - name: evolution - description: 'Evolution (Japanese: 進化 evolution) is a process in which a Pokémon - changes into a different species of Pokémon.' + description: Evolution is a process in which a Pokémon changes into a different + species of Pokémon. externalDocs: - description: Fine more info here + description: Find more info here url: https://bulbapedia.bulbagarden.net/wiki/Evolution - name: berries - description: 'Berries (Japanese: きのみ Tree Fruit) are small, juicy, fleshy fruit. - As in the real world, a large variety exists in the Pokémon world, with a large - range of flavors and effects' + description: Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) + for greater detail. externalDocs: - description: Fine more info here + description: Find more info here url: https://bulbapedia.bulbagarden.net/wiki/Berry - name: items - description: 'An item (Japanese: 道具 tool) is an object in the Pokémon games which - the player can pick up, keep in their Bag, and use in some manner' + 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. externalDocs: - description: Fine more info here + description: Find more info here url: https://bulbapedia.bulbagarden.net/wiki/Item - name: machines 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. externalDocs: - description: Fine more info here + description: Find more info here url: https://bulbapedia.bulbagarden.net/wiki/TM - name: location - description: Locations that can be visited within the games + description: Locations that can be visited within the games. Locations make up sizable + portions of regions, like cities or routes. externalDocs: - description: Fine more info here + description: Find more info here url: https://bulbapedia.bulbagarden.net/wiki/List_of_locations_by_index_number - name: contest - description: 'Pokémon Contests (Japanese: ポケモンコンテスト Pokémon Contest) are a type - of competition often contrasted with Pokémon battles and held in Contest Halls' + description: Pokémon Contests are a type of competition often contrasted with Pokémon + battles and held in Contest Halls externalDocs: - description: Fine more info here + description: Find more info here url: https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_Contest - name: moves - description: 'A move (Japanese: わざ move), also known as an attack (Japanese: こうげきわざ - attack technique) or technique (Japanese: とくしゅわざ special technique), is the skill - Pokémon primarily use in battle.' + 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. externalDocs: - description: Fine more info here + description: Find more info here url: https://bulbapedia.bulbagarden.net/wiki/List_of_locations_by_name - name: encounters - name: games description: The Pokémon games are all video games in the Pokémon franchise. externalDocs: - description: Fine more info here + description: Find more info here url: https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_games - name: utility externalDocs: