fixed

[BUGFIX] Error when creating and registering entities using incorrect naming strategy

This fix enforces proper namingStrategy validation for all entities created and registered via the API. Validation will be enforced starting on November 28th, 2022

What’s changing?

Previously when creating and registering entities via the Benchling API, it was possible to use values for namingStrategy that were marked as disallowed in the corresponding schema configuration. In some situations, this meant that entities could be created and registered in situations where a validation error should have occurred.

For example, Attempting to create and register an entity with namingStrategy : REPLACE_NAMES_FROM_PARTS should return an error if the relevant schema has no configured naming template. However, because this issue prevented enforcement of namingStrategy the entity creation and registration would succeed, despite an invalid entityRegistryId.

Going forward, namingStrategy validation will be consistently enforced when creating and registering entities via the API to ensure that the provided namingStrategy value is enabled on the target schema. Requests that fail this validation will result in a validation error, consistent with the existing validation done when creating and registering entities in the Benchling UI.

If you have an integration that creates and registers entities, you should take the following steps:

  • Confirm that your integration(s) and registry are properly configured to support your namingStrategy of choice.
  • Update your integration(s) to gracefully handle any validation errors, if necessary

When is this happening?

This change will be implemented on November 28th, 2022, at which point namingStrategy validation will be enforce.