Details
Description
The REST call to associate a tag with components may return a 200 status code indicating the operation was successful, but the response body may not contain any components the tag was associated with.
{
"status": 200,
"message": "Association successful",
"data":
}
One user of the REST API was confused by this. Their usage pattern was:
1. create tag - 204
2. associate tag with components - 200
3. move components with tag - 404
At step 2, the status code implies some components were associated with the tag, when in fact there were no components found matching the criteria submitted.
The script moved to step 3 and failed curiously because there were no components fou d with the tag applied in step 2.
So while the API seems to be acting as designed, there may be a slight disconnect between tagging and staging here.
Expected
Clarify why the associate tag API returns 200 status code even though no components VS the staging move API which returns 404 for no components.
Add this type of caveat or clarity to our documentation.