OpenSpecXML

@tsed/openspec

Usage

import { OpenSpecXML } from "@tsed/openspec";

See /packages/specs/openspec/src/types/common/OpenSpecXML.ts.

Overview

interface OpenSpecXML {
    name?: string;
    namespace?: string;
    prefix?: string;
    attribute?: boolean;
    wrapped?: boolean;
}

name

name?: string;

Replaces the name of the element/attribute used for the described schema property. When defined within items, 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. If wrapped is false, it will be ignored.

namespace

namespace?: string;

The URI of the namespace definition. Value MUST be in the form of an absolute URI.

prefix

prefix?: string;

The prefix to be used for the name.

attribute

attribute?: boolean;

Declares whether the property definition translates to an attribute instead of an element. Default value is false.

wrapped

wrapped?: boolean;

MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).