Skip to content

fix: Modify openAPI description #3231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shaohuzhang1 merged 1 commit into from
Jun 10, 2025
Merged

fix: Modify openAPI description #3231

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions apps/application/views/application_chat_record.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ class ApplicationChatRecord(APIView):

@extend_schema(
methods=['GET'],
description=_("Get the conversation list"),
summary=_("Get the conversation list"),
operation_id=_("Get the conversation list"), # type: ignore
description=_("Get the conversation record list"),
summary=_("Get the conversation record list"),
operation_id=_("Get the conversation record list"), # type: ignore
request=ApplicationChatRecordQueryAPI.get_request(),
parameters=ApplicationChatRecordQueryAPI.get_parameters(),
responses=ApplicationChatRecordQueryAPI.get_response(),
Copy link
Copy Markdown
Contributor Author

@shaohuzhang1 shaohuzhang1 Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code looks mostly correct, but there is one minor issue with the use of underscores in the function and variable names. In Python, using double underscores (dunder) for special method names like __init__ or __str__, can conflict with how they are used. However, since you're only using these names here as metadata tags rather than actual methods/functions, this should not be a problem.

Recommendations:

  1. Remove Leading Underscores: While it's usually good practice to avoid leading underscores for public members, in this context, it doesn't affect functionality.

  2. Simplify Names: Consider simplifying some of the descriptions if they contain excessive repetition ("Get the conversation list" in both description and summary).

  3. Optimization Suggestions:

    • Ensure that the get_request() and get_parameters() functions return proper Django serializer instances or dictionaries.
    • Verify that the get_response() function returns appropriate status codes and data structures based on success or failure scenarios.

Overall, the code appears well-designed and should work correctly based on the provided schema definitions.

Expand Down
Loading