API Specifications · Example Payload

Typespec Example

TypeSpecMicrosoftIDLSpecification Language

Typespec Example is an example object payload from API Specifications, with 17 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idnamealiasescategorycurrentVersionversionsgoverningBodylicenseformattransportsprimaryUseCasespecificationUrldocumentationUrlrepositoryUrltagsstatusemits

Example Payload

typespec-example.json Raw ↑ 
{
  "id": "typespec",
  "name": "TypeSpec",
  "aliases": ["Cadl"],
  "category": "Service Interface (IDL)",
  "currentVersion": "1.x",
  "versions": [
    { "version": "1.x", "status": "active", "url": "https://typespec.io/docs" }
  ],
  "governingBody": {
    "name": "Microsoft",
    "url": "https://typespec.io/",
    "governanceUrl": "https://github.com/microsoft/typespec/blob/main/GOVERNANCE.md"
  },
  "license": {
    "id": "MIT",
    "url": "https://opensource.org/license/mit"
  },
  "format": "DSL",
  "transports": ["HTTP/1.1", "HTTP/2", "gRPC", "Multiple"],
  "primaryUseCase": "Author high-level API definitions in a TypeScript-like DSL and emit OpenAPI, JSON Schema, Protobuf, and Azure SDK sources from a single source of truth.",
  "specificationUrl": "https://typespec.io/docs/language-basics/overview",
  "documentationUrl": "https://typespec.io/docs",
  "repositoryUrl": "https://github.com/microsoft/typespec",
  "tags": ["TypeSpec", "Microsoft", "IDL", "Specification Language"],
  "status": "active",
  "emits": ["OpenAPI 3.0", "OpenAPI 3.1", "JSON Schema", "Protobuf"]
}