Migrate from v3 to v4
Removed
Updated
Versioning Strategy
The API version is now included in the URL path instead of the accept header. For example,
curl -X GET "http://localhost:8180/api/artifacts/{artifact-id}" -H "accept: application/vnd.squore.app-v3+json"
Becomes
curl -X GET "http://localhost:8180/api/v3/artifacts/{artifact-id}" -H "accept: application/json"
The endpoint /api/artifacts/{artifact-id} will automatically redirect to the latest version available
/api/v4/artifacts/{artifact-id} here the v4.
The accept header application/vnd.squore.app-v2+json,application/vnd.squore.app-v3+json and application/vnd.squore.app-latest+json are automatically transformed to application\json, to allow previous API to work.
Rename the model object (DTO) name
With Squore 26.0.0, some model objects were named with a version number, for instance, DtoProject2. This would introduce some problems after an upgrade.
We suggest to remove the version number from the model object name, going from DtoProject2 to DtoProject, so the project model will always be DtoProject and the API client will use DtoProject instead of DtoProject2.
Trend Computing
Trend data is no longer computed automatically for certain API endpoints. To include trend information in the response, set the withTrend parameter to true (false by default).
This change improves API performance, as trend computation can be resource-intensive and is not required for all use cases.
Endpoints affected:
-
/artifacts/{artifact-id}/indicators -
/artifacts/{artifact-id}/measures/ -
/artifacts/{artifact-id}/measures/{measure-id} -
/artifacts/{artifact-id}/findings -
/findings/{finding-id}