Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Responses for a multiple-resource resources request with pagination may include a total-records item in the meta property, which is the total of resource items match the query parameters. total-records is obsolete and may not be available in future updates of the APIs. Please use the new totalResources instead. For example, the following response include both total-records and totalResources`, but again, totalResources should be used instead.

...

JSON:API specification v1.1 doesn’t describe a standardized filter syntax. Therefore, the filter syntax varies and depends on the underlying technologies used to develop the APIs. For microservices in the list at the beginning of the Best practices for consuming JSON APIs section, the filter syntax is described in detailed at https://www.jsonapi.net/usage/reading/filtering.html. Please be informed of the following guidelines regarding to the filter syntax:

  1. The legacy Legacy filters, e.g. ?filter[lastName]=eq:Smith are still supported, but they may be removed in a future update of the services. Any new code should use the new filter syntax, and existing code using legacy filters should be updated to use the new filters.

  2. New filters MUST be prefixed with expr:, for example, ?filter=expr:equals(lastName,'Smith').

...