None type returned for http response code != 200

[jpjoux]

Hello @ramnes

Is it normal that http code != 200 return a None object ?
result = client.delete_user(username=user.username)

result is

• type ApiResponse for http response 200
• None for other http code

[ramnes]

Hello @jpjoux! What would you expect exactly?

[jpjoux]

An ApiResponse object for other http response code with all related information provided by SftpGo
For example when you curl the API with invalid data, SFTPGo return a response explaing the issue.
So I expect to have it through the ApiResponse object

[stdietrich]

This might be an issue with the OpenAPI Python Client, which has been used to generate this client. If you dereference the openapi.yaml to remove the $refs, the OpenAPI Python Client generates different code.

For HTTP status codes != 200, it'll now return proper responses. See below for the diff of the sftpgo_client/base/api/folders/update_folders.py based on a dereferenced openapi.yaml:

@@ -30,25 +35,39 @@ def _get_kwargs(
 
 def _parse_response(
     *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Optional[Union[Any, ApiResponse]]:
+) -> Optional[
+    Union[
+        UpdateFolderResponse200,
+        UpdateFolderResponse400,
+        UpdateFolderResponse401,
+        UpdateFolderResponse403,
+        UpdateFolderResponse404,
+        UpdateFolderResponse500,
+    ]
+]:
     if response.status_code == HTTPStatus.OK:
-        response_200 = ApiResponse.from_dict(response.json())
+        response_200 = UpdateFolderResponse200.from_dict(response.json())
 
         return response_200
     if response.status_code == HTTPStatus.BAD_REQUEST:
-        response_400 = cast(Any, None)
+        response_400 = UpdateFolderResponse400.from_dict(response.json())
+
         return response_400
     if response.status_code == HTTPStatus.UNAUTHORIZED:
-        response_401 = cast(Any, None)
+        response_401 = UpdateFolderResponse401.from_dict(response.json())
+
         return response_401
     if response.status_code == HTTPStatus.FORBIDDEN:
-        response_403 = cast(Any, None)
+        response_403 = UpdateFolderResponse403.from_dict(response.json())
+
         return response_403
     if response.status_code == HTTPStatus.NOT_FOUND:
-        response_404 = cast(Any, None)
+        response_404 = UpdateFolderResponse404.from_dict(response.json())
+
         return response_404
     if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR:
-        response_500 = cast(Any, None)
+        response_500 = UpdateFolderResponse500.from_dict(response.json())
+
         return response_500
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)

I have not yet completely tracked down the exact reason for this in the OpenAPI Python Client codebase.

[ramnes]

With the latest version of openapi-python-client, we should now be able to always call raise_for_status (see the discussion here).

@stdietrich, @jpjoux, would that be a solution for you?