Releases: LartTyler/MHWDB-Docs
1.18.0
Changelog
- Added support for localization. Please read the docs on localization for more information.
- Added support for purple sharpness.
Breaking Changes
- Fields deprecated in v1.17.0 have been removed.
Deprecations
- On
CharmRank
objects, thename
field is now deprecated, and will be removed in v1.19.0.
1.17.0
Changelog
- Added "fanged beast" as a monster species.
- Iceborne events are now included in the API.
- Relationship length can now be queried using the
$size
operator.
Breaking Changes
- Fields deprecated in v1.16.0 have been removed.
Deprecations
- On all objects, the
.length
fields are now deprecated in favor of the$size
operator for querying relationship length.
1.16.0
Changelog
- Added "master" to the list of allowed armor / armor set ranks.
- Monster reward subtypes are now always lowercase values.
- Moved
Weapon.attributes.elderseal
toWeapon.elderseal
. - Moved
Weapon.attributes.phialType
toWeapon.phial
(charge blade / switch axe only). - Moved
Weapon.attributes.ammoCapacities
toWeapon.ammo
(bowguns only). - Moved
Weapon.attributes.coatings
toWeapon.coatings
(bows only). - Moved
Weapon.attributes.specialAmmo
toWeapon.specialAmmo
(bowguns only). - Moved
Weapon.attributes.deviation
toWeapon.deviation
(bowguns only). - Moved
Weapon.attributes.boostType
toWeapon.boostType
(insect glaive only). - Moved
Weapon.attributes.damageType
toWeapon.damageType
. - Moved
Weapon.attributes.shellingType
toWeapon.shelling
(gunlance only).
Deprecations
- On weapons, the
attributes.elderseal
field is now deprecated in favor of theelderseal
field. It will be removed in v1.17.0. - On weapons, the
attributes.phialType
field is now deprecated in favor of thephial
field. It will be removed in v1.17.0. - On weapons, the
attributes.ammoCapacities
field is now deprecated in favor of theammo
field. It will be removed in v1.17.0. - On weapons, the
attributes.coatings
field is now deprecated in favor of thecoatings
field. It will be removed in v1.17.0. - On weapons, the
attributes.specialAmmo
field is now deprecated in favor of thespecialAmmo
field. It will be removed in v1.17.0. - On weapons, the
attributes.deviation
field is now deprecated in favor of thedeviation
field. It will be removed in v1.17.0. - On weapons,
attributes.boostType
is now deprecated in favor of theboostType
field. It will be removed in v1.17.0. - On weapons,
attributes.damageType
is now deprecated in favor of thedamageType
field. It will be removed in v1.17.0. - On weapons,
attributes.shellingType
is now deprecated in favor of theshelling
field. It will be removed in v1.17.0.
1.15.0
Changelog
- Added support for monster drops and rewards.
- Added "stun" as a possible element type for monster resistances and weaknesses. Weapons cannot have a "stun" element type.
- Added "relict" as a possible monster species, to support The Witcher collaboration event monsters.
- Added support for in-game events. Events are updated automatically, once per day, at midnight UTC. For more information, see the note below.
Notes
The big features in this update are support for monster rewards, which have been asked for a lot, and the in-game events feed. For monster rewards, please be aware that data will be added over time, as contributors are able to fill out the necessary information.
The events feature is, basically, just a copy of the live and upcoming events feed available on Capcom's official site (here for console, and here for PC). It's updated automatically once per day, and provides all events as a JSON feed for easy consumption. Once an event updates, it will be removed from the list the next time the events are updated (midnight UTC every day), and new events will be added to the list at the same time. Click here to view the events currently available through the API.
See LartTyler/MHWDB-API#91 for a comprehensive list of backend changes.
1.14.0
Changelog
- Added ailment / debuff support to the API.
- Added location support to the API.
- Added monster support to the API.
- Removed fields deprecated by v1.13.0.
Breaking Changes
- Removed the deprecated
Item.buyPrice
andItem.sellPrice
fields. - Removed the deprecated
Weapon.sharpness
field. - Removed the
slug
fields from all entities that had a slug. Please note that this was not a documented deprecation, but was a necessary change to support the user contribution system.
Notes
This release has been a long time coming. Monster data is one of the most commonly requested features, and this update will finally bring support for them to the API. It's important to note that I say "support", as ailments, locations, and monsters will be the first endpoints to rely solely on user contributed data as opposed to the scraping system that the API has used in the past.
To begin with, contributions will only be allowed from a select few users that I'll be manually inviting to the contribution system. I'd eventually like to open contributions up to anyone that uses the API (similar to how a wiki allows edits from any user), but there's more work to be done before I feel comfortable opening things up that much. If you're interested in helping out with contributions of your own, feel free to reach out to me at [email protected].
For now, once this release goes live, I'll be adding data for ailments, locations, and monsters myself, to ensure that all the data is available. From there, we'll begin going back through the other endpoints and correcting inaccurate information and adding any missing information (like some of the new weapons added since the Kulve Taroth update).
See LartTyler/MHWDB-API#79 for a comprehensive list of backend changes.
1.13.0
Changelog
- Added the
durability
field to weapons. - Merged the
buyPrice
andsellPrice
on items into a single field namedvalue
. - Added a lot of missing data (namely, newer weapons and gear).
- Removed fields deprecated by v1.11.0.
Breaking Changes
- Removed the deprecated
Weapon.attributes.attack
field. - The following fields will now only contain lower cased values:
Weapon.attributes.deviation
Weapon.attributes.specialAmmo
Weapon.attributes.deviation
Weapon.attributes.coatings
Weapon.attributes.boostType
- Values in
Weapon.attributes.phialType
no longer contain the "phial" string, e.g. "Impact Phial" would become "impact" and "Dragon Phial 300" would become "dragon 300". - Values in
Weapon.attributes.boostType
no longer contain the "boost" string, e.g. "Sever Boost" would now be "sever".
Deprecations
- On items,
buyPrice
andsellPrice
are now deprecated, and will be removed on 2018-08-25. Use thevalue
field instead. - On weapons, the
sharpness
field is now deprecated, and will be removed on 2018-08-25. Use thedurability
field instead.
1.12.0
Changelog
- Added the
p
query parameter to all endpoints, which will allow projection against API results. For usage information, please see the docs.
1.11.1
1.11.0
Changelog
- Added the
assets
field to weapons. - Moved
attributes.attack
toattack.display
and addedattack.raw
. - Added weapon motion value information to the API.
- Removed fields deprecated by v1.9.0.
Breaking Changes
- Removed
Decoration.skill
field. - Removed
Weapon.attributes.element*
fields. - Removed
Weapon.attributes.sharpness*
fields.
Deprecations
- On weapons,
attributes.attack
is now deprecated, and will be removed on 2018-05-19. Use theattack
object instead.
1.10.4
Changelog
- Any field in the API that contains an array of related objects (such as
Armor.skills
orWeapon.elements
) will now expose alength
property that can be used when searching the API. For example, to search for any weapon that cannot be upgraded, you could use{"crafting.branches.length":0}
. The length field will NOT be visible in the API output, and is only available to search by. Please see the docs for more information.