"Query string for this HTTP request type is an invalid URL." when executing a stored procedure using POST

When calling a stored procedure, also passing parameters, using the POST method, I get the following error:

{
  "error": {
    "code": "BadRequest",
    "message": "Query string for this HTTP request type is an invalid URL.",
    "status": 400
  }
}

everything works fine if I use the GET method. I haven’t tested with other HTTP methods, but I suspect I’ll get the same error.

This is the error message I can see in the log:

Microsoft.AspNetCore.Routing.EndpointMiddleware[0]
      Executing endpoint 'Azure.DataApiBuilder.Service.Controllers.RestController.Insert (Azure.DataApiBuilder.Service)'
info: Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker[3]
      Route matched with {action = "Insert", controller = "Rest"}. Executing controller action with signature System.Threading.Tasks.Task`1[Microsoft.AspNetCore.Mvc.IActionResult] Insert(System.String) on controller Azure.DataApiBuilder.Service.Controllers.RestController (Azure.DataApiBuilder.Service).   
fail: Azure.DataApiBuilder.Service.Controllers.RestController[0]
      Query string for this HTTP request type is an invalid URL.
fail: Azure.DataApiBuilder.Service.Controllers.RestController[0]
         at Azure.DataApiBuilder.Service.Services.RequestValidator.ValidateInsertRequest(String queryString, String requestBody)
         at Azure.DataApiBuilder.Service.Services.RestService.PopulateStoredProcedureContext(Operation operationType, DatabaseObject dbObject, String entityName, String queryString, String primaryKeyRoute, String requestBody, RestRequestContext& context)
         at Azure.DataApiBuilder.Service.Services.RestService.ExecuteAsync(String entityName, Operation operationType, String primaryKeyRoute)
         at Azure.DataApiBuilder.Service.Controllers.RestController.HandleOperation(String route, Operation operationType)

[yorek]

May bad, I didn’t remember that. Documentation doesn’t mention it (https://github.com/Azure/data-api-builder/blob/main/docs/views-and-stored-procedures.md#rest-support-for-stored-procedures) so it needs to be added as now only mention the following:

If the stored procedure accepts parameters, those can be passed in the URL query string when calling the REST endpoint. For example:

which is incomplete

[seantleonard]

@yorek, this is by design from the stored procedure specification

[REST] [parameters can either be fixed as above or passed at runtime through] request body for POST, PUT, PATCH, DELETE

For POST-ing to GetCowrittenBooksByAuthor you’d have to add a JSON request body with your desired parameters/values: URL: [POST] /api/cowrittenBooksByAuthor Body:

{
    "author": "*",
    "searchType": "s"
}

https://github.com/Azure/data-api-builder/blob/daf7dd8bf6737266b32b3eb86fb926dacd92f8a8/docs/internals/StoredProcedureDesignDoc.md?plain=1#L35-L38