[Improve documentation] advertise more explicitly that you don't need to declare path parameters

[thelinuxlich]

Something like:

apiBuilder({
    method: 'get',
    path: '/orders/:order/status',
    alias: 'getStatusOrder',
    parameters: [
      {
        type: 'Path',
        name: 'order',
        schema: z.string(),
      },
    ],
    response: {
      schema: OrdersGetStatusOutputSchema,
    },
  })

[thelinuxlich]

Nevermind, I just looked at the tests and saw we don't need to define a param in this case, it's passed as the second parameter for the route. So what's missing is a small tip about it on the docs.

[ecyrbe]

yes, i will make it more explicit in the docs that path params are deduced implicitly and that you need to provide them in params attribute.

[ecyrbe]

example on how to call it

client.getStatusOrder({ params: { order : 5678 } });

[ecyrbe]

@thelinuxlich could you hint me where in the documentation you think this information would be more helpfull ?

[thelinuxlich]

https://www.zodios.org/docs/client#zodiosalias

[ecyrbe]

@thelinuxlich done. Maybe i over did it. added more examples and added a note.

Here for each call and at the first example: https://www.zodios.org/docs/client

And here on API definition: https://www.zodios.org/docs/api/api-definition#parameters

Closing.