Skip to content

Commit 9996192

Browse files
fix: address vale linting issues
- Change heading to sentence-style capitalization - Remove unnecessary adverb 'properly' - Use contraction 'isn't' instead of 'is not' - Add 'HTTP' prefix to PATCH to clarify acronym Co-Authored-By: Devin Logan <[email protected]>
1 parent 4dcce4a commit 9996192

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

fern/products/api-def/ferndef-pages/types.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ Types describe the data model of your API.
2727
| `file` | File upload type, e.g., [file uploads](/learn/api-definition/fern/endpoints/multipart) |
2828
| `unknown` | Represents arbitrary JSON |
2929

30-
### Optional vs Nullable
30+
### Optional vs nullable
3131

32-
Understanding the difference between `optional` and `nullable` is important for properly modeling your API:
32+
Understanding the difference between `optional` and `nullable` is important for modeling your API:
3333

34-
- **`optional<T>`**: The field can be omitted from the request/response entirely. When omitted, the field is not sent over the wire.
34+
- **`optional<T>`**: The field can be omitted from the request/response entirely. When omitted, the field isn't sent over the wire.
3535
- **`nullable<T>`**: The field must be present but can be explicitly set to `null`. This allows you to distinguish between "not specified" and "explicitly cleared".
3636

3737
```yaml
@@ -43,12 +43,12 @@ types:
4343
bio: nullable<string> # Must be present, but can be null
4444
```
4545
46-
This distinction is particularly important for PATCH requests where you need to differentiate between:
46+
This distinction is particularly important for HTTP PATCH requests where you need to differentiate between:
4747
1. **Omitting a field** - Don't update this field (keep existing value)
4848
2. **Setting to `null`** - Clear this field (remove the value)
4949
3. **Setting to a value** - Update this field with a new value
5050

51-
#### Example: PATCH request semantics
51+
#### Example: HTTP PATCH request semantics
5252

5353
```yaml
5454
types:

0 commit comments

Comments
 (0)