Skip to content

Improve "body" argument document with a link to some api page #2812

@dej611

Description

@dej611

While many client methods offer an higher level API to interact with the request, but there's always the last resort body for the uncovered cases.
Now all definitions for the body argument are like the following:

body (Dict[str, Any] | None)

It would be helpful to point the user to the API page.
I know sometimes there's an API link before the actual API arguments list, but having it inline may be more practical, in particular for those APIs with a longer list of arguments.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions