IMPORTANT: Upcoming Breaking Changes in Multivac APIs


(Maziyar Panahi) #1

Hi @multivac-dsl @multivac-general

These are important breaking changes in the Multivac APIs engine. If you are using Multivac APIs I highly recommend you to adapt your code:

1- All the Rest API endpoints now require a field called project. You need to mention the project that the API belongs to in your API request:

example: project=economy

You can find out more about the name of each project from Multivac APIs documentation.

2- The full-text query now only accepts the following operations:

  • + signifies AND operation
  • | signifies OR operation
  • - negates a single token
  • " wraps a number of tokens to signify a phrase for searching
  • * at the end of a term signifies a prefix query
  • ( and ) signify precedence

This means OR and AND operators are being removed and should be replaced by | and +.

3- Permissions to use each Rest API endpoint now is granted based on each project. This means if you have access to only one project you won’t be able to use the rest (like before). The error is clear when you hit an endpoint without permission, please do contact me when that happens.

These changes are mandatory to respect the data privacy and keep Multivac’s search engine cluster in a healthy state.


(Maziyar Panahi) #2