Skip to content

Use cases

OpenAPI
Data Validation
Tooling support

Docs Playground Blog Community

Version 0.62 is now available!

Getting started
- Installation
- Editor
  - TypeSpec VSCode extension
  - TypeSpec Visual Studio Extension
Guides
- TypeSpec for REST
- TypeSpec For OpenAPI Developer
Handbook
- Cli usage
- Style guide
- Formatter
- Reproducibility
- Configuration
  - Configuration
  - Tracing
- Releases
- FAQ
📐 Language Basics
📘 Standard Library
📚 Libraries
🖨️ Emitters
- JSON Schema
- OpenAPI3
  - Overview
  - Data types
  - Decorators
  - Emitter usage
  - Js api
    
    Functions
    
    [F] $onEmit
    [F] $oneOf
    [F] $useRef
    [F] convertOpenAPI3Document
    [F] getOneOf
    [F] getOpenAPI3
    [F] getRef
    [F] resolveOptions
    
    [P] JS API
    
    Interfaces
    
    [I] ResolvedOpenAPI3EmitterOptions
    
    Variables
    
    [V] $lib
    [V] namespace
  - Emitter operation
  - OpenAPI3 to TypeSpec
  - Diagnostics
- Protobuf
  - Overview
  - Data types
  - Decorators
  - Emitter usage
  - Js api
    
    Functions
    
    [F] $externRef
    [F] $field
    [F] $message
    [F] $onEmit
    [F] $onValidate
    [F] $package
    [F] $reserve
    [F] $service
    [F] $stream
    [F] isMap
    
    [P] JS API
    
    Interfaces
    
    [I] PackageDetails
    
    Type aliases
    
    [T] Reservation
    
    Variables
    
    [V] $lib
    [V] PROTO_FULL_IDENT
    [V] namespace
  - Guide
🛠️ Writing TypeSpec Libraries
🚀 Release Notes

Select theme

On this page

Overview
Parameters
Returns

On this page

Overview
Parameters
Returns

[F] $errorsDoc

function $errorsDoc(
   context,
   target,
   doc): void

Parameters

Parameter	Type
`context`	`DecoratorContext`
`target`	`Operation`
`doc`	`string`

Returns

void

Previous
[F] $error Next
[F] $example

TypeSpec

Follow us for latest updates, contributions, and more.

Microsoft

© 2024 Microsoft