Add docs for JSON Schema (#2120)

microsoft · Jun 27, 2023 · 411700a · 411700a
1 parent 0c923b8
commit 411700a
Show file tree

Hide file tree

Showing 10 changed files with 482 additions and 13 deletions.
diff --git a/common/changes/@typespec/json-schema/json-schema-docs_2023-06-24-10-36.json b/common/changes/@typespec/json-schema/json-schema-docs_2023-06-24-10-36.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@typespec/json-schema",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@typespec/json-schema"
+}
diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml
diff --git a/docs/standard-library/json-schema/reference/data-types.md b/docs/standard-library/json-schema/reference/data-types.md
@@ -0,0 +1,32 @@
+---
+title: "Data types"
+toc_min_heading_level: 2
+toc_max_heading_level: 3
+---
+
+# Data types
+
+## TypeSpec.JsonSchema
+
+### `Json` {#TypeSpec.JsonSchema.Json}
+
+Specify that the provided template argument should be emitted as raw JSON or YAML
+as opposed to a schema. Use in combination with the
+
+```typespec
+model TypeSpec.JsonSchema.Json<T>
+```
+
+#### Template Parameters
+
+| Name | Description                     |
+| ---- | ------------------------------- |
+| T    | the type to convert to raw JSON |
+
+### `Format` {#TypeSpec.JsonSchema.Format}
+
+Well-known JSON Schema formats.
+
+```typespec
+enum TypeSpec.JsonSchema.Format
+```