Skip to content

Decorators

Identifies when the target was added.

@TypeSpec.Versioning.added(version: EnumMember)

Model | ModelProperty | Operation | Enum | EnumMember | Union | UnionVariant | Scalar | Interface

NameTypeDescription
versionEnumMemberThe version that the target was added in.
@added(Versions.v2)
op addedInV2(): void;
@added(Versions.v2)
model AlsoAddedInV2 {}
model Foo {
name: string;
@added(Versions.v3)
addedInV3: string;
}

Identifies when a target was made optional.

@TypeSpec.Versioning.madeOptional(version: EnumMember)

ModelProperty

NameTypeDescription
versionEnumMemberThe version that the target was made optional in.
model Foo {
name: string;
@madeOptional(Versions.v2)
nickname?: string;
}

Identifies when a target was made required.

@TypeSpec.Versioning.madeRequired(version: EnumMember)

ModelProperty

NameTypeDescription
versionEnumMemberThe version that the target was made required in.
model Foo {
name: string;
@madeRequired(Versions.v2)
nickname: string;
}

Identifies when the target was removed.

@TypeSpec.Versioning.removed(version: EnumMember)

Model | ModelProperty | Operation | Enum | EnumMember | Union | UnionVariant | Scalar | Interface

NameTypeDescription
versionEnumMemberThe version that the target was removed in.
@removed(Versions.v2)
op removedInV2(): void;
@removed(Versions.v2)
model AlsoRemovedInV2 {}
model Foo {
name: string;
@removed(Versions.v3)
removedInV3: string;
}

Identifies when the target has been renamed.

@TypeSpec.Versioning.renamedFrom(version: EnumMember, oldName: valueof string)

Model | ModelProperty | Operation | Enum | EnumMember | Union | UnionVariant | Scalar | Interface

NameTypeDescription
versionEnumMemberThe version that the target was renamed in.
oldNamevalueof stringThe previous name of the target.
@renamedFrom(Versions.v2, "oldName")
op newName(): void;

Identifies when the target type changed.

@TypeSpec.Versioning.returnTypeChangedFrom(version: EnumMember, oldType: unknown)

Operation

NameTypeDescription
versionEnumMemberThe version that the target type changed in.
oldTypeunknownThe previous type of the target.

Identifies when the target type changed.

@TypeSpec.Versioning.typeChangedFrom(version: EnumMember, oldType: unknown)

ModelProperty

NameTypeDescription
versionEnumMemberThe version that the target type changed in.
oldTypeunknownThe previous type of the target.

Identifies that a namespace or a given versioning enum member relies upon a versioned package.

@TypeSpec.Versioning.useDependency(...versionRecords: EnumMember[])

EnumMember | Namespace

NameTypeDescription
versionRecordsEnumMember[]The dependent library version(s) for the target namespace or version.
@useDependency(MyLib.Versions.v1_1)
namespace NonVersionedService;
Select which version of the library match to which version of the service.
Section titled “Select which version of the library match to which version of the service.”
@versioned(Versions)
namespace MyService1;
enum Version {
@useDependency(MyLib.Versions.v1_1) // V1 use lib v1_1
v1,
@useDependency(MyLib.Versions.v1_1) // V2 use lib v1_1
v2,
@useDependency(MyLib.Versions.v2) // V3 use lib v2
v3,
}

Identifies that the decorated namespace is versioned by the provided enum.

@TypeSpec.Versioning.versioned(versions: Enum)

Namespace

NameTypeDescription
versionsEnumThe enum that describes the supported versions.
@versioned(Versions)
namespace MyService;
enum Versions {
v1,
v2,
v3,
}