[Mismatch between API response and API specification] Missing required properties
apibugsreporting opened this issue · 0 comments
apibugsreporting commented
Bug Description
The following API request obtains a response that contains inconsistencies with respect to the API specification.
General Information
Please include the following general information about the issue and list any additional steps needed to reproduce the bug.
- Version of the ohsome API [e.g.
1.5.0
]1.6.1
- Which API instance was requested [e.g. remote instance at
https://api.ohsome.org/v1
, local instance with an h2 file or connected to the cluster, etc.]- Remote instance at
https://api.ohsome.org/v1
- Remote instance at
- Affected endpoint(s) [e.g. /contributions/count]
- /elements/area/groupBy/type
- /users/count
- /elements/length/groupBy/boundary/groupBy/tag
- /elements/area/groupBy/boundary/groupBy/tag
- /users/count/groupBy/key
- /elements/perimeter/density/groupBy/boundary/groupBy/tag
- There may be more.
- URL of your request (and request body if applicable)
https://api.ohsome.org/v1/elements/area/groupBy/type?types=way%2C&showMetadata=yes&bpolys=%7B%22type%22%3A%22FeatureCollection%22%2C%22features%22%3A%5B%7B%22type%22%3A%22Feature%22%2C%22properties%22%3A%7B%22id%22%3A%22DK%22%7D%2C%22geometry%22%3A%7B%22type%22%3A%22Polygon%22%2C%22coordinates%22%3A%5B%5B%5B8.704561%2C49.403252%5D%2C%5B8.726%2C49.404%5D%2C%5B8.71133%2C49.43238%5D%2C%5B8.702157%2C49.4262%5D%2C%5B8.704561%2C49.403252%5D%5D%5D%7D%7D%2C%7B%22type%22%3A%22Feature%22%2C%22properties%22%3A%7B%22id%22%3A%22Fq%22%7D%2C%22geometry%22%3A%7B%22type%22%3A%22Polygon%22%2C%22coordinates%22%3A%5B%5B%5B8.704561%2C49.403252%5D%2C%5B8.70389%2C49.420664%5D%2C%5B8.7081%2C49.43217%5D%2C%5B8.7045%2C49.412913%5D%2C%5B8.704561%2C49.403252%5D%5D%5D%7D%7D%5D%7D&timeout=32
- Used HTTP method [GET or POST]
- Both
- Utilized tool/library for the request [e.g. cURL, Postman, ohsome-py, etc.]
Expected Behaviour
The response should contain the properties "features" and "type", which are defined as "required" in the API specification.
The OpenAPI specification I am referring to is available at:
- [UI] https://api.ohsome.org/v1/swagger-ui.html
- [JSON] https://api.ohsome.org/v1/docs?group=Data%20Aggregation
Further Information
Error Messages, Logs, Screenshots
See attached screenshot.
Additional Information
Several test reports revealing this issue are available at the following URLs (they might take some time to load):
- http://apitesting.ddns.net/fse2022/restest/target/allure-reports/ohsome__r_rt_custom/#categories/bc2cd9d73cc718fd5f29a7e953dded96/15bebcce1ed01b88/
- http://apitesting.ddns.net/fse2022/restest/target/allure-reports/ohsome__r_rt_custom/#categories/fc308cd6c218a6d18517a67707a86684/4ac670bc21af0db7/
- http://apitesting.ddns.net/fse2022/restest/target/allure-reports/ohsome__r_cbt_custom/#behaviors/b1a8273437954620fa374b796ffaacdd/c92453a9e8e172d7/
- http://apitesting.ddns.net/fse2022/restest/target/allure-reports/ohsome__r_cbt_custom/#behaviors/b1a8273437954620fa374b796ffaacdd/7035aca8fdfa8084/
- http://apitesting.ddns.net/fse2022/restest/target/allure-reports/ohsome__r_cbt_custom/#behaviors/b1a8273437954620fa374b796ffaacdd/3274a6594bbe6ae/
- http://apitesting.ddns.net/fse2022/restest/target/allure-reports/ohsome__r_cbt_custom/#behaviors/b1a8273437954620fa374b796ffaacdd/93ccda55f01edb66/
- http://apitesting.ddns.net/fse2022/restest/target/allure-reports/ohsome__r_rt_custom/#categories/3ca717b43fa7843ff86d06df1715634d/320dd8795d7ba343/