diff --git a/docs/api/v4/changes.md b/docs/api/v4/changes.md index fbaaca542097531a480eaa7278bfd0b51a2fdaea..18f2bd497160195f164609d294114c9759dd5143 100644 --- a/docs/api/v4/changes.md +++ b/docs/api/v4/changes.md @@ -1,9 +1,32 @@ # API v4 Changelog -This page lists additions to the v4 api with each new release of CiviCRM Core. +*This page lists additions to the v4 api with each new release of CiviCRM Core.* Also see: [Differences Between Api v3 and v4](/api/v4/differences-with-v3.md). -## Nothing here yet. +### 5.23 Added PaymentProcessor and PaymentProcessorType APIv4 Entities -API v4 is brand new. No changes yet! +See https://github.com/civicrm/civicrm-core/pull/15624 + +### 5.23 $index param supports array input + +CiviCRM 5.23 supports two new modes for the `$index` param - associative and non-associative array. See https://github.com/civicrm/civicrm-core/pull/16257 + +### 5.23 Converts field values to correct data type + +The api historically returns everything as a raw string from the query instead of converting it to the correct variable type (bool, int, float). As of CiviCRM 5.23 this is fixed for all DAO-based entities. See https://github.com/civicrm/civicrm-core/pull/16274 + +### 5.23 Selects only relevant contact fields by default + +The Contact entity in CiviCRM is divided into 3 major types: Individuals, Households and Organizations. +Not all contact fields apply to all contact types, e.g. the `sic_code` field is only used by Organizations, +and the `first_name` and `last_name` fields are only used by Individuals. + +In CiviCRM 5.23 the schema has been augmented with metadata about which fields belong to which contact type, and Api4 now uses this +metadata to select only relevant fields. E.g. fetching a household with the api will not return the `first_name` or `organization_name` fields +as those will always be `null`. + +### 5.23 Get actions support selecting fields by * wildcard + +The `select` param now supports the `*` wildcard character for matching field names. +See https://github.com/civicrm/civicrm-core/pull/16302 \ No newline at end of file