Update notice for legacy mesh URLs
API Mesh now runs at the edge, and legacy mesh URLs are no longer available. Click the Update notice to find more information on how to update your mesh:
Release notes
The following sections list updates to API Mesh for Adobe Developer App Builder. Refer to the Upgrade version for more information on upgrading.
December 10, 2024
This release contains the following changes to API Mesh:
Enhancements
- Internal logging improvements.
Bug fixes
- Resolved an issue where creating a mesh from a template caused an error.
December 05, 2024
This release contains the following changes to API Mesh:
Enhancements
- We have removed the SOAP handler because it is not compatible with edge meshes.
- You can now pass a maximum of 500 headers to your mesh.
- Security improvements.
December 03, 2024
This release contains the following changes to API Mesh:
Enhancements
- Edge meshes are now the only available mesh option. Legacy meshes are no longer available.
November 25, 2024
This release contains the following changes to API Mesh:
Enhancements
- Added a configuration option allowing you to disable introspection on your mesh for security purposes.
Bug fixes
- Resolved an error where specific special characters in a Project, Workspace, or Organization name could cause issues with provisioning.
November 19, 2024
This release contains the following changes to API Mesh:
Bug fixes
- Resolved an issue where special characters in an Org, Project, or Workspace name could cause a provisioning error.
- Resolved an issue where fetching a source with multiple
set-cookie
headers caused an unexpected server error.
November 04, 2024
This release contains the following changes to API Mesh:
Enhancements
beforeAll
hooks now work with edge meshes.- The
source
field is now available for GraphQL handlers, allowing you to provide an introspection file. - Enhancements to performance and stability.
October 03, 2024
This release contains the following changes to API Mesh:
Enhancements
Added a success message when you use the aio api-mesh log-list
command with the --filename
flag that confirms file creation.
October 01, 2024
This release contains the following changes to API Mesh:
Enhancements
- Added the ability to run scheduled performance tests on your edge mesh. For more information, see schedule performance testing.
- Increased the edge mesh query timeout from
30
seconds to60
seconds.
Bug fixes
- Resolved an issue where the
aio api-mesh log list --filename
command would return an error if the filename included special characters. - Resolved an issue that caused
500
errors when using aGET
request with a body.
September 26, 2024
This release contains the following changes to API Mesh:
Enhancements
Edge logging - API Mesh now supports detailed logging for edge meshes. See Logging for more information. You will need to update your CLI to the latest version to access the new commands.
September 24, 2024
This release contains the following changes to API Mesh:
Enhancements
Improved performance during cold starts for edge meshes. For previously created meshes, you must run the aio api-mesh update
command on your edge mesh before you can benefit from this enhancement.
August 15, 2024
This release contains the following changes to API Mesh:
Enhancements
API Mesh at the Edge - The current API Mesh architecture uses a standard configuration spread across multiple regions. To improve response times and provide better benefits to our users, we are introducing edge deployment for meshes. Edge meshes exist closer to your data sources, which reduces latency and generally improves the user experience by making meshes more performant. Edge meshes provide the following benefits:
With API Mesh on the edge:
- Improved response times and enhanced API performance
- Easier integration with industry-standard tools and third-party products
- Reduced potential of other hosted meshes degrading the performance of your mesh
- Better security and compliance
- Increased observability
Adobe recommends using edge meshes for the best performance. Refer to Access your mesh URLs for more information.
If you have an allowlist, add the edge mesh IP addresses.
If you intend to use Fastly, follow Configure Fastly for edge meshes.
The following commands will take slightly longer to complete. Consider using local development for testing and development purposes:
aio api-mesh create
aio api-mesh update
aio api-mesh delete
Due to compatibility limitations, certain features, such as hooks, SOAP handlers, and replaceField
transforms are not available in edge meshes.
With the update to edge, API Mesh no longer requires API keys.
Performance testing
When performance testing edge meshes in API Mesh, you need to account for cold starts to get an accurate measurement of the performance.
If applicable, you should use the Connection: keep-alive
header described in Optimizing edge mesh performance.
Alternatively, you can manually warm the cache using the process described in Performance testing.
August 06, 2024
This release contains the following changes to API Mesh:
- You can now escape the
$
character in secrets files by using a backslash (\
). For example,SECRET: \$SECRET
. - Improved error handling when secrets contained in a mesh configuration are not found in the associated secrets
yaml
file.
Bug fixes
- Resolved an issue where the selected Org, Project, and Workspace were not saved between CLI commands.
- Resolved a
CANNOT FIND MODULE
error that could occur when using theaio api-mesh run
command.
July 22, 2024
This release contains the following changes to API Mesh:
Enhancements
- API Mesh now supports including secrets in your mesh configuration file. For more information, see Secrets management.
- Several new files are available in local development after running the
aio api-mesh init
command. These files enhance the developer experience and facilitate future enhancements.
Bug fixes
- Fixed an issue where multiple
Set-Cookie
response headers could be concatenated in a single response. - Equals signs (
=
) are now allowed in environment variables.
May 21, 2024
This release contains the following changes to API Mesh:
Bug fixes
Resolved an unexpected error that could occur when implementing CI/CD.
April 23, 2024
This release contains the following changes to API Mesh:
Bug fixes
Resolved an issue that could cause operation headers to be exposed as query string parameters in the source URL when useGETForQueries
was set to true
.
April 04, 2024
This release contains the following changes to API Mesh:
Bug fixes
Resolved an issue that prevented resolvers from updating when updating a mesh.
January 30, 2024
This release contains the following changes to API Mesh:
Bug fixes
Resolved a MODULE_NOT_FOUND
error in the @adobe/aio-cli-plugin-api-mesh
CLI. If you encounter this error, upgrade to version 3.2.2 (latest)
.
To update to the newest version of the CLI, run aio update
or aio plugins:install @adobe/aio-cli-plugin-api-mesh
.
January 11, 2023
This release contains the following changes to API Mesh:
Enhancements
A
--select
argument is now available for therun
command. By providing the--select
argument, you can run a mesh based on the mesh artifact in the selected workspace instead of rebuilding the mesh.Various improvements to server performance.
November 14, 2023
This release contains the following changes to API Mesh:
Enhancements
- Internal monitoring and optimization upgrades.
Due to an internal upgrade, to get CORS response headers when querying your mesh, you must provide an origin
request header with the origin URL as the value. For example, origin: https://edge-graph.adobe.io
.
Bug fixes
- Resolved an issue in the CLI where using the
aio api-mesh get --json
command in a workspace with no mesh configuration would return an inconsistent error.
To update to the newest version of the CLI, run aio update
or aio plugins:install @adobe/aio-cli-plugin-api-mesh
.
October 18, 2023
This release contains the following changes to API Mesh:
Bug fixes
Performance fixes.
October 09, 2023
This release contains the following changes to API Mesh:
Enhancements
A run
command beta is now available, which allows you to create a local API Mesh environment for development and testing purposes. The run
command works in concert with the init
command and environment variables to provide more robust developer tooling.
Beta features may not be fully supported.
To update to the newest version of the CLI, run aio update
or aio plugins:install @adobe/aio-cli-plugin-api-mesh
.
September 21, 2023
This release contains the following changes to API Mesh:
Enhancements
- GraphQL aliasing is now enabled.
August 30, 2023
This release contains the following changes to API Mesh:
Enhancements
Due to upcoming changes in the Adobe I/O Extensible CLI, the API Mesh CLI may encounter an Unable to create API key
error when running an aio api-mesh create
command on a workspace that has an existing API key. To resolve this run aio update
or aio plugins:install @adobe/aio-cli-plugin-api-mesh
to ensure you have version 3.0.0
of the API Mesh plugin.
Alternatively, if updating your plugin is not an option, you can manually delete the credential from Adobe Developer Console by navigating to API Keys in the appropriate workspace and clicking Delete Credential.
August 17, 2023
This release contains the following changes to API Mesh:
Enhancements
- Added support for aliasing.
- Added internal caching improvements. You may notice improvements to response time.
July 31, 2023
This release contains the following changes to API Mesh:
Enhancements
Added the SOAP handler(removed) to API Mesh.- The SOAP handler is experimental and should not be used in production deployments.
- Added internal logging improvements.
Bug fixes
- Removed a configuration option that was enabled but not supported.
- Resolved a
500 Internal Server Error
that could occur when deleting a mesh. - Resolved a
400 Bad Request
that could occur when updating a mesh.
June 29, 2023
This release contains the following changes to API Mesh:
Bug fixes
- A previous release introduced an issue that could cause unnecessary delays on GraphQL requests. This issue has been resolved and could result in improved performance.
June 27, 2023
This release contains the following changes to API Mesh:
Bug fixes
- Resolved an issue where error details from GraphQL sources appeared as a generic error. API Mesh now forwards the error details from the GraphQL source.
June 15, 2023
This release contains the following changes to API Mesh:
Enhancements
- Added support for automatically importing files for local
hooks
.