phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-08-05 10:13:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: add more explicit prescriptions to api validator methods

Browse source 
If a validator fails, the user will have a better idea what the proper
fix would be.

Signed-off-by: Ihar Hrachyshka <ihar.hrachyshka@gmail.com>
This commit is contained in:
Ihar Hrachyshka 2025-03-31 09:51:38 -04:00
parent 508381a81d
commit 84d8f9056c
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/openapi_generator/pyopenapi/utility.py
View file

@ -132,7 +132,7 @@ def _validate_api_method_return_type(method) -> str | None:
return_type = hints['return']
if is_optional_type(return_type):
return "returns Optional type"
return "returns Optional type where a return value is mandatory"
def _validate_api_method_doesnt_return_list(method) -> str | None:
@ -143,7 +143,7 @@ def _validate_api_method_doesnt_return_list(method) -> str | None:
return_type = hints['return']
if get_origin(return_type) is list:
return "returns a list"
return "returns a list where a List*Response object is expected"
def _validate_api_delete_method_returns_none(method) -> str | None:
@ -154,7 +154,7 @@ def _validate_api_delete_method_returns_none(method) -> str | None:
return_type = hints['return']
if return_type is not None and return_type is not type(None):
return "does not return None"
return "does not return None where None is mandatory"
def _validate_list_parameters_contain_data(method) -> str | None:
@ -171,7 +171,7 @@ def _validate_list_parameters_contain_data(method) -> str | None:
return
if 'data' not in return_type.model_fields:
return "does not have data attribute"
return "does not have a mandatory data attribute containing the list of objects"
_VALIDATORS = {