diff --git a/config/settings.py b/config/settings.py index 5459cc7db..4456a88a7 100755 --- a/config/settings.py +++ b/config/settings.py @@ -157,6 +157,7 @@ Created by [**Paul Hallett**(]https://github.com/phalt) and other [**PokéAPI contributors***](https://github.com/PokeAPI/pokeapi#contributing) around the world. Pokémon and Pokémon character names are trademarks of Nintendo. """, + "SORT_OPERATIONS": False, "SERVERS": [{"url": "https://pokeapi.co"}], "EXTERNAL_DOCS": {"url": "https://pokeapi.co/docs/v2"}, "VERSION": "2.7.0", @@ -164,16 +165,79 @@ "OAS_VERSION": "3.1.0", "COMPONENT_SPLIT_REQUEST": True, "TAGS": [ - "pokemon", - "evolution", - "berries", - "items", - "machines", - "location", - "contest", - "moves", - "encounters", - "games", - "utility", + { + "name": "pokemon", + "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": "Find more info here", + "url": "https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon", + }, + }, + { + "name": "evolution", + "description": "Evolution is a process in which a Pokémon changes into a different species of Pokémon.", + "externalDocs": { + "description": "Find more info here", + "url": "https://bulbapedia.bulbagarden.net/wiki/Evolution", + }, + }, + { + "name": "berries", + "description": "Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail.", + "externalDocs": { + "description": "Find more info here", + "url": "https://bulbapedia.bulbagarden.net/wiki/Berry", + }, + }, + { + "name": "items", + "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": "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": "Find more info here", + "url": "https://bulbapedia.bulbagarden.net/wiki/TM", + }, + }, + { + "name": "location", + "description": "Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.", + "externalDocs": { + "description": "Find more info here", + "url": "https://bulbapedia.bulbagarden.net/wiki/List_of_locations_by_index_number", + }, + }, + { + "name": "contest", + "description": "Pokémon Contests are a type of competition often contrasted with Pokémon battles and held in Contest Halls", + "externalDocs": { + "description": "Find more info here", + "url": "https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_Contest", + }, + }, + { + "name": "moves", + "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": "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": "Find more info here", + "url": "https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_games", + }, + }, + {"name": "utility"}, ], } diff --git a/openapi.yml b/openapi.yml index e2c776548..5e45840df 100644 --- a/openapi.yml +++ b/openapi.yml @@ -120,6 +120,34 @@ paths: schema: $ref: '#/components/schemas/PaginatedBerrySummaryList' description: '' + /api/v2/berry/{id}/: + get: + operationId: berry_retrieve + 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. + summary: Get a berry + parameters: + - in: path + name: id + schema: + type: string + description: This parameter can be a string or an integer. + required: true + tags: + - berries + security: + - cookieAuth: [] + - basicAuth: [] + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BerryDetail' + description: '' /api/v2/berry-firmness/: get: operationId: berry_firmness_list @@ -250,34 +278,6 @@ paths: schema: $ref: '#/components/schemas/BerryFlavorDetail' description: '' - /api/v2/berry/{id}/: - get: - operationId: berry_retrieve - 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. - summary: Get a berry - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - berries - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/BerryDetail' - description: '' /api/v2/characteristic/: get: operationId: characteristic_list @@ -346,11 +346,13 @@ paths: schema: $ref: '#/components/schemas/CharacteristicDetail' description: '' - /api/v2/contest-effect/: + /api/v2/contest-type/: get: - operationId: contest_effect_list - description: Contest effects refer to the effects of moves when used in contests. - summary: List contest effects + operationId: contest_type_list + 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. + summary: List contest types parameters: - name: limit required: false @@ -381,13 +383,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaginatedContestEffectSummaryList' + $ref: '#/components/schemas/PaginatedContestTypeSummaryList' description: '' - /api/v2/contest-effect/{id}/: + /api/v2/contest-type/{id}/: get: - operationId: contest_effect_retrieve - description: Contest effects refer to the effects of moves when used in contests. - summary: Get contest effect + operationId: contest_type_retrieve + 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. + summary: Get contest type parameters: - in: path name: id @@ -406,15 +410,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ContestEffectDetail' + $ref: '#/components/schemas/ContestTypeDetail' description: '' - /api/v2/contest-type/: + /api/v2/contest-effect/: get: - operationId: contest_type_list - 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. - summary: List contest types + operationId: contest_effect_list + description: Contest effects refer to the effects of moves when used in contests. + summary: List contest effects parameters: - name: limit required: false @@ -445,15 +447,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaginatedContestTypeSummaryList' + $ref: '#/components/schemas/PaginatedContestEffectSummaryList' description: '' - /api/v2/contest-type/{id}/: + /api/v2/contest-effect/{id}/: get: - operationId: contest_type_retrieve - 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. - summary: Get contest type + operationId: contest_effect_retrieve + description: Contest effects refer to the effects of moves when used in contests. + summary: Get contest effect parameters: - in: path name: id @@ -472,7 +472,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ContestTypeDetail' + $ref: '#/components/schemas/ContestEffectDetail' description: '' /api/v2/egg-group/: get: @@ -542,12 +542,12 @@ paths: schema: $ref: '#/components/schemas/EggGroupDetail' description: '' - /api/v2/encounter-condition/: + /api/v2/encounter-method/: get: - operationId: encounter_condition_list - description: Conditions which affect what pokemon might appear in the wild, - e.g., day or night. - summary: List encounter conditions + operationId: encounter_method_list + 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. + summary: List encounter methods parameters: - name: limit required: false @@ -578,33 +578,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaginatedEncounterConditionSummaryList' + $ref: '#/components/schemas/PaginatedEncounterMethodSummaryList' description: '' - /api/v2/encounter-condition-value/: + /api/v2/encounter-method/{id}/: get: - operationId: encounter_condition_value_list - 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. - summary: List encounter condition values + operationId: encounter_method_retrieve + 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. + summary: Get encounter method parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q + - in: path + name: id 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. " + description: This parameter can be a string or an integer. + required: true tags: - encounters security: @@ -616,21 +604,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaginatedEncounterConditionValueSummaryList' + $ref: '#/components/schemas/EncounterMethodDetail' description: '' - /api/v2/encounter-condition-value/{id}/: + /api/v2/encounter-condition/: get: - operationId: encounter_condition_value_retrieve - 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. - summary: Get encounter condition value + operationId: encounter_condition_list + description: Conditions which affect what pokemon might appear in the wild, + e.g., day or night. + summary: List encounter conditions parameters: - - in: path - name: id + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - in: query + name: q schema: type: string - description: This parameter can be a string or an integer. - required: true + description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ + Case-insensitive query applied on the `name` property. " tags: - encounters security: @@ -642,7 +642,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EncounterConditionValueDetail' + $ref: '#/components/schemas/PaginatedEncounterConditionSummaryList' description: '' /api/v2/encounter-condition/{id}/: get: @@ -670,12 +670,12 @@ paths: schema: $ref: '#/components/schemas/EncounterConditionDetail' description: '' - /api/v2/encounter-method/: + /api/v2/encounter-condition-value/: get: - operationId: encounter_method_list - 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. - summary: List encounter methods + operationId: encounter_condition_value_list + 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. + summary: List encounter condition values parameters: - name: limit required: false @@ -706,14 +706,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaginatedEncounterMethodSummaryList' + $ref: '#/components/schemas/PaginatedEncounterConditionValueSummaryList' description: '' - /api/v2/encounter-method/{id}/: + /api/v2/encounter-condition-value/{id}/: get: - operationId: encounter_method_retrieve - 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. - summary: Get encounter method + operationId: encounter_condition_value_retrieve + 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. + summary: Get encounter condition value parameters: - in: path name: id @@ -732,7 +732,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EncounterMethodDetail' + $ref: '#/components/schemas/EncounterConditionValueDetail' description: '' /api/v2/evolution-chain/: get: @@ -866,14 +866,14 @@ paths: schema: $ref: '#/components/schemas/EvolutionTriggerDetail' description: '' - /api/v2/gender/: + /api/v2/generation/: get: - operationId: gender_list - 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. - summary: List genders + operationId: generation_list + 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. + summary: List genrations parameters: - name: limit required: false @@ -894,7 +894,7 @@ paths: 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 + - games security: - cookieAuth: [] - basicAuth: [] @@ -904,16 +904,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaginatedGenderSummaryList' + $ref: '#/components/schemas/PaginatedGenerationSummaryList' description: '' - /api/v2/gender/{id}/: + /api/v2/generation/{id}/: get: - operationId: gender_retrieve - 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. - summary: Get gender + operationId: generation_retrieve + 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. + summary: Get genration parameters: - in: path name: id @@ -922,7 +922,7 @@ paths: description: This parameter can be a string or an integer. required: true tags: - - pokemon + - games security: - cookieAuth: [] - basicAuth: [] @@ -932,16 +932,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GenderDetail' + $ref: '#/components/schemas/GenerationDetail' description: '' - /api/v2/generation/: + /api/v2/gender/: get: - operationId: generation_list - 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. - summary: List genrations + operationId: gender_list + 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. + summary: List genders parameters: - name: limit required: false @@ -962,7 +962,7 @@ paths: description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ Case-insensitive query applied on the `name` property. " tags: - - games + - pokemon security: - cookieAuth: [] - basicAuth: [] @@ -972,16 +972,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaginatedGenerationSummaryList' + $ref: '#/components/schemas/PaginatedGenderSummaryList' description: '' - /api/v2/generation/{id}/: + /api/v2/gender/{id}/: get: - operationId: generation_retrieve - 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. - summary: Get genration + operationId: gender_retrieve + 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. + summary: Get gender parameters: - in: path name: id @@ -990,7 +990,7 @@ paths: description: This parameter can be a string or an integer. required: true tags: - - games + - pokemon security: - cookieAuth: [] - basicAuth: [] @@ -1000,7 +1000,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GenerationDetail' + $ref: '#/components/schemas/GenderDetail' description: '' /api/v2/growth-rate/: get: @@ -1107,12 +1107,39 @@ paths: schema: $ref: '#/components/schemas/PaginatedItemSummaryList' description: '' - /api/v2/item-attribute/: + /api/v2/item/{id}/: get: - operationId: item_attribute_list - description: Item attributes define particular aspects of items, e.g."usable - in battle" or "consumable". - summary: List item attributes + operationId: item_retrieve + 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. + summary: Get item + parameters: + - in: path + name: id + schema: + type: string + description: This parameter can be a string or an integer. + required: true + tags: + - items + security: + - cookieAuth: [] + - basicAuth: [] + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ItemDetail' + description: '' + /api/v2/item-category/: + get: + operationId: item_category_list + description: Item categories determine where items will be placed in the players + bag. + summary: List item categories parameters: - name: limit required: false @@ -1143,14 +1170,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaginatedItemAttributeSummaryList' + $ref: '#/components/schemas/PaginatedItemCategorySummaryList' description: '' - /api/v2/item-attribute/{id}/: + /api/v2/item-category/{id}/: get: - operationId: item_attribute_retrieve - description: Item attributes define particular aspects of items, e.g."usable - in battle" or "consumable". - summary: Get item attribute + operationId: item_category_retrieve + description: Item categories determine where items will be placed in the players + bag. + summary: Get item category parameters: - in: path name: id @@ -1169,14 +1196,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ItemAttributeDetail' + $ref: '#/components/schemas/ItemCategoryDetail' description: '' - /api/v2/item-category/: + /api/v2/item-attribute/: get: - operationId: item_category_list - description: Item categories determine where items will be placed in the players - bag. - summary: List item categories + operationId: item_attribute_list + description: Item attributes define particular aspects of items, e.g."usable + in battle" or "consumable". + summary: List item attributes parameters: - name: limit required: false @@ -1207,14 +1234,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaginatedItemCategorySummaryList' + $ref: '#/components/schemas/PaginatedItemAttributeSummaryList' description: '' - /api/v2/item-category/{id}/: + /api/v2/item-attribute/{id}/: get: - operationId: item_category_retrieve - description: Item categories determine where items will be placed in the players - bag. - summary: Get item category + operationId: item_attribute_retrieve + description: Item attributes define particular aspects of items, e.g."usable + in battle" or "consumable". + summary: Get item attribute parameters: - in: path name: id @@ -1233,7 +1260,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ItemCategoryDetail' + $ref: '#/components/schemas/ItemAttributeDetail' description: '' /api/v2/item-fling-effect/: get: @@ -1361,33 +1388,6 @@ paths: schema: $ref: '#/components/schemas/ItemPocketDetail' description: '' - /api/v2/item/{id}/: - get: - operationId: item_retrieve - 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. - summary: Get item - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - items - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ItemDetail' - description: '' /api/v2/language/: get: operationId: language_list @@ -1488,6 +1488,32 @@ paths: schema: $ref: '#/components/schemas/PaginatedLocationSummaryList' description: '' + /api/v2/location/{id}/: + get: + operationId: location_retrieve + description: Locations that can be visited within the games. Locations make + up sizable portions of regions, like cities or routes. + summary: Get location + parameters: + - in: path + name: id + schema: + type: string + description: This parameter can be a string or an integer. + required: true + tags: + - location + security: + - cookieAuth: [] + - basicAuth: [] + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LocationDetail' + description: '' /api/v2/location-area/: get: operationId: location_area_list @@ -1546,32 +1572,6 @@ paths: schema: $ref: '#/components/schemas/LocationAreaDetail' description: '' - /api/v2/location/{id}/: - get: - operationId: location_retrieve - description: Locations that can be visited within the games. Locations make - up sizable portions of regions, like cities or routes. - summary: Get location - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - location - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/LocationDetail' - description: '' /api/v2/machine/: get: operationId: machine_list @@ -1678,6 +1678,34 @@ paths: schema: $ref: '#/components/schemas/PaginatedMoveSummaryList' description: '' + /api/v2/move/{id}/: + get: + operationId: move_retrieve + 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. + summary: Get move + parameters: + - in: path + name: id + schema: + type: string + description: This parameter can be a string or an integer. + required: true + tags: + - moves + security: + - cookieAuth: [] + - basicAuth: [] + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MoveDetail' + description: '' /api/v2/move-ailment/: get: operationId: move_ailment_list @@ -2058,34 +2086,6 @@ paths: schema: $ref: '#/components/schemas/MoveTargetDetail' description: '' - /api/v2/move/{id}/: - get: - operationId: move_retrieve - 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. - summary: Get move - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - moves - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MoveDetail' - description: '' /api/v2/nature/: get: operationId: nature_list @@ -2214,14 +2214,15 @@ paths: schema: $ref: '#/components/schemas/PalParkAreaDetail' description: '' - /api/v2/pokeathlon-stat/: + /api/v2/pokedex/: get: - operationId: pokeathlon_stat_list - 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) + operationId: pokedex_list + 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. - summary: List pokeathlon stats + summary: List pokedex parameters: - name: limit required: false @@ -2242,7 +2243,7 @@ paths: 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 + - games security: - cookieAuth: [] - basicAuth: [] @@ -2252,17 +2253,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaginatedPokeathlonStatSummaryList' + $ref: '#/components/schemas/PaginatedPokedexSummaryList' description: '' - /api/v2/pokeathlon-stat/{id}/: + /api/v2/pokedex/{id}/: get: - operationId: pokeathlon_stat_retrieve - 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. - summary: Get pokeathlon stat - parameters: + operationId: pokedex_retrieve + 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. + summary: Get pokedex + parameters: - in: path name: id schema: @@ -2270,7 +2272,7 @@ paths: description: This parameter can be a string or an integer. required: true tags: - - pokemon + - games security: - cookieAuth: [] - basicAuth: [] @@ -2280,17 +2282,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PokeathlonStatDetail' + $ref: '#/components/schemas/PokedexDetail' description: '' - /api/v2/pokedex/: + /api/v2/pokemon/: get: - operationId: pokedex_list - 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) + operationId: pokemon_list + 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. - summary: List pokedex + summary: List pokemon parameters: - name: limit required: false @@ -2311,36 +2314,7 @@ paths: description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ Case-insensitive query applied on the `name` property. " tags: - - games - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedPokedexSummaryList' - description: '' - /api/v2/pokedex/{id}/: - get: - operationId: pokedex_retrieve - 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. - summary: Get pokedex - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - games + - pokemon security: - cookieAuth: [] - basicAuth: [] @@ -2350,37 +2324,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PokedexDetail' + $ref: '#/components/schemas/PaginatedPokemonSummaryList' description: '' - /api/v2/pokemon/: + /api/v2/pokemon/{id}/: get: - operationId: pokemon_list + operationId: pokemon_retrieve 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. - summary: List pokemon + summary: Get pokemon parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q + - in: path + name: id 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. " + description: This parameter can be a string or an integer. + required: true tags: - pokemon security: @@ -2392,7 +2354,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaginatedPokemonSummaryList' + $ref: '#/components/schemas/PokemonDetail' description: '' /api/v2/pokemon-color/: get: @@ -2724,23 +2686,33 @@ paths: schema: $ref: '#/components/schemas/PokemonSpeciesDetail' description: '' - /api/v2/pokemon/{id}/: + /api/v2/pokeathlon-stat/: get: - operationId: pokemon_retrieve - 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)) + operationId: pokeathlon_stat_list + 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. - summary: Get pokemon + summary: List pokeathlon stats parameters: - - in: path - name: id + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - in: query + name: q schema: type: string - description: This parameter can be a string or an integer. - required: true + 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: @@ -2752,22 +2724,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PokemonDetail' + $ref: '#/components/schemas/PaginatedPokeathlonStatSummaryList' description: '' - /api/v2/pokemon/{pokemon_id}/encounters: + /api/v2/pokeathlon-stat/{id}/: get: - operationId: pokemon_encounters_retrieve - description: Handles Pokemon Encounters as a sub-resource. - summary: Get pokemon encounter + operationId: pokeathlon_stat_retrieve + 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. + summary: Get pokeathlon stat parameters: - in: path - name: pokemon_id + name: id schema: type: string - pattern: ^\d+$ + description: This parameter can be a string or an integer. required: true tags: - - encounters + - pokemon security: - cookieAuth: [] - basicAuth: [] @@ -2777,99 +2752,7 @@ paths: content: application/json: schema: - type: array - items: - type: object - required: - - location_area - - version_details - properties: - location_area: - type: object - required: - - name - - url - properties: - name: - type: string - example: cerulean-city-area - url: - type: string - format: uri - example: https://pokeapi.co/api/v2/location-area/281/ - version_details: - type: array - items: - type: object - required: - - encounter_details - - max_chance - - version - properties: - encounter_details: - type: array - items: - type: object - required: - - chance - - condition_values - - max_level - - method - - min_level - properties: - chance: - type: number - example: 100 - condition_values: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - example: story-progress-beat-red - url: - type: string - format: uri - example: https://pokeapi.co/api/v2/encounter-condition-value/55/ - max_level: - type: number - example: 10 - method: - type: object - required: - - name - - url - properties: - name: - type: string - example: gift - url: - type: string - format: uri - example: https://pokeapi.co/api/v2/encounter-method/18/ - min_level: - type: number - example: 10 - max_chance: - type: number - example: 100 - version: - type: object - required: - - name - - url - properties: - name: - type: string - example: red - url: - type: string - format: uri - example: https://pokeapi.co/api/v2/version/1/ + $ref: '#/components/schemas/PokeathlonStatDetail' description: '' /api/v2/region/: get: @@ -3172,6 +3055,31 @@ paths: schema: $ref: '#/components/schemas/PaginatedVersionSummaryList' description: '' + /api/v2/version/{id}/: + get: + operationId: version_retrieve + description: Versions of the games, e.g., Red, Blue or Yellow. + summary: Get version + parameters: + - in: path + name: id + schema: + type: string + description: This parameter can be a string or an integer. + required: true + tags: + - games + security: + - cookieAuth: [] + - basicAuth: [] + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VersionDetail' + description: '' /api/v2/version-group/: get: operationId: version_group_list @@ -3234,20 +3142,20 @@ paths: schema: $ref: '#/components/schemas/VersionGroupDetail' description: '' - /api/v2/version/{id}/: + /api/v2/pokemon/{pokemon_id}/encounters: get: - operationId: version_retrieve - description: Versions of the games, e.g., Red, Blue or Yellow. - summary: Get version + operationId: pokemon_encounters_retrieve + description: Handles Pokemon Encounters as a sub-resource. + summary: Get pokemon encounter parameters: - in: path - name: id + name: pokemon_id schema: type: string - description: This parameter can be a string or an integer. + pattern: ^\d+$ required: true tags: - - games + - encounters security: - cookieAuth: [] - basicAuth: [] @@ -3257,7 +3165,99 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VersionDetail' + type: array + items: + type: object + required: + - location_area + - version_details + properties: + location_area: + type: object + required: + - name + - url + properties: + name: + type: string + example: cerulean-city-area + url: + type: string + format: uri + example: https://pokeapi.co/api/v2/location-area/281/ + version_details: + type: array + items: + type: object + required: + - encounter_details + - max_chance + - version + properties: + encounter_details: + type: array + items: + type: object + required: + - chance + - condition_values + - max_level + - method + - min_level + properties: + chance: + type: number + example: 100 + condition_values: + type: array + items: + type: object + required: + - name + - url + properties: + name: + type: string + example: story-progress-beat-red + url: + type: string + format: uri + example: https://pokeapi.co/api/v2/encounter-condition-value/55/ + max_level: + type: number + example: 10 + method: + type: object + required: + - name + - url + properties: + name: + type: string + example: gift + url: + type: string + format: uri + example: https://pokeapi.co/api/v2/encounter-method/18/ + min_level: + type: number + example: 10 + max_chance: + type: number + example: 100 + version: + type: object + required: + - name + - url + properties: + name: + type: string + example: red + url: + type: string + format: uri + example: https://pokeapi.co/api/v2/version/1/ description: '' components: schemas: @@ -9318,16 +9318,68 @@ components: servers: - url: https://pokeapi.co tags: -- pokemon -- evolution -- berries -- items -- machines -- location -- contest -- moves -- encounters -- games -- utility +- name: pokemon + 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: Find more info here + url: https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon +- name: evolution + description: Evolution is a process in which a Pokémon changes into a different + species of Pokémon. + externalDocs: + description: Find more info here + url: https://bulbapedia.bulbagarden.net/wiki/Evolution +- name: berries + description: Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) + for greater detail. + externalDocs: + description: Find more info here + url: https://bulbapedia.bulbagarden.net/wiki/Berry +- name: items + 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: 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: Find more info here + url: https://bulbapedia.bulbagarden.net/wiki/TM +- name: location + description: Locations that can be visited within the games. Locations make up sizable + portions of regions, like cities or routes. + externalDocs: + description: Find more info here + url: https://bulbapedia.bulbagarden.net/wiki/List_of_locations_by_index_number +- name: contest + description: Pokémon Contests are a type of competition often contrasted with Pokémon + battles and held in Contest Halls + externalDocs: + description: Find more info here + url: https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_Contest +- name: moves + 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: 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: Find more info here + url: https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_games +- name: utility externalDocs: url: https://pokeapi.co/docs/v2