Skip to content
TypeSpec
Use cases
OpenAPI
Data Validation
Tooling support
Docs
Videos
Playground
Blog
Community
Version 1.0.0-rc.1 is now available!
Search...
Getting started
Installation
Editor
VS Code Extension
Visual Studio Extension
Guides
TypeSpec for REST
Getting Started with TypeSpec For REST APIs
Operations and Responses
Handling Errors
Common Parameters
Authentication
Versioning
Custom Response Models
Conclusion
TypeSpec for OpenAPI Developers
Handbook
Cli usage
Style guide
Formatter
Package Manager
Reproducibility
Breaking Change Policy
Configuration
Configuration
Tracing
FAQ
📐 Language Basics
Overview
Built-in types
Identifiers
Imports
Namespaces
Decorators
Directives
Documentation
Scalars
Models
Operations
Interfaces
Templates
Enums
Unions
Intersections
Type Literals
Aliases
Values
Type Relations
Visibility
📘 Standard Library
Built-in Decorators
Built-in Data types
Js api
Classes
[C] EventEmitter
Enumerations
[E] IdentifierKind
[E] ListenerFlow
[E] ModifierFlags
[E] SemanticTokenKind
[E] UsageFlags
Functions
[F] $encodedName
[F] Numeric
[F] addService
[F] addVisibilityModifiers
[F] assertType
[F] checkFormatTypeSpec
[F] clearVisibilityModifiersForClass
[F] compile
[F] compilerAssert
[F] createDiagnosticCollector
[F] createRule
[F] createServer
[F] createSourceFile
[F] createTypeSpecLibrary
[F] defineCodeFix
[F] defineLinter
[F] definePackageFlags
[F] emitFile
[F] ensureTrailingDirectorySeparator
[F] explainStringTemplateNotSerializable
[F] filterModelProperties
[F] formatDiagnostic
[F] formatIdentifier
[F] formatTypeSpec
[F] getAllTags
[F] getAnyExtensionFromPath
[F] getBaseFileName
[F] getDeprecated
[F] getDeprecationDetails
[F] getDirectoryPath
[F] getDiscriminatedTypes
[F] getDiscriminatedUnion
[F] getDiscriminatedUnionFromInheritance
[F] getDiscriminator
[F] getDoc
[F] getDocData
[F] getEffectiveModelType
[F] getEntityName
[F] getErrorsDoc
[F] getErrorsDocData
[F] getExamples
[F] getLifecycleVisibilityEnum
[F] getLocationContext
[F] getMaxItems
[F] getMaxItemsAsNumeric
[F] getMaxLength
[F] getMaxLengthAsNumeric
[F] getMaxValue
[F] getMaxValueAsNumeric
[F] getMaxValueExclusive
[F] getMaxValueExclusiveAsNumeric
[F] getMediaTypeHint
[F] getMinItems
[F] getMinItemsAsNumeric
[F] getMinLength
[F] getMinLengthAsNumeric
[F] getMinValue
[F] getMinValueAsNumeric
[F] getMinValueExclusive
[F] getMinValueExclusiveAsNumeric
[F] getNamespaceFullName
[F] getNormalizedAbsolutePath
[F] getNormalizedAbsolutePathWithoutRoot
[F] getNormalizedPathComponents
[F] getOpExamples
[F] getPagingOperation
[F] getParameterVisibilityFilter
[F] getPathComponents
[F] getPathFromPathComponents
[F] getPattern
[F] getPositionBeforeTrivia
[F] getProperty
[F] getPropertyType
[F] getRelativePathFromDirectory
[F] getReturnTypeVisibilityFilter
[F] getReturnsDoc
[F] getReturnsDocData
[F] getRootLength
[F] getSourceFileKindFromExt
[F] getSourceLocation
[F] getTags
[F] getTypeName
[F] getVisibilityForClass
[F] hasTrailingDirectorySeparator
[F] hasVisibility
[F] ignoreDiagnostics
[F] interpolatePath
[F] isAnyDirectorySeparator
[F] isArrayModelType
[F] isDeclaredInNamespace
[F] isDeclaredType
[F] isDeprecated
[F] isErrorModel
[F] isErrorType
[F] isGlobalNamespace
[F] isKey
[F] isNeverType
[F] isNullType
[F] isNumeric
[F] isNumericType
[F] isPathAbsolute
[F] isRecordModelType
[F] isSealed
[F] isService
[F] isStdNamespace
[F] isStringType
[F] isTemplateDeclaration
[F] isTemplateDeclarationOrInstance
[F] isTemplateInstance
[F] isType
[F] isTypeSpecValueTypeOf
[F] isUnknownType
[F] isUrl
[F] isValue
[F] isVisible
[F] isVoidType
[F] joinPaths
[F] listOperationsIn
[F] listServices
[F] logDiagnostics
[F] mapEventEmitterToNodeListener
[F] markDeprecated
[F] navigateProgram
[F] navigateType
[F] navigateTypesInNamespace
[F] normalizePath
[F] normalizeSlashes
[F] paramMessage
[F] reducePathComponents
[F] removeTrailingDirectorySeparator
[F] removeVisibilityModifiers
[F] reportDeprecated
[F] resetVisibilityModifiersForClass
[F] resolveCompilerOptions
[F] resolveEncodedName
[F] resolveLinterDefinition
[F] resolveModule
[F] resolvePath
[F] resolveUsages
[F] scopeNavigationToNamespace
[F] sealVisibilityModifiers
[F] sealVisibilityModifiersForProgram
[F] serializeValueAsJson
[F] setTypeSpecNamespace
[F] typespecTypeToJson
[F] validateDecoratorNotOnType
[F] validateDecoratorUniqueOnNode
[F] walkPropertiesInherited
[P] JS API
Interfaces
[I] ArrayModelType
[I] ArrayValue
[I] BaseType
[I] BlockComment
[I] BooleanLiteral
[I] BooleanValue
[I] CallableMessage
[I] Checker
[I] CodeFix
[I] CodeFixContext
[I] CompileResult
[I] CompilerHost
[I] CompilerLocationContext
[I] CompilerOptions
[I] DecoratedType
[I] Decorator
[I] DecoratorApplication
[I] DecoratorArgument
[I] DecoratorContext
[I] DecoratorDefinition
[I] DecoratorFunction
[I] DecoratorImplementations
[I] DecoratorParamDefinition
[I] DecoratorValidator
[I] DeprecatedDirective
[I] DeprecationDetails
[I] Diagnostic
[I] DiagnosticCollector
[I] DiagnosticCreator
[I] DiagnosticDefinition
[I] DiagnosticMessages
[I] DirectiveBase
[I] DiscriminatedUnion
[I] DiscriminatedUnionLegacy
[I] Discriminator
[I] EmitContext
[I] EmitFileOptions
[I] EncodeData
[I] Enum
[I] EnumMember
[I] EnumValue
[I] ErrorType
[I] Example
[I] ExampleOptions
[I] FileLibraryMetadata
[I] FilePos
[I] FunctionParameterBase
[I] IdentifierContext
[I] IndeterminateEntity
[I] InitProjectContext
[I] InsertTextCodeFixEdit
[I] Interface
[I] IntrinsicType
[I] LibraryInstance
[I] LibraryLocationContext
[I] LineAndCharacter
[I] LineComment
[I] LinterDefinition
[I] LinterResolvedDefinition
[I] LinterRule
[I] LinterRuleContext
[I] LinterRuleDefinition
[I] LinterRuleSet
[I] ListOperationOptions
[I] LogInfo
[I] LogSink
[I] Logger
[I] MixedFunctionParameter
[I] MixedParameterConstraint
[I] Model
[I] ModelProperty
[I] ModuleLibraryMetadata
[I] Namespace
[I] NamespaceNavigationOptions
[I] NavigationOptions
[I] NeverType
[I] NullType
[I] NullValue
[I] Numeric
[I] NumericLiteral
[I] NumericValue
[I] ObjectValue
[I] ObjectValuePropertyDescriptor
[I] OpExample
[I] Operation
[I] PackageFlags
[I] PackageJson
[I] PagingOperation
[I] PagingProperty
[I] ParseOptions
[I] PatternData
[I] PositionDetail
[I] ProcessedLog
[I] Program
[I] ProjectLocationContext
[I] RecordModelType
[I] ReplaceTextCodeFixEdit
[I] ResolveCompilerOptionsOptions
[I] ResolveModuleHost
[I] ResolveModuleOptions
[I] RmOptions
[I] Scalar
[I] ScalarConstructor
[I] ScalarValue
[I] SemanticToken
[I] Server
[I] ServerCustomCapacities
[I] ServerHost
[I] ServerInitializeResult
[I] ServerLog
[I] ServerSourceFile
[I] ServerWorkspaceFolder
[I] Service
[I] ServiceDetails
[I] SignatureFunctionParameter
[I] SourceFile
[I] SourceLocation
[I] SourceLocationOptions
[I] SourceModel
[I] StateDef
[I] StringLiteral
[I] StringTemplate
[I] StringTemplateSpanLiteral
[I] StringTemplateSpanValue
[I] StringValue
[I] SuppressDirective
[I] SyntheticLocationContext
[I] TemplateInstanceTarget
[I] TemplateParameter
[I] TemplatedTypeBase
[I] TextRange
[I] Tracer
[I] TracerOptions
[I] Tuple
[I] TypeInstantiationMap
[I] TypeMapper
[I] TypeNameOptions
[I] TypeSpecLibrary
[I] TypeSpecLibraryDef
[I] TypeSpecManifest
[I] Union
[I] UnionVariant
[I] UnknownType
[I] UsageTracker
[I] VisibilityFilter
[I] VisibilityProvider
[I] VoidType
Type aliases
[T] BytesKnownEncoding
[T] CodeFixEdit
[T] Comment
[T] CreateTypeProps
[T] CustomRequestName
[T] DateTimeKnownEncoding
[T] Declaration
[T] DecoratorArgumentValue
[T] DiagnosticFormat
[T] DiagnosticHandler
[T] DiagnosticMap
[T] DiagnosticReport
[T] DiagnosticReportWithoutTarget
[T] DiagnosticResult
[T] DiagnosticSeverity
[T] DiagnosticTarget
[T] Directive
[T] DirectiveArgument
[T] DocContent
[T] DurationKnownEncoding
[T] EmitOptionsFor
[T] EmitterFunc
[T] Entity
[T] Expression
[T] FunctionParameter
[T] InferredTypeSpecValue
[T] InitProjectConfig
[T] InitProjectTemplate
[T] InitProjectTemplateEmitterTemplate
[T] InitProjectTemplateLibrarySpec
[T] IntrinsicScalarName
[T] JSONSchemaType
[T] LibraryMetadata
[T] LinterRuleDiagnosticFormat
[T] LinterRuleDiagnosticReport
[T] LinterRuleDiagnosticReportWithoutTarget
[T] LiteralType
[T] LocationContext
[T] LogLevel
[T] MarshalledValue
[T] MemberContainerType
[T] MemberType
[T] ModelIndexer
[T] Modifier
[T] ModuleResolutionResult
[T] NeverIndexer
[T] NewLine
[T] OperationContainer
[T] OperationSignature
[T] ReferenceExpression
[T] RuleRef
[T] SemanticNodeListener
[T] ServerLogLevel
[T] SourceFileKind
[T] Statement
[T] StdTypeName
[T] StdTypes
[T] StringTemplateSpan
[T] TemplatedType
[T] TrackableType
[T] Type
[T] TypeKind
[T] TypeListeners
[T] TypeOfDiagnostics
[T] TypeSpecDiagnosticTarget
[T] TypeSpecValue
[T] Value
[T] WriteLine
Variables
[V] $defaultVisibility
[V] $discriminator
[V] $doc
[V] $encode
[V] $error
[V] $errorsDoc
[V] $example
[V] $format
[V] $friendlyName
[V] $inspectType
[V] $inspectTypeName
[V] $invisible
[V] $key
[V] $maxItems
[V] $maxLength
[V] $maxValue
[V] $maxValueExclusive
[V] $minItems
[V] $minLength
[V] $minValue
[V] $minValueExclusive
[V] $opExample
[V] $overload
[V] $parameterVisibility
[V] $pattern
[V] $removeVisibility
[V] $returnTypeVisibility
[V] $returnsDoc
[V] $secret
[V] $service
[V] $summary
[V] $tag
[V] $visibility
[V] $withDefaultKeyVisibility
[V] $withLifecycleUpdate
[V] $withOptionalProperties
[V] $withPickedProperties
[V] $withUpdateableProperties
[V] $withVisibility
[V] $withVisibilityFilter
[V] $withoutDefaultValues
[V] $withoutOmittedProperties
[V] EmptyVisibilityProvider
[V] MANIFEST
[V] NoTarget
[V] NodeHost
[V] VisibilityFilter
[V] discriminatedDecorator
[V] getEncode
[V] getFormat
[V] getFriendlyName
[V] getKeyName
[V] getOverloadedOperation
[V] getOverloads
[V] getPatternData
[V] getService
[V] getSummary
[V] isList
[V] isSecret
Encoded names
Discriminated Types
Examples
Pagination
📚 Libraries
Http
Overview
Rules
op-reference-container-route
Data types
Decorators
Js api
Enumerations
[E] Visibility
Functions
[F] $useAuth
[F] HttpVisibilityProvider
[F] addQueryParamsToUriTemplate
[F] createMetadataInfo
[F] getAllHttpServices
[F] getAuthentication
[F] getAuthenticationForOperation
[F] getContentTypes
[F] getCookieParamOptions
[F] getHeaderFieldName
[F] getHeaderFieldOptions
[F] getHttpFileModel
[F] getHttpOperation
[F] getHttpPart
[F] getHttpService
[F] getOperationParameters
[F] getOperationVerb
[F] getPatchOptions
[F] getPathParamName
[F] getPathParamOptions
[F] getQueryParamName
[F] getQueryParamOptions
[F] getResponsesForOperation
[F] getRouteOptionsForNamespace
[F] getRoutePath
[F] getServers
[F] getStatusCodeDescription
[F] getStatusCodes
[F] getStatusCodesWithDiagnostics
[F] getUriTemplatePathParam
[F] getVisibilitySuffix
[F] isApplicableMetadata
[F] isApplicableMetadataOrBody
[F] isBody
[F] isBodyIgnore
[F] isBodyRoot
[F] isCookieParam
[F] isHeader
[F] isHttpFile
[F] isMetadata
[F] isMultipartBodyProperty
[F] isOrExtendsHttpFile
[F] isOverloadSameEndpoint
[F] isPathParam
[F] isQueryParam
[F] isSharedRoute
[F] isStatusCode
[F] isVisible
[F] joinPathSegments
[F] listHttpOperationsIn
[F] reportIfNoRoutes
[F] resolveAuthentication
[F] resolveRequestVisibility
[F] setAuthentication
[F] setRoute
[F] setSharedRoute
[P] JS API
Interfaces
[I] AnyHttpAuthRef
[I] ApiKeyAuth
[I] Authentication
[I] AuthenticationOption
[I] AuthenticationOptionReference
[I] AuthenticationReference
[I] AuthorizationCodeFlow
[I] BasicAuth
[I] BearerAuth
[I] ClientCredentialsFlow
[I] CookieParameterOptions
[I] HeaderFieldOptions
[I] HttpAuthBase
[I] HttpBody
[I] HttpOperation
[I] HttpOperationBody
[I] HttpOperationBodyBase
[I] HttpOperationFileBody
[I] HttpOperationParameters
[I] HttpOperationResponse
[I] HttpOperationResponseContent
[I] HttpPart
[I] HttpPartOptions
[I] HttpServer
[I] HttpService
[I] HttpServiceAuthentication
[I] HttpStatusCodeRange
[I] ImplicitFlow
[I] MetadataInfo
[I] MetadataInfoOptions
[I] NoAuth
[I] NoHttpAuthRef
[I] OAuth2HttpAuthRef
[I] OAuth2Scope
[I] Oauth2Auth
[I] OpenIDConnectAuth
[I] PasswordFlow
[I] PathParameterOptions
[I] QueryParameterOptions
[I] RoutePath
Type aliases
[T] HttpAuth
[T] HttpAuthRef
[T] HttpOperationCookieParameter
[T] HttpOperationHeaderParameter
[T] HttpOperationMultipartBody
[T] HttpOperationMultipartPartBody
[T] HttpOperationParameter
[T] HttpOperationPart
[T] HttpOperationPathParameter
[T] HttpOperationQueryParameter
[T] HttpPayloadBody
[T] HttpProperty
[T] HttpStatusCodes
[T] HttpStatusCodesEntry
[T] HttpVerb
[T] OAuth2Flow
[T] OAuth2FlowType
[T] OperationContainer
[T] OperationVerbSelector
Variables
[V] $body
[V] $bodyIgnore
[V] $bodyRoot
[V] $cookie
[V] $delete
[V] $get
[V] $head
[V] $header
[V] $lib
[V] $linter
[V] $multipartBody
[V] $patch
[V] $path
[V] $post
[V] $put
[V] $query
[V] $route
[V] $server
[V] $sharedRoute
[V] $statusCode
Linter usage
Cheat sheet
Authentication
Operations
Files
Content types
Multipart requests
Encoding of types
Examples
OpenAPI
Overview
Data types
Decorators
Js api
Functions
[F] checkDuplicateTypeName
[F] getExtensions
[F] getExternalDocs
[F] getInfo
[F] getOpenAPITypeName
[F] getOperationId
[F] getParameterKey
[F] isDefaultResponse
[F] isReadonlyProperty
[F] resolveInfo
[F] resolveOperationId
[F] setExtension
[F] setInfo
[F] shouldInline
[P] JS API
Interfaces
[I] AdditionalInfo
[I] Contact
[I] ExternalDocs
[I] License
Type aliases
[T] DefaultResponseDecorator
[T] ExtensionDecorator
[T] ExtensionKey
[T] ExternalDocsDecorator
[T] InfoDecorator
Variables
[V] $defaultResponse
[V] $extension
[V] $externalDocs
[V] $info
[V] $operationId
[V] getTagsMetadata
Rest
preview
Overview
Data types
Decorators
Interfaces and Operations
Js api
Functions
[F] $actionSeparator
[F] $copyResourceKeyParameters
[F] $createsOrReplacesResource
[F] $createsOrUpdatesResource
[F] $createsResource
[F] $deletesResource
[F] $resourceTypeForKeyParam
[F] $segment
[F] $updatesResource
[F] getAction
[F] getActionDetails
[F] getActionSegment
[F] getActionSeparator
[F] getCollectionAction
[F] getCollectionActionDetails
[F] getParentResource
[F] getResourceLocationType
[F] getResourceOperation
[F] getResourceTypeForKeyParam
[F] getResourceTypeKey
[F] getSegment
[F] isAutoRoute
[F] isListOperation
[F] setResourceOperation
[F] setResourceTypeKey
[P] JS API
Interfaces
[I] ActionDetails
[I] AutoRouteOptions
[I] FilteredRouteParam
[I] ResourceKey
[I] ResourceOperation
Type aliases
[T] ResourceOperations
Variables
[V] $action
[V] $actionSegment
[V] $autoRoute
[V] $collectionAction
[V] $lib
[V] $listsResource
[V] $parentResource
[V] $readsResource
[V] $resource
[V] $resourceLocation
[V] $segmentOf
Cheat sheet
Resource and routes
Events
preview
Overview
Decorators
Js api
Functions
[F] $onValidate
[P] JS API
Variables
[V] $decorators
[V] $lib
[V] getContentType
[V] isEventData
[V] isEvents
SSE
preview
Overview
Data types
Decorators
Js api
Functions
[F] $onValidate
[P] JS API
Variables
[V] $decorators
[V] $lib
[V] isTerminalEvent
Streams
preview
Overview
Data types
Decorators
Js api
Functions
[F] isStream
[P] JS API
Variables
[V] $decorators
[V] $lib
[V] getStreamOf
Versioning
preview
Overview
Decorators
Js api
Classes
[C] VersionMap
Enumerations
[E] Availability
Functions
[F] $onValidate
[F] $removed
[F] $useDependency
[F] createVersionMutator
[F] findVersionedNamespace
[F] getAddedOnVersions
[F] getAllVersions
[F] getAvailabilityMap
[F] getAvailabilityMapInTimeline
[F] getMadeOptionalOn
[F] getRemovedOnVersions
[F] getRenamedFrom
[F] getRenamedFromVersions
[F] getReturnTypeChangedFrom
[F] getTypeChangedFrom
[F] getUseDependencies
[F] getVersion
[F] getVersionDependencies
[F] getVersionForEnumMember
[F] getVersioningMutators
[F] getVersions
[F] getVersionsForEnum
[F] resolveVersions
[P] JS API
Interfaces
[I] TransientVersioningMutator
[I] Version
[I] VersionResolution
[I] VersionSnapshotMutation
[I] VersionedMutators
Variables
[V] $added
[V] $madeOptional
[V] $madeRequired
[V] $renamedFrom
[V] $returnTypeChangedFrom
[V] $typeChangedFrom
[V] $versioned
Tutorial
Xml
preview
Overview
Decorators
Js api
Functions
[F] getNs
[F] getXmlEncoding
[F] isAttribute
[F] isUnwrapped
[P] JS API
Interfaces
[I] XmlEncodeData
[I] XmlNamespace
Type aliases
[T] AttributeDecorator
[T] NameDecorator
[T] NsDeclarationsDecorator
[T] NsDecorator
[T] UnwrappedDecorator
[T] XmlEncoding
Variables
[V] $attribute
[V] $lib
[V] $name
[V] $ns
[V] $nsDeclarations
[V] $unwrapped
Guide
🖨️ Emitters
JSON Schema
Overview
Data types
Decorators
Emitter usage
Js api
Functions
[F] $onEmit
[F] findBaseUri
[F] getExtensions
[F] getJsonSchemaTypes
[F] getMultipleOf
[F] isJsonSchemaDeclaration
[F] setExtension
[P] JS API
Interfaces
[I] ExtensionRecord
[I] JSONSchemaEmitterOptions
Type aliases
[T] BaseUriDecorator
[T] ContainsDecorator
[T] ContentEncodingDecorator
[T] ContentMediaTypeDecorator
[T] ContentSchemaDecorator
[T] ExtensionDecorator
[T] IdDecorator
[T] JsonSchemaDeclaration
[T] JsonSchemaDecorator
[T] MaxContainsDecorator
[T] MaxPropertiesDecorator
[T] MinContainsDecorator
[T] MinPropertiesDecorator
[T] MultipleOfDecorator
[T] OneOfDecorator
[T] PrefixItemsDecorator
[T] UniqueItemsDecorator
Variables
[V] $baseUri
[V] $contains
[V] $contentEncoding
[V] $contentMediaType
[V] $contentSchema
[V] $extension
[V] $flags
[V] $id
[V] $jsonSchema
[V] $lib
[V] $maxContains
[V] $maxProperties
[V] $minContains
[V] $minProperties
[V] $multipleOf
[V] $oneOf
[V] $prefixItems
[V] $uniqueItems
[V] EmitterOptionsSchema
[V] getBaseUri
[V] getContains
[V] getContentEncoding
[V] getContentMediaType
[V] getContentSchema
[V] getId
[V] getJsonSchema
[V] getMaxContains
[V] getMaxProperties
[V] getMinContains
[V] getMinProperties
[V] getMultipleOfAsNumeric
[V] getPrefixItems
[V] getUniqueItems
[V] isOneOf
OpenAPI3
Overview
Data types
Decorators
Emitter usage
Js api
Functions
[F] $onEmit
[F] convertOpenAPI3Document
[F] getOneOf
[F] getOpenAPI3
[F] getRef
[F] resolveOptions
[P] JS API
Interfaces
[I] OpenAPI3ApiKeySecurityScheme
[I] OpenAPI3AuthorizationCodeOAuthFlow
[I] OpenAPI3ClientCredentialsFlow
[I] OpenAPI3Components
[I] OpenAPI3Discriminator
[I] OpenAPI3Document
[I] OpenAPI3Example
[I] OpenAPI3ExternalDocs
[I] OpenAPI3HttpSecurityScheme
[I] OpenAPI3ImplicitOAuthFlow
[I] OpenAPI3Info
[I] OpenAPI3OAuth2Flow
[I] OpenAPI3OAuth2SecurityScheme
[I] OpenAPI3OAuthFlows
[I] OpenAPI3OpenIdConnectSecurityScheme
[I] OpenAPI3PasswordOAuthFlow
[I] OpenAPI3SecuritySchemeBase
[I] OpenAPI3Server
[I] OpenAPI3ServerVariable
[I] OpenAPI3Tag
[I] OpenAPI3UnversionedServiceRecord
[I] OpenAPI3VersionedDocumentRecord
[I] OpenAPI3VersionedServiceRecord
[I] OpenAPIComponents3_1
[I] OpenAPIDocument3_1
[I] Ref
[I] ResolvedOpenAPI3EmitterOptions
Type aliases
[T] CommonOpenAPI3Schema
[T] Extensions
[T] HttpMethod
[T] JsonSchema
[T] JsonSchemaType
[T] JsonType
[T] OpenAPI3Encoding
[T] OpenAPI3Header
[T] OpenAPI3HeaderParameter
[T] OpenAPI3Link
[T] OpenAPI3MediaType
[T] OpenAPI3Operation
[T] OpenAPI3Parameter
[T] OpenAPI3ParameterBase
[T] OpenAPI3ParameterType
[T] OpenAPI3PathItem
[T] OpenAPI3PathParameter
[T] OpenAPI3QueryParameter
[T] OpenAPI3RequestBody
[T] OpenAPI3Response
[T] OpenAPI3Responses
[T] OpenAPI3Schema
[T] OpenAPI3SchemaProperty
[T] OpenAPI3SecurityScheme
[T] OpenAPI3ServiceRecord
[T] OpenAPI3StatusCode
[T] OpenAPI3XmlSchema
[T] OpenAPISchema3_1
[T] Refable
[T] SupportedOpenAPIDocuments
Variables
[V] $lib
[V] $oneOf
[V] $useRef
[V] namespace
OpenAPI v3 emitter
OpenAPI3 to TypeSpec
Diagnostics
Protobuf
preview
Overview
Data types
Decorators
Emitter usage
Js api
Functions
[F] $onEmit
[F] $onValidate
[F] $service
[F] isMap
[P] JS API
Interfaces
[I] PackageDetails
Type aliases
[T] Reservation
Variables
[V] $externRef
[V] $field
[V] $lib
[V] $message
[V] $package
[V] $reserve
[V] $stream
[V] PROTO_FULL_IDENT
[V] namespace
Guide
Clients
Client Emitters
Javascript
preview
Overview
Emitter usage
Java
preview
Overview
Emitter usage
Python
preview
Overview
Emitter usage
Package Structure
CSharp
preview
Overview
Emitter usage
Servers
ASP.Net
alpha
Overview
Emitter usage
About Generated Projects
JavaScript
alpha
Overview
Emitter usage
About Generated Projects
🛠️ Writing TypeSpec Libraries
Creating a TypeSpec Library
Diagnostics
Decorators
Linters
Code fixes
Emitters
Emitter framework
Managing metadata and visibility in REST API emitters
Scaffolding templates
🚀 Release Notes
1.0.0-rc.1
1.0.0-rc.0
0.67
0.66 - March 2025
0.65 - February 2025
0.64 - January 2025
0.63 - December 2024
0.62 - November 2024
0.61 - October 2024
0.60 - September 2024
0.59 - August 2024
0.58 - July 2024
0.57 - June 2024
0.56 - May 2024
0.55 - April 2024
March 2024
February 2024
January 2024
December 2023
November 2023
October 2023
September 2023
August 2023
July 2023
June 2023
May 2023
April 2023
March 2023
February 2023
January 2023
December 2022
October 2022
September 2022
August 2022
July 2022
Cadl to TypeSpec rename completed in March 2023 release
Select theme
Dark
Light
Auto
[F] getHeaderFieldName
function
getHeaderFieldName
(
program
,
entity
)
:
string
;
Parameters
Parameter
Type
program
Program
entity
Type
Returns
string