arangodb / arangojs

The official ArangoDB JavaScript driver.
https://arangodb.github.io/arangojs
Apache License 2.0
600 stars 106 forks source link

Documentation for indexes type is not updated? #771

Closed samuelabc closed 1 year ago

samuelabc commented 2 years ago

As shown in this arangodb v3.9 http documentation, the API for creating a persistent index accept a deduplicate field and an inBackground field.

However, in the latest arangojs documentation, the ensurepersistentindexoptions type doesn't mention about the deduplicate field and inBackground field. Several other type definitions of indexes has similar issue, the inBackground field doesn't exist in their type definition.

pluma4345 commented 2 years ago

Looks like some of the HTTP API changes in 3.8/3.9 weren't correctly communicated internally. We're working on improving the communication of these changes to drivers maintainers to avoid this problem with future releases and hopefully the process should be more resilient starting with 3.10.

I'll look into the missing options and add them to the types.