Skip to content

Commit 2e6f532

Browse files
committed
docs: document query parameter decoding
1 parent 9c9b978 commit 2e6f532

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,13 @@ func (u *UsersService) ListUsers(pagination Paginate) ([]User, error) {
121121
}
122122
```
123123

124-
Note: For query parameters, only a limited set of field types are currently
125-
supported, and embedded structs are not supported.
124+
#### Query parameter decoding
125+
126+
For query parameters, embedded structs are not supported and fields may
127+
(currently) only be of types `bool`, `int` and `string`.
128+
129+
The name of the query parameter will be the name of the Go field with the first
130+
letter lower-cased. This can be overridden with the field tag `query:"<name>"`.
126131

127132
## Response signature
128133

0 commit comments

Comments
 (0)