[Bug]: Inconsistent Example Schema for Request Body of Stored-Procedure in Swagger UI

[abhishekkumams]

What happened?

Example schema for request body shown for stored-procedure is not consistent.

To reproduce:

1. Use the dab-config.MsSql.json to start the engine.
2. open the swagger UI through the endpoint : https://localhost:5001/swagger

Inconsistencies noted:

1. Empty schema for request Body shown for /InsertBook (missing parameter info)
   

2. Incorrect request body schema shown for /CountBook, (should be empty json, as it doesn’t need params)
   

3. Incorrect request body schema shown for /UpdateBookTitle, (publisher_id is not required in the request payload.)
   
   Similar issue with /GetAuthorsHistoryByFirstName and /InsertAndDisplayAllBooksUnderGivenPublisher

Version

0.7.5

What database are you using?

Azure SQL

What hosting model are you using?

Local (including CLI)

Which API approach are you accessing DAB through?

REST

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[seantleonard]

/CountBook SP incorrectly created by erroneously including the parameter total_books

• OpenApiDocumentor should denote a request body as required if at least one parameter exists which does not have a default value in runtime config or db schema.
  • To correctly mitigate, we need separate logic to handle stored procedures is needed in the function IsRequestBodyRequired(), because function currently iterates through "columndefinitions" regardless of DatabaseObject/SourceDefinition type. which results in the erroneous SP result set column showing up as a parameter in the openapi doc.
  • Also add logic when creating the component schemas to create objects for SP request and response -> request object will consist of parameters, and response object will be columns.
  • Alternatively, if the current mitigation is to set the parameter in the runtime configuration with a default value so OpenAPI can document the parameter, then the Swagger doc can execute the request. The caveat is that the request executes with the default value when that may not be desired.

[seantleonard]

fix is in branch. Tests can be written against new config pr once merged.