[Bug][openapi] "query" and "path" type parameters can not display properly in the Redoc documentation about sanic-ext

[nightstream]

found this:

sanic-ext/sanic_ext/extensions/openapi/builders.py

Lines 137 to 149 in 4a6dda9

	def _build_merged_dict(self):
	defined_dict = self.__dict__.copy()
	autodoc_dict = self._autodoc or {}
	default_dict = self._default
	merged_dict = {}
	for d in (default_dict, autodoc_dict, defined_dict):
	cleaned = {
	k: v for k, v in d.items() if v and not k.startswith("_")
	}
	merged_dict.update(cleaned)
	return merged_dict

the _build_merged_dict function can merge three dicts which names are default_dict, autodoc_dict and defined_dict into one, but when the key is 'parameters' for example, it will just cover the autodoc_dict's value by the defined_dict's value and not merge these values.

[ahopkins]

@nightstream Thanks for debugging this! You are right, swapping the order fixes the problem.

@app.get("/<pk:strorempty>")
async def handler(request: Request, pk: Optional[str]):
    """
    openapi:
    ---
    parameters:
      - pk:
        name: pk
        in: path
        required: false
        schema:
            type: string
    """
    return json({"foo": pk})

With this line in place, it works as expected

for d in (default_dict, defined_dict, autodoc_dict):

Will get this in the next bug release coming soon.

[ahopkins]

There is probably a bigger issue that needs to be addressed in that Optional[str] should auto-imply strorempty, which should mark it as required=false automatically. But a simple fix for now is the order.

[ahopkins]

So, upon further thought, this one might need a little more consideration. Because there are certain things that we DO want defined_dict to take precedence. Primarily when you do not intend for docstring to be included and want to override the description or summary.

I think we either need another hierarchy to split apart decorators and route definitions, or carve an exception into the priority ordering for this use case.

[ahopkins]

Just pushed another change to that PR. This should do the trick and not mess up the existing preferences.