Skip to content

Commit 55b604a

Browse files
committed
Sort out some formatting and suggested improvements
1 parent 6c82362 commit 55b604a

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

draft-release-notes.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,43 +9,43 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
99
- under an `additionalOperations` entry, use any other methods not listed as keys using the correct capitalization. e.g. do NOT add HEAD under this, use the existing sibling `head`
1010

1111
- Tags
12-
- new summary field to match other things
13-
- parent field to allow hierarchy
14-
- kind to allow multiple categories of tag
15-
- a registry for some common categories (but any value can be used)
12+
- new `summary` field to allow short descriptions, used when displaying lists of tags. If you use the `x-displayName` extension, you can now use `summary` instead.
13+
- `parent` field to point to the tag that this tag is nested under. If you use `x-tagGroups`, adjust to use a tags hierarchy.
14+
- `kind` to allow multiple categories of tag. The `kind` field is free-form text, however there are some expected/conventional values such as `nav` (in line with the most common current usage as grouping for documentation output).
15+
- a [registry](https://spec.openapis.org/registry/tag-kind/index.html) to establish conventions for values used in `kind`.
1616

1717
- Security:
1818
- Support for OAuth2 Device Authorization flow with additional `deviceAuthorization` field in the `flows` object and for the individual flow, a new field `deviceAuthorizationUrl` alongside `tokenUrl`
1919
- additional security scheme field: `oauth2MetadataUrl` URL for auth server metadata
20-
- additional field to mark security schemes as deprecated (so don't use it for new stuff, but maybe still supported/valid)
21-
- can reference a security scheme by URI rather than needing it declared in components.
20+
- additional `deprecated` field for security schemes (indicating that the scheme may still be supported, but that it should not be used)
21+
- ability to reference a security scheme by URI rather than needing it declared in components.
2222

2323
- Servers:
2424
- clarify that server URLs should not include fragment or query.
25-
- support new`name` field alongside description, url and variables
26-
- formal path templating support for variable substitution in server urls
25+
- support new `name` field alongside `description`, `url` and `variables`.
26+
- formal path templating support for variable substitution in server urls.
2727

2828
- Discriminator
29-
- use discriminator to hint which anyOf or oneOf is expected (existing functionality)
30-
- discriminator `propertyName` MUST be defined but the named field can be optional (previously was required)
31-
- use `mapping` to link the discriminator property value to the Schema name if they aren't an exact match (existing functionality)
32-
- new field: `defaultMapping` says which schema to use if the `propertyName` is not set, or if the value is unrecognized
29+
- no change from previous versions: use `discriminator` to hint which entry in `anyOf` or `oneOf` is expected.
30+
- no change from previous versions: use `mapping` to link the discriminator property value to the Schema name if they aren't an exact match.
31+
- the discriminator `propertyName` can now be an optional field.
32+
- additional `defaultMapping` field to indicate which schema to use if the `propertyName` is not set, or if the value is unrecognized.
3333

3434
- **ABNF** (Augmented Backus–Naur Form) formalised for path templating, server variables, and runtime expressions in the Links object.
3535

36-
Improvements for APIs using XML as a content format:
36+
- Improvements for APIs using XML as a content format:
3737
- XML namespaces can be IRIs (rather than URIs)
3838
- Explanation and example on how to handle `null` in XML
3939

4040
- Sequential media types:
41-
- Support for sequential mediatypes such as text/event-stream for server-sent events (SSE) and application/jsonl, application/json-seq and others for sequential data.
41+
- Support for sequential mediatypes such as `text/event-stream` for server-sent events (SSE) and `application/jsonl`, `application/json-seq` and others for sequential data.
4242
- Responses can be a repeating data structure, and are treated as if they are an array of schema objects.
43-
- Use itemSchema in a mediatype entry to describe each item
43+
- Use `itemSchema` in a mediatype entry to describe each item
4444
- Related: a new media types registry is published to give more context for each of the media types
4545
- Also a "Complete vs Streaming Content" section for guidance on streaming binary payloads
4646

4747
Minor edits that are worth a mention:
48-
- Description field for responses are now optional (they used to be required but they could be empty)
48+
- The `description` field for responses are now optional (they used to be required but they could be empty)
4949
- Streamlined to YAML examples (unless something specific to another format) to try to make it easier to follow
5050
- `allowReserved` is now supported for any parameter or header, regardless of `in` location
5151

@@ -62,7 +62,6 @@ Minor edits that are worth a mention:
6262
- Clarify that Request Body Objects need to specify at least one media type to be meaningful
6363
- How to more clearly indicate that responses will not have a body
6464

65-
6665
## 3.1 Updates
6766

6867
Version 3.1.2 has no material changes but does contain editorial fixes.

0 commit comments

Comments
 (0)