1.17.0

Changelog

• Added "fanged beast" as a monster species.
• Scraping of Iceborne events is now supported by the API.
• Safi'jiiva siege events are now supported by the API.
• Updated symfony/* packages to v5.0.
• Replaced dbstudios/doze-bundle with dbstudios/php-api-common.

Breaking Changes

• Removed the following fields from weapons (as they're now supported by top-level weapon fields):
  • attributes.elderseal
  • attributes.phialType
  • attributes.ammoCapacities
  • attributes.coatings
  • attributes.specialAmmo
  • attributes.deviation
  • attributes.boostType
  • attributes.damageType
  • attributes.shellingType

Deprecations

• The length field on all relationships are being deprecated in favor of the new $size operator, and will be removed in v1.18.0. For more information, please read the section titled New $size Operator.

---

New $size Operator

Early on the API's lifetime, the decision was made to support queries against the length of a collection or relationship via a special .length field. To do this, an extra column was added for every relationship that stored a cached count of the number of elements in the relationship. When a query hit the API that used the length field, it would be translated to the correct column name (e.g. crafting.materials.length would actually query crafting.materialsLength). This worked well when the API was read-only, and lengths could be calculated on a development server, then pushed to production. Now that the API relies on user contributed information, however, those cached lengths have to be recalculated every time an entity with relationships is updated, even if the number of items in the relationship hasn't changed.

With the most recent update to the dbstudios/doctrine-query-document library, it became possible to leverage Doctrine's built-in SIZE function for relationships, like so.

/skills?q={"ranks": {"$size": 1}}

In the example above, the API would return any skill with exactly one rank. The $size operator also supports embedding other operators, to give you more flexibility in your queries.

/skills?q={"ranks": {"$size": {"$lte": 1}}}
/skills?q={"ranks": {"$size": {"$in": [1, 2, 3]}}

The examples above would return skills with zero or one rank, and skills with one, two, or three ranks, respectively. For more information on the $size query, refer to the library docs.