Skip to content

updates for the "xml" and "example" keywords #4966

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
merged 3 commits into from
Sep 18, 2025
Merged

updates for the "xml" and "example" keywords #4966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2774312
these two xml properties are now deprecated; harmonize spec language
karenetheridge Sep 18, 2025
ec81bb8
the "example" keyword is now deprecated
karenetheridge Sep 18, 2025
c2b1114
"propertyName" is no longer required
karenetheridge Sep 18, 2025
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: 2 additions & 2 deletions src/oas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3819,8 +3819,8 @@ When using a Schema Object with XML, if no XML Object is present, the behavior i
| <a name="xml-name"></a>name | `string` | Sets the name of the element/attribute corresponding to the schema, replacing the name that was inferred as described under [XML Node Names](#xml-node-names). This field SHALL be ignored if the `nodeType` is `text`, `cdata`, or `none`. |
| <a name="xml-namespace"></a>namespace | `string` | The IRI ([[RFC3987]]) of the namespace definition. Value MUST be in the form of a non-relative IRI. |
| <a name="xml-prefix"></a>prefix | `string` | The prefix to be used for the [name](#xml-name). |
| <a name="xml-attribute"></a>attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. If `nodeType` is present, this field MUST NOT be present.<br /><br />**Deprecated:** Use `nodeType: "attribute"` in place of `attribute: true` |
| <a name="xml-wrapped"></a>wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, `<books><book/><book/></books>`) or unwrapped (`<book/><book/>`). Default value is `false`. The definition takes effect only when defined alongside `type` being `"array"` (outside the `items`). If `nodeType` is present, this field MUST NOT be present.<br /><br />**Deprecated:** Set `nodeType: "element"` explicitly in place of `wrapped: true` |
| <a name="xml-attribute"></a>attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. If `nodeType` is present, this field MUST NOT be present.<br /><br />**Deprecated:** Use `nodeType: "attribute"` instead of `attribute: true` |
| <a name="xml-wrapped"></a>wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, `<books><book/><book/></books>`) or unwrapped (`<book/><book/>`). Default value is `false`. The definition takes effect only when defined alongside `type` being `"array"` (outside the `items`). If `nodeType` is present, this field MUST NOT be present.<br /><br />**Deprecated:** Use `nodeType: "element"` instead of `wrapped: true` |

Note that when generating an XML document from object data, the order of the nodes is undefined.
Use `prefixItems` to control node ordering as shown under [Ordered Elements and Text](#ordered-elements-and-text).
Expand Down
7 changes: 4 additions & 3 deletions src/schemas/validation/meta.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ type:
properties:
discriminator:
$ref: '#/$defs/discriminator'
example: true
example:
deprecated: true
externalDocs:
$ref: '#/$defs/external-docs'
xml:
Expand All @@ -33,8 +34,6 @@ $defs:
type: string
propertyName:
type: string
required:
- propertyName
type: object
unevaluatedProperties: false

Expand Down Expand Up @@ -74,8 +73,10 @@ $defs:
type: string
attribute:
type: boolean
deprecated: true
wrapped:
type: boolean
deprecated: true
type: object
dependentSchemas:
nodeType:
Expand Down