Add custom 'Example Value' in the Rest API 'Request body'

Description

The Request body sections in the REST API endpoints below can be improved with a custom Example Value

plugins parameter in run_plugins endpoint args parameter in run_plugin endpoint data parameter in add_recordstore endpoint

Steps to Reproduce

1. Open Swagger (Run constellation and Tools->Start Rest Server thenthen Display Rest Server Documentation)
2. Check above endpoints

Expected behaviour: Custom Example Values displayed in the Request Body

Actual behaviour: Example Value is empty:

Reproduces how often: 100%

Additional Information

[arcturus2]

Hi @Auriga2 I’ve been reading along though didn’t respond yet.

OK with hard coding the values for the 3 endpoints. That will be of great help. OK with your examples.

It’d be nice to have Example Value added in all the Responses as well, (if it’s worth the effort because someone has to go through all the plugins and determine this), probably in a different ticket.

Yes this will definitely help and worth making a different ticket. Might as well link this ticket to it too.

Regarding the presentation of the responses in Swagger based on the images above I like the how they are formatted. The blue background is for GET’s and green is for POST’s so it depends based on the endpoint.

I think the authorize button is cool. If that can be put in once and then referenced in all the endpoints without having to put it in each time that would be great.

Please feel free to make another ticket with your ideas if you don’t want to get them done in this one.

Anyway looking forward to reviewing the PR when you’re ready.

[GammaVel]

That explains where the tick came from. I think it is best to keep it. Thanks for getting back to me @Auriga2 so fast! Very speedy.