Overview
In order to improve the accessibility of Alloy Meshes, we will be adding support for Open API JSON and endpoint documentation. Following a detailed review of the exposed endpoints and data models, we will also be acting to implement the following deprecations to provide better consistency between naming and conventions with the Alloy Core, Extended and Forge API's. Finally, we will be making changes to the way in which the security token is passed to the Meshes to improve security.
Security token to be removed from query string
We will no longer be accepting the token parameter which represents an Alloy API token on the query string, this should be passed via the HTTP headers in all future requests using the same key of token.
Example CURL before:
curl -X 'POST' \
'http://localhost:3000/aws-iot/update-device?itemId=abc?token=123' \
-H 'accept: application/json' \
Example CURL after:
curl -X 'POST' \
'http://localhost:3000/aws-iot/update-device?itemId=abc' \
-H 'accept: application/json' \
-H 'token: 123' \
MeshResponseWithItemWebModel renames property itemResponse to item
The following meshes are expected to return a response which includes an item payload under the property itemResponse.
- alloy-push-mayrise-notice-mesh
- json-push-alloy-mesh
- telensa-fault-push-alloy-mesh
This property is being renamed to item but we will continue to return itemResponse until the date specified below for Phase 2.
Example response before:
{
"itemResponse": {
"itemId": "af32ef...",
...
}
}Example response after:
{
"itemResponse": {
"itemId": "af32ef...",
...
},
// we will duplicate the data in the recommended item property
"item": {
"itemId": "af32ef...",
...
},
}Risk calculation mesh to remove itemsResponse property
The risk calculation mesh alloy-push-risk-calculation-mesh is removing the itemsResponse property as it was not correctly indicating the success of the response model, it isn't required and will therefore be removed as part of Phase 1 changes.
When do these changes take effect?
The above changes will be rolled out in June 2021, with deprecations finally removed in January 2022 with the following expected release dates:
