Skip to content

docs(downgrader): clarify parameter fields beside content and untyped binary strings #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dinwwwh merged 1 commit into from
Oct 20, 2026
Merged

docs(downgrader): clarify parameter fields beside content and untyped binary strings #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/downgrader/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ Schema Objects inside the document convert as in [Schema](#schema-downgradeschem
| [`in: "querystring"`][3.2-parameter-locations] parameters | Removed, with the `$ref`s to them. |
| [`allowReserved`][3.2-parameter-allow-reserved] outside `in: "query"` | Removed. 3.1 applies it only to query parameters. |
| [`style: "cookie"`][3.2-style-values] | Removed, leaving the `form` default. |
| Parameter [`example`][3.2-parameter-example], [`examples`][3.2-parameter-examples], `style`, `explode`, and `allowReserved` beside `content` | Removed. 3.1 allows them only beside `schema`. The media types keep their own examples. |
| Parameter [`example`][3.2-parameter-example] and [`examples`][3.2-parameter-examples] beside `content` | Removed. 3.1 allows them only beside `schema`. The media types keep their own examples. |
| Parameter `style`, `explode`, and `allowReserved` beside `content`, which neither version allows | Removed. |
| Media Type [`description`][3.2-schema] | Removed. |
| Media Type [`itemSchema`][3.2-media-type-item-schema] | Alone, `schema: { type: "array", items: … }`. Beside `schema`, which describes the whole body, removed. |
| Media Type [`prefixEncoding`][3.2-media-type-prefix-encoding] and [`itemEncoding`][3.2-media-type-item-encoding], and Encoding Object [`encoding`][3.2-encoding-encoding], `prefixEncoding`, and `itemEncoding` | Removed. 3.1 matches multipart parts only by property name, and does not nest encodings. |
Expand Down Expand Up @@ -241,6 +242,7 @@ Accepts the default OAS dialect, which adds `discriminator`, `xml`, `externalDoc
- Recursion through `$defs` is cut to `{}` after one level. Where several `$ref`s enter the same cycle, the first copy made is reused, so a later one can be cut sooner.
- Older drafts are not supported. `definitions` is read as `$defs`, but other keywords that only draft-07 or 2019-09 define, such as `dependencies` and `additionalItems`, become extensions unconverted, so `$ref`s into them dangle, and array-form `items` passes through. Convert such schemas to 2020-12 first.
- `patternProperties` that matches every name, as TypeBox emits for a record, is removed with its value schema rather than turned into `additionalProperties`.
- An untyped schema that gains a `format` from `contentEncoding` or `contentMediaType` also gains `type: "string"`, as 3.0 binary strings need, so it rejects non-string values it accepted. 3.0 tools find file uploads only by `type: "string"` with `format: "binary"`.

## Performance

Expand Down
Loading