languagetool-org / languagetool

Style and Grammar Checker for 25+ Languages
https://languagetool.org
GNU Lesser General Public License v2.1
12.48k stars 1.4k forks source link

[API] API response contains inconsistencies w.r.t. API specification #6334

Closed apibugsreporting closed 2 years ago

apibugsreporting commented 2 years ago

Hi, I would like to report an issue in this API.

Endpoint: POST /v2/check

Description: When making a request to this endpoint with the following parameters:

motherTongue:pt-AO
language:pt-AO
text:sibyllic

The following inconsistencies are found in the response, according to the OpenAPI specification:

The OpenAPI specification I am referring to is available at: https://languagetool.org/http-api/languagetool-swagger.json

A test report revealing this issue is available at: http://apitesting.ddns.net/fse2022/restest/target/allure-reports/languageTool__rw_rt_custom/#behaviors/b1a8273437954620fa374b796ffaacdd/88e50107b14a88e6/

danielnaber commented 2 years ago

Yes, there are undocumented values in the response, that's on purpose (the doc says "any parameters or outputs not part of this documentation are internal and must not be relied on").