Skip to content

Commit a0323b8

Browse files
lornajanehandrews
andauthored
Apply suggestions from code review
Co-authored-by: Henry Andrews <[email protected]>
1 parent 5b29057 commit a0323b8

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

draft-release-notes.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,13 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
2929
- support new `name` field alongside `description`, `url` and `variables`.
3030
- formal path templating support for variable substitution in server urls.
3131

32-
### Discriminator
32+
### Code Generation
3333

34-
- no change from previous versions: use `discriminator` to hint which entry in `anyOf` or `oneOf` is expected.
35-
- no change from previous versions: use `mapping` to link the discriminator property value to the Schema name if they aren't an exact match.
3634
- the discriminator `propertyName` can now be an optional field.
3735
- additional `defaultMapping` field to indicate which schema to use if the `propertyName` is not set, or if the value is unrecognized.
36+
- no change from previous versions: use `discriminator` to hint which entry in `anyOf` or `oneOf` is expected.
37+
- no change from previous versions: use `mapping` to link the discriminator property value to the Schema name if they aren't an exact match.
38+
- Implementations now SHOULD (rather than MAY) support templates/generics using `$dynamicRef`
3839

3940
### Reference resolution
4041

@@ -44,6 +45,10 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
4445

4546
### Improvements for APIs using XML as a content format
4647

48+
- New `nodeType` field allows maping schemas to all common XML node types (elements, attributes, text, or cdata) or to nothing
49+
- `attribute: true` deprecated in favor of `nodeType: attribute`
50+
- `wrapped: true` deprecated in favor of `nodeType: element` (as `nodeType` defaults to `none` for arrays to preserve compatibility)
51+
- The `xml` keyword can be used in any Schema Object
4752
- XML namespaces can be IRIs (rather than URIs)
4853
- Explanation and example on how to handle `null` in XML
4954
Clarify that the root schema of an XML object should use the component name.
@@ -56,11 +61,11 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
5661
- Related: a new media types registry is published to give more context for each of the media types
5762
- Also a "Complete vs Streaming Content" section for guidance on streaming binary payloads
5863

59-
### Parameters
64+
### Parameters and Headers
6065

6166
- additional parameter location `querystring`, to allow parsing the entire query string as a single field similar to the way a request body is handled, using the `content` field. Useful for complex or unconventional query data. Mutually exclusive with the `query` field.
6267
- parameters can therefore be `in` the `querystring` as an alternative to the existing `header`, `cookie`, `query` and `path` values.
63-
- `allowReserved` field is now permitted on parameters with any value of `in` (however this many not be a Good Idea (TM) in some scenarios)
68+
- `allowReserved` field is now permitted on parameters and headers with any value of `in` (however this many not be a Good Idea (TM) in some scenarios)
6469

6570
### Responses
6671

0 commit comments

Comments
 (0)