API Builder Deprecations

Axway deprecates API Builder functionality when the use of a feature is considered to be unsafe, an improved alternative is available, or breaking changes are expected in a future major release.

Direct or indirect use of deprecated features may result in a warning when the service starts. This should not affect the functionality of your service but should be treated as a helper to stay ahead of any future breaking changes and reduce upgrade effort to future major releases.

List of Deprecated features

#1 /apidoc/docs.json

Swagger API docs are available on /apidoc/swagger.json and are mirrored on /apidoc/docs.json.

Using the /apidoc/docs.json endpoint to access Swagger API documentation is deprecated and /apidoc/swagger.json should be used instead.

#2 apiDocPrefix

Beginning with the Boston release, Usage of admin.apiDocPrefix in the project configuration has been deprecated. Use apidoc.prefix instead. If both values are provided, apidoc.prefix will be preferred.

More information can be found here: Project Configuration

#3 disableAPIDoc

Beginning with the Boston release, Usage of admin.disableAPIDoc in the project configuration has been deprecated. Use apidoc.disabled instead. If both values are provided, apidoc.disabled will be preferred.

More information can be found here: Project Configuration

#4 enableModelsWithNoPrimaryKey

Beginning with the Canberra release, for models that do not have a primary key:

  • The deletefindAndModifyfindByIDupsert, and update APIs and endpoints will not be generated.
  • The model flow-node will not have deletefindAndModifyfindByIDupsert, or update methods.
  • The Create API will no longer return a location header.

This will be the default behavior in all new services. For information on how to be prepared for the change and to start using the new behavior now, refer to Removal of unsupported APIs on Models that do not have a primary key.

#5 usePrimaryKeyType

Beginning with the Canberra release, Model IDs are based on the database primary key type instead of being hard-coded as a string.

This will be the default behavior in all new services. For information on how to be prepared for the change and to start using the new behavior now, refer to Removal of strings as default Model IDs.

#6 exitOnPluginFailure

Beginning with the Dublin release, errors when loading API Builder plugins will cause the service to terminate.

This will be the default behavior in all new services. For more information on how to be prepared for the change and to start using the new behavior now, refer to Change in the loading of plugins when errors occur.

#7 enableAliasesInCompositeOperators

Beginning with the Eden release, queries on Composite models will support comparison operators ( $eq, $ne, $in, $nin, $lt, $lte, $gt, $gte, $like) on aliased fields.

This will be the default behavior in all new services. For information on how to be prepared for the change and to start using the new behavior now, refer to Change in the handling of comparison operators on Composite models.

#8 enableMemoryConnectorLike

Beginning with the Eden release, queries on models using the Memory connector that also use the $like comparison operator will search using the query parameter instead of just returning an empty array.

This will be the default behavior in all new services. For information on how to be prepared for the change and to start using the new behavior now, refer to Change in the handling of Memory model queries using $like comparison operator.

#9 enableScopedConfig

Beginning with the Istanbul release, when loading an API Builder plugin, you will only receive the config relevant to the uploaded plugin.

This will be the default behavior in all new services. For information on how to be prepared for the change and to start using the new behavior now, refer to Change in the way config is passed to plugins.

#10 perURLAuthentication

Beginning with the Lisbon release, authentication has changed to make all paths secure, and public paths must be explicitly declared. 

This will be the default behavior in all new services. For information on how to be prepared for the change and to start using the new behavior now, refer to Change in the way of handling authentication and authentication plugins.

#11 API Builder Web

Beginning with the Lisbon release, API Builder Web is deprecated and will be removed in a future major version. If you are currently using Web Routes, consider switching to another modern web application architecture for your front end that consumes API Builder Service APIs.

#12 enableModelNameEncoding

Beginning with the Osaka release, model names are URI encoded as per RFC-3986 and the APIs that are auto-generated for models will bind to their URI equivalent.

This will be the default behavior for all new services. For information on how to be prepared for the change, and to start using the new behavior now, refer to Change in the way model name is encoded in URI.

Related Links