mirror of
https://github.com/LukeHagar/openapi-types.git
synced 2025-12-09 12:37:47 +00:00
Prettier formatting
This commit is contained in:
94
2.0/xml.ts
94
2.0/xml.ts
@@ -88,55 +88,55 @@ import type { Extension } from "./extensions";
|
||||
* ```
|
||||
*/
|
||||
export interface XMLObject extends Extension {
|
||||
/**
|
||||
* Replaces the name of the element/attribute used for the described schema property.
|
||||
* When defined within the Items Object, it will affect the name of the individual
|
||||
* XML elements within the list. When defined alongside type being array (outside
|
||||
* the items), it will affect the wrapping element and only if wrapped is true.
|
||||
*
|
||||
* @example "animal"
|
||||
* @example "item"
|
||||
* @example "person"
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Replaces the name of the element/attribute used for the described schema property.
|
||||
* When defined within the Items Object, it will affect the name of the individual
|
||||
* XML elements within the list. When defined alongside type being array (outside
|
||||
* the items), it will affect the wrapping element and only if wrapped is true.
|
||||
*
|
||||
* @example "animal"
|
||||
* @example "item"
|
||||
* @example "person"
|
||||
*/
|
||||
name?: string;
|
||||
|
||||
/**
|
||||
* The URL of the namespace definition. Value SHOULD be in the form of a URL.
|
||||
*
|
||||
* @example "http://example.com/schema/sample"
|
||||
* @example "http://www.w3.org/2001/XMLSchema"
|
||||
* @example "http://swagger.io/schema/sample"
|
||||
*/
|
||||
namespace?: string;
|
||||
/**
|
||||
* The URL of the namespace definition. Value SHOULD be in the form of a URL.
|
||||
*
|
||||
* @example "http://example.com/schema/sample"
|
||||
* @example "http://www.w3.org/2001/XMLSchema"
|
||||
* @example "http://swagger.io/schema/sample"
|
||||
*/
|
||||
namespace?: string;
|
||||
|
||||
/**
|
||||
* The prefix to be used for the name.
|
||||
*
|
||||
* @example "sample"
|
||||
* @example "xs"
|
||||
* @example "ex"
|
||||
*/
|
||||
prefix?: string;
|
||||
/**
|
||||
* The prefix to be used for the name.
|
||||
*
|
||||
* @example "sample"
|
||||
* @example "xs"
|
||||
* @example "ex"
|
||||
*/
|
||||
prefix?: string;
|
||||
|
||||
/**
|
||||
* Declares whether the property definition translates to an attribute instead of an element.
|
||||
* Default value is false.
|
||||
*
|
||||
* @default false
|
||||
* @example true
|
||||
* @example false
|
||||
*/
|
||||
attribute?: boolean;
|
||||
/**
|
||||
* Declares whether the property definition translates to an attribute instead of an element.
|
||||
* Default value is false.
|
||||
*
|
||||
* @default false
|
||||
* @example true
|
||||
* @example false
|
||||
*/
|
||||
attribute?: 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).
|
||||
*
|
||||
* @default false
|
||||
* @example true
|
||||
* @example false
|
||||
*/
|
||||
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).
|
||||
*
|
||||
* @default false
|
||||
* @example true
|
||||
* @example false
|
||||
*/
|
||||
wrapped?: boolean;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user