v1.1.0

Release v1.1.0 is a minor release.

Release Highlights

• updates to Mongo indexing
• deprecate TRIMMED_DEFINITION_MONGO_COLLECTION_NAME

Upgrade Notes

There are no required changes to move to this version. There is a recommended change related to a deprecation. See Deprecations section for more information.

updates to Mongo indexing

API affected: get definitions with sort fields set to descending.

For example:

https://api.clearlydefined.io/definitions?type=composer&provider=packagist&namespace=10up&name=wpsnapshots&sort=namespace&sortDesc=true

Sorting order is determined by:
sortDesc=false – sort ascending (default)
sortDesc=true – sort descending

Behavior in v1.0.0

In this version, the sort honored sortDesc for any field identified as a sort field. Within multiple matches of those sort fields that share the same value, the results were being sorted ascending by coordinates regardless of the value of sortDesc. This is incorrect behavior.

New Behavior in v1.1.0

The new behavior sorts the identified sort fields and the coordinates in the same direction as identified by the sortDesc parameter.

It is recommended, but not required, that you delete the indices that are NOT documented in the _createIndexes method in clearlydefined/docker_dev_env_experiment/service/providers/stores/abstractMongoDefinitionStore.js

If you accidentally delete too many indices, they will be regenerated the next time you restart the service. NOTE: This can take a long time.

• Reduce indexes (@qtomlinson)
• Update documentation (@qtomlinson)

Deprecations

Deprecating TRIMMED_DEFINITION_MONGO_COLLECTION_NAME. If you are using this configuration, you should update the configs to use the name DEFINITION_MONGO_TRIMMED_COLLECTION_NAME instead.

• Rename trimmed definition variable (@qtomlinson)
• deprecate config TRIMMED_DEFINITION_MONGO_COLLECTION_NAME (@elrayle)

What’s Changed

v1.0.0…v1.1.0

Bug Fixes and Patches

• Fix azure pipeline error (@qtomlinson)
• Minor fixes (@qtomlinson)
• Expose revision in definition.find as a sort option (@qtomlinson)
• Target Node.js v18 (@JamieMagee)
• Regenerate lockfile from v1 to v3 (@JamieMagee)
• Formatting change (@qtomlinson)
• Update Environment Variables (@qtomlinson)
• Update SPDX related versions (@qtomlinson)
• Fix curation review url to point to the corresponding server (@qtomlinson)

Documentation

• Update documentation (@qtomlinson)