diff --git a/.chronus/changes/refine_emitter_docs-2025-5-5-11-39-17.md b/.chronus/changes/refine_emitter_docs-2025-5-5-11-39-17.md new file mode 100644 index 00000000000..4498ac21986 --- /dev/null +++ b/.chronus/changes/refine_emitter_docs-2025-5-5-11-39-17.md @@ -0,0 +1,7 @@ +--- +changeKind: internal +packages: + - "@typespec/openapi3" +--- + +refine openai3 and protobuf emitter docs \ No newline at end of file diff --git a/packages/openapi3/README.md b/packages/openapi3/README.md index 3b34592204b..9b20e0e00c9 100644 --- a/packages/openapi3/README.md +++ b/packages/openapi3/README.md @@ -1,6 +1,6 @@ # @typespec/openapi3 -TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding and converting OpenAPI3 to TypeSpec +TypeSpec library for emitting OpenAPI 3.0 and OpenAPI 3.1 from the TypeSpec REST protocol binding and converting OpenAPI3 to TypeSpec ## Install diff --git a/packages/openapi3/package.json b/packages/openapi3/package.json index 2fcdd9b8713..dee8bfeda7a 100644 --- a/packages/openapi3/package.json +++ b/packages/openapi3/package.json @@ -2,7 +2,7 @@ "name": "@typespec/openapi3", "version": "1.0.0", "author": "Microsoft Corporation", - "description": "TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding and converting OpenAPI3 to TypeSpec", + "description": "TypeSpec library for emitting OpenAPI 3.0 and OpenAPI 3.1 from the TypeSpec REST protocol binding and converting OpenAPI3 to TypeSpec", "homepage": "https://typespec.io", "readme": "https://github.com/microsoft/typespec/blob/main/README.md", "license": "MIT", diff --git a/website/src/content/docs/docs/emitters/openapi3/reference/index.mdx b/website/src/content/docs/docs/emitters/openapi3/reference/index.mdx index 641d9c50197..33b0a4153fe 100644 --- a/website/src/content/docs/docs/emitters/openapi3/reference/index.mdx +++ b/website/src/content/docs/docs/emitters/openapi3/reference/index.mdx @@ -7,7 +7,7 @@ toc_max_heading_level: 3 import { Tabs, TabItem } from '@astrojs/starlight/components'; -TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding and converting OpenAPI3 to TypeSpec +TypeSpec library for emitting OpenAPI 3.0 and OpenAPI 3.1 from the TypeSpec REST protocol binding and converting OpenAPI3 to TypeSpec ## Install diff --git a/website/src/content/docs/docs/emitters/protobuf/guide.md b/website/src/content/docs/docs/emitters/protobuf/guide.md index d07488b5c88..7619db4efc1 100644 --- a/website/src/content/docs/docs/emitters/protobuf/guide.md +++ b/website/src/content/docs/docs/emitters/protobuf/guide.md @@ -2,7 +2,7 @@ title: Guide --- -TypeSpec includes a built-in emitter (`/protobuf`) that can generate Protocol Buffers specifications from TypeSpec sources. The Protobuf files generated can then be used to create gRPC services or any other tools that are compatible with Protocol Buffers. +TypeSpec includes a built-in emitter (`@typespec/protobuf`) that can generate Protocol Buffers specifications from TypeSpec sources. The Protobuf files generated can then be used to create gRPC services or any other tools that are compatible with Protocol Buffers. **Please note**: The Protobuf emitter is designed to work with Protocol Buffers 3 (proto3) syntax. Ensure that your workflow (including `protoc` version) supports proto3 to make full use of this emitter.