Missing documentation for BaseProcessor.execute()

[francescoingv]

The documentation for the output parameter of BaseProcessor.execute() is not sufficient The standard allows for several output types, e.g. string, integer, object, array, binary, etc, as well as multiple outputs. However there is no clear documentation in BaseProcessor.execute() on what the derived classes should return in each of these cases.

Additionally the BaseManager.execute_process() currently expects only outputs of type dict or bytes: this is not documented, but can be find following the code in debug.

Currently only examples with single output of type object and mimetype application/json are available: HelloWorldProcessor echoProcessor (Note: despite what it is declared into the metadata it returns an object of mimetype 'application/json' ).

Therefore, it is impossible to understand how to format the returned output(s) from Processor, and in case of an unexpected behavior, whether the issue come from a bad coding of the class derived from BaseProcessor, or from a bug in the API.

Steps to Reproduce N/A

Expected behavior A clear description in BaseManager.execute_process() of what it is expected for process response, as currently it only state: returns: tuple of MIME type and process response

Environment

• OS: any
• Python version: 3.8.10
• pygeoapi version: master

[github-actions[bot]]

This Issue has been inactive for 90 days. As per RFC4, in order to manage maintenance burden, it will be automatically closed in 7 days.

[github-actions[bot]]

As per RFC4, this Issue has been closed due to there being no activity for more than 90 days.