Skip to content

Commit 770ad61

Browse files
Quote types in README.md (#2026)
See also misleading description for `MultiPart` parameters #2016
1 parent 95bba78 commit 770ad61

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1020,16 +1020,16 @@ Note: in .NET 5 `HttpRequestMessage.Properties` has been marked `Obsolete` and R
10201020
Methods decorated with `Multipart` attribute will be submitted with multipart content type.
10211021
At this time, multipart methods support the following parameter types:
10221022

1023-
- string (parameter name will be used as name and string value as value)
1023+
- `string` (parameter name will be used as name and string value as value)
10241024
- byte array
1025-
- Stream
1026-
- FileInfo
1025+
- `Stream`
1026+
- `FileInfo`
10271027

10281028
Name of the field in the multipart data priority precedence:
10291029

1030-
* multipartItem.Name if specified and not null (optional); dynamic, allows naming form data part at execution time.
1031-
* [AliasAs] attribute (optional) that decorate the streamPart parameter in the method signature (see below); static, defined in code.
1032-
* MultipartItem parameter name (default) as defined in the method signature; static, defined in code.
1030+
* `multipartItem.Name` if specified and not null (optional); dynamic, allows naming form data part at execution time.
1031+
* `[AliasAs]` attribute (optional) that decorate the streamPart parameter in the method signature (see below); static, defined in code.
1032+
* `MultipartItem` parameter name (default) as defined in the method signature; static, defined in code.
10331033

10341034
A custom boundary can be specified with an optional string parameter to the `Multipart` attribute. If left empty, this defaults to `----MyGreatBoundary`.
10351035

@@ -1045,13 +1045,13 @@ public interface ISomeApi
10451045
}
10461046
```
10471047

1048-
To pass a Stream to this method, construct a StreamPart object like so:
1048+
To pass a `Stream` to this method, construct a StreamPart object like so:
10491049

10501050
```csharp
10511051
someApiInstance.UploadPhoto(id, new StreamPart(myPhotoStream, "photo.jpg", "image/jpeg"));
10521052
```
10531053

1054-
Note: The AttachmentName attribute that was previously described in this section has been deprecated and its use is not recommended.
1054+
Note: The `AttachmentName` attribute that was previously described in this section has been deprecated and its use is not recommended.
10551055

10561056
### Retrieving the response
10571057

0 commit comments

Comments
 (0)