Wrong HTTP status code when API request fails

[bobapple]

Creating a comment via the API requires two parameters in the request body: author and comment.

Creating a comment works just fine, this is an example how I print also the HTTP response code:

bob@bobs-mbp $ curl -w "\nHTTP Status: %{http_code}" -k -s -u icinga:icinga -H 'Accept: application/json' -X POST 'https://demo:5665/v1/actions/add-comment?service=demo%21disk' -d '{ "author": "icingaadmin", "comment": "This is a comment" }'
{"results":[{"code":200.0,"legacy_id":10.0,"name":"demo!disk!demo-1490607359-8","status":"Successfully added comment 'demo!disk!demo-1490607359-8' for object 'demo!disk'."}]}
HTTP Status: 200

When I omit one of the required parameters, lets say I don't set the author, the response I get tells me that something is wrong. However, the HTTP response code is still 200.

bob@bobs-mbp $ curl -w "\nHTTP Status: %{http_code}" -k -s -u icinga:icinga -H 'Accept: application/json' -X POST 'https://demo:5665/v1/actions/add-comment?service=demo%21disk' -d '{ "comment": "This is a comment" }'
{"results":[{"code":403.0,"status":"Comments require author and comment."}]}
HTTP Status: 200

[dnsmichi]

Each result set might contain a different return status other than 200.

        for (const ConfigObject::Ptr& obj : objs) {
                try {
                        results->Add(action->Invoke(obj, params));
                } catch (const std::exception& ex) {
                        Dictionary::Ptr fail = new Dictionary();
                        fail->Set("code", 500);
                        fail->Set("status", "Action execution failed: '" + DiagnosticInformation(ex, false) + "'.");
                        if (HttpUtility::GetLastParameter(params, "verboseErrors"))
                                fail->Set("diagnostic information", DiagnosticInformation(ex));
                        results->Add(fail);
                }
        }

        Dictionary::Ptr result = new Dictionary();
        result->Set("results", results);

        response.SetStatus(200, "OK");
        HttpUtility::SendJsonBody(response, result);

An attempt to fix would be to always return the highest error number detected from returned results here.

[bobapple]

We had one more discussion with @gunnarbeutner about this and came to this points:

• If all results are bad, the HTTP status should also be something not 200
• If any of the results is successfull, the HTTP status should be 200

This makes it easier to catch errors when working with the API.