Some API endpoints don't return valid JSON

[isAdrisal]

Describe the bug

/api/v2/scan-files

The above endpoint accepts an application/json payload. The response for a successful POST request is OK, rather than a valid JSON string ("OK").

The docs suggest a valid JSON "string" is returned, as expected for a json endpoint.

To Reproduce

curl -X POST \
-H "Content-Type: application/json" \
-d '{ "data": { "scanConfig": { "dbID": "LIBRARY_ID", "mode": "scanFolderWatcher", "arrayOrPath": ["/path/to/file"] } } }' \
"http://localhost:8265/api/v2/scan-files"

OK

Expected behavior
A valid JSON string (quoted) should be returned, eg. "OK".

[HaveAGitGat]

True, a lot of these endpoints that return "OK" were added 4-5 years ago so I suppose it depends how many people are relying on this just being a string and not JSON. For example, I think most js related request libraries such as axios auto-convert "OK" into just OK, so it's the same result either way.

[isAdrisal]

In the case of using plain JS fetch (which is how I ran into the issue), the below pattern throws. Instead I need to consume the body with res.text(), JSON.stringify() it, and then JSON.parse() it so that I don't need to worry about special-casing individual endpoints.

I take the point about breaking changes for existing usage. From my perspective it feels better to have an application/json api return the expected json response as I'd assume future usage will eventually surpass current API usage.

Obviously your call though! Thanks for considering it.

const res = await fetch("http://localhost:8265/api/v2/scan-files", {
  method: "POST",
  headers: {
    "content-type": "application/json",
  },
  body: JSON.stringify(dataObj),
});

const json = await res.json();