REST API - Add Example Values in the Responses or format Responses correctly - Githubissues

constellation-app / constellation

A graph-focused data visualisation and interactive analysis application.

https://constellation-app.com

Apache License 2.0

386 stars 58 forks source link

REST API - Add Example Values in the Responses or format Responses correctly #1455

Open Auriga2 opened 3 years ago

Auriga2 commented 3 years ago

Prerequisites

[x] Put an X between the brackets on this line if you have done all of the following:
- Running the latest version of Constellation
- Attached the Support Package via Help > Support Package
- Checked the FAQs: https://github.com/constellation-app/constellation/wiki/FAQ
- Checked that your issue isn’t already filed: https://github.com/constellation-app/constellation/issues
- Checked that there is not already a module that provides the described functionality: https://github.com/constellation-app/constellation/wiki/Catalogue-of-Repositories

Description

End points containing Request Body now have Example Values added in https://github.com/constellation-app/constellation/issues/665. It'd be nice to have Example Value added in all the Responses as well.

E.g.: could look similar to below examples, as appropriate:

(No response body vs correct example value)

End points returning an image doesn't need to contain a response body. E.g.: /v2/service/get_graph_image

Steps to Reproduce

Open Swagger (Run constellation and Tools->Start Rest Server then Display Rest Server Documentation).
Check the Example Value of Responses in endpoints.

Expected behaviour: More appropriate examples of responses.

Actual behaviour: Incorrect examples of responses.

Reproduces how often: 100%, in most of the end points.

Additional Information

Request Body Example Values are fixed in https://github.com/constellation-app/constellation/issues/665

github-actions[bot] commented 2 years ago

This issue is stale because it has been open for 6 months with no activity. Consider reviewing and taking an action on this issue.

github-actions[bot] commented 1 year ago

This issue is stale because it has been open for 6 months with no activity. Consider reviewing and taking an action on this issue.

github-actions[bot] commented 1 year ago

This issue is stale because it has been open for 6 months with no activity. Consider reviewing and taking an action on this issue.

github-actions[bot] commented 8 months ago

This issue is stale because it has been open for 6 months with no activity. Consider reviewing and taking an action on this issue.

github-actions[bot] commented 1 month ago

This issue is stale because it has been open for 6 months with no activity. Consider reviewing and taking an action on this issue.