Options parameter is missing in useMutation

[mnlfischer]

openapi-react-query version

0.5.0

Description

The useMutation function is missing the Options parameter like in useQuery.

useQuery Docs:

• options

  • The fetch options to use for the request.
  • Only required if the OpenApi schema requires parameters.
  • The options params are used as key. See Query Keys for more information.

This option parameter missing in useMutation and makes it impossible to pass path parameters to the types path.
Example:

api.useMutation("post", "/todos/{todo_id}/actions/delete");

Using template literal will throw an error because the path is typed.

Reproduction

Create a useMutation with path parameter and try to pass options. It is also missing in the docs so I guess this is not complicated to reproduce due to a completely missing feature. I would declare it as a bug because the function is currently not usable for urls with path parameters

Expected result

Add options with path parameters to useMutation as an argument.

api.useMutation("post", "/todos/{todo_id}/actions/delete", {
    params: {
      path: {
        todo_id,
      },
    },
  });

Extra

• I’m willing to open a PR (see CONTRIBUTING.md)

[klimeryk]

Ran into the same issue - I thought I was missing something obvious, but it looks like it's indeed missing path parameters support 🤔 I think this issue is related: #2100

[b-cooper]

The options (including path params) are passed into the mutation via the returned mutate or mutateAsync callback function.

e.g. (

const {mutate: deleteTodo} = api.useMutation("post", "/todos/{todo_id}/actions/delete")

return (
        <button
          onClick={() =>
            mutate({
              params: {
                path: {
                  todo_id,
                },
              },
            })
          }
        >
          DELETE
        </button>
)

)

The docs do show an example of passing body params from the mutate callback, but path params aren't called out directly. Maybe you could submit a PR with an update to that section of the docs with a path params example for clarity?