diff --git a/.chronus/changes/add-armprovideraction-templates-2024-9-1-11-12-44.md b/.chronus/changes/add-armprovideraction-templates-2024-9-1-11-12-44.md deleted file mode 100644 index 587ccf814c..0000000000 --- a/.chronus/changes/add-armprovideraction-templates-2024-9-1-11-12-44.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -Adding `ArmProviderActionSync` and `ArmProviderActionAsync` templates to the ARM library to perform actions at the subscription and tenant levels. diff --git a/.chronus/changes/allow-reserved-2024-8-11-16-40-29.md b/.chronus/changes/allow-reserved-2024-8-11-16-40-29.md deleted file mode 100644 index 5062d7dc94..0000000000 --- a/.chronus/changes/allow-reserved-2024-8-11-16-40-29.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -`x-ms-skip-url-encoding` should be replaced with `allowReserved` \ No newline at end of file diff --git a/.chronus/changes/almend-AddCommonTypes-2024-8-10-11-43-59.md b/.chronus/changes/almend-AddCommonTypes-2024-8-10-11-43-59.md deleted file mode 100644 index 22af5c103f..0000000000 --- a/.chronus/changes/almend-AddCommonTypes-2024-8-10-11-43-59.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -Added common-types managed identity with delegation and network security perimeter \ No newline at end of file diff --git a/.chronus/changes/almend-DefaultValueScalarObject-2024-8-16-12-2-59.md b/.chronus/changes/almend-DefaultValueScalarObject-2024-8-16-12-2-59.md deleted file mode 100644 index 2559a03be9..0000000000 --- a/.chronus/changes/almend-DefaultValueScalarObject-2024-8-16-12-2-59.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-autorest" ---- - -Added support to use Scalar and Object as default types \ No newline at end of file diff --git a/.chronus/changes/almend-Rule-2024-8-17-16-58-23.md b/.chronus/changes/almend-Rule-2024-8-17-16-58-23.md deleted file mode 100644 index 1cca1233b7..0000000000 --- a/.chronus/changes/almend-Rule-2024-8-17-16-58-23.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -Add `no-empty-model` rule diff --git a/.chronus/changes/almend-Rule-2024-8-18-10-2-28.md b/.chronus/changes/almend-Rule-2024-8-18-10-2-28.md deleted file mode 100644 index d2c3084304..0000000000 --- a/.chronus/changes/almend-Rule-2024-8-18-10-2-28.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-azure-rulesets" ---- - -Add `no-empty-model` rule to ruleset diff --git a/.chronus/changes/async-header-result-2024-7-22-23-19-8.md b/.chronus/changes/async-header-result-2024-7-22-23-19-8.md deleted file mode 100644 index 7d79d07522..0000000000 --- a/.chronus/changes/async-header-result-2024-7-22-23-19-8.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@azure-tools/typespec-azure-core" - - "@azure-tools/typespec-azure-resource-manager" ---- - -Fix #1180 Return StatusMonitor result field for non-resource PUT operations in getLroMetadata.finalResult diff --git a/.chronus/changes/azhang_NestedExamples-2024-8-27-21-2-20.md b/.chronus/changes/azhang_NestedExamples-2024-8-27-21-2-20.md deleted file mode 100644 index 177d43a7c9..0000000000 --- a/.chronus/changes/azhang_NestedExamples-2024-8-27-21-2-20.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-autorest" ---- - -Adding support for loading example files from nested sub-folders. \ No newline at end of file diff --git a/.chronus/changes/commonTypeManagedId-2024-8-17-8-36-58.md b/.chronus/changes/commonTypeManagedId-2024-8-17-8-36-58.md deleted file mode 100644 index 5db0d3bca9..0000000000 --- a/.chronus/changes/commonTypeManagedId-2024-8-17-8-36-58.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -Correct ManagedServiceIdentityType versioning issue \ No newline at end of file diff --git a/.chronus/changes/deprecate_description-2024-8-26-23-19-32.md b/.chronus/changes/deprecate_description-2024-8-26-23-19-32.md deleted file mode 100644 index 3234907db5..0000000000 --- a/.chronus/changes/deprecate_description-2024-8-26-23-19-32.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: deprecation -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -deprecate description in `SdkExampleBase` \ No newline at end of file diff --git a/.chronus/changes/fix-multipart-diagnostics-2024-8-13-13-31-25.md b/.chronus/changes/fix-multipart-diagnostics-2024-8-13-13-31-25.md deleted file mode 100644 index 555966ea96..0000000000 --- a/.chronus/changes/fix-multipart-diagnostics-2024-8-13-13-31-25.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -Fix logic to check conflicting usage for model of multipart body and regular body \ No newline at end of file diff --git a/.chronus/changes/fix-standalone-init-templates-2024-9-3-15-53-19.md b/.chronus/changes/fix-standalone-init-templates-2024-9-3-15-53-19.md deleted file mode 100644 index 28ab7680b9..0000000000 --- a/.chronus/changes/fix-standalone-init-templates-2024-9-3-15-53-19.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -Fix azure standalone init templates and add integration tests diff --git a/.chronus/changes/fix-x-ms-identifier-inheritance-2024-8-13-21-41-26.md b/.chronus/changes/fix-x-ms-identifier-inheritance-2024-8-13-21-41-26.md deleted file mode 100644 index 9e37ed0779..0000000000 --- a/.chronus/changes/fix-x-ms-identifier-inheritance-2024-8-13-21-41-26.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -Fix missing-x-ms-identifier rule not checking base class for properties diff --git a/.chronus/changes/fix_api_version-2024-8-29-18-33-51.md b/.chronus/changes/fix_api_version-2024-8-29-18-33-51.md deleted file mode 100644 index 31810d1990..0000000000 --- a/.chronus/changes/fix_api_version-2024-8-29-18-33-51.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -do not promote api version param to client if service is not versioned \ No newline at end of file diff --git a/.chronus/changes/fix_default_value-2024-8-30-14-40-21.md b/.chronus/changes/fix_default_value-2024-8-30-14-40-21.md deleted file mode 100644 index cc9a785485..0000000000 --- a/.chronus/changes/fix_default_value-2024-8-30-14-40-21.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -do not override client default value for api version param in non-versioning service \ No newline at end of file diff --git a/.chronus/changes/fix_enum_default_value-2024-8-30-17-30-54.md b/.chronus/changes/fix_enum_default_value-2024-8-30-17-30-54.md deleted file mode 100644 index 725dd9feb5..0000000000 --- a/.chronus/changes/fix_enum_default_value-2024-8-30-17-30-54.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -support value type for client default value \ No newline at end of file diff --git a/.chronus/changes/fix_subclient_endpoint-2024-8-25-18-46-26.md b/.chronus/changes/fix_subclient_endpoint-2024-8-25-18-46-26.md deleted file mode 100644 index 9afabb723a..0000000000 --- a/.chronus/changes/fix_subclient_endpoint-2024-8-25-18-46-26.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -set service of og in using time instead of setting time \ No newline at end of file diff --git a/.chronus/changes/remove_deprecated_description_details-2024-8-18-12-0-24.md b/.chronus/changes/remove_deprecated_description_details-2024-8-18-12-0-24.md deleted file mode 100644 index 7a5b70ad36..0000000000 --- a/.chronus/changes/remove_deprecated_description_details-2024-8-18-12-0-24.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: breaking -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -Remove `.description` and `.details` from deprecated api surface diff --git a/.chronus/changes/tcgc-lro-metadata-2024-8-11-22-30-34.md b/.chronus/changes/tcgc-lro-metadata-2024-8-11-22-30-34.md deleted file mode 100644 index 05b7878263..0000000000 --- a/.chronus/changes/tcgc-lro-metadata-2024-8-11-22-30-34.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -add `SdkLroServiceMetadata` \ No newline at end of file diff --git a/.chronus/changes/update-core-854024a-2024-9-9-9-46-21.md b/.chronus/changes/update-core-854024a-2024-9-9-9-46-21.md deleted file mode 100644 index 6e22373ace..0000000000 --- a/.chronus/changes/update-core-854024a-2024-9-9-9-46-21.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: internal -packages: - - "@azure-tools/typespec-autorest" - - "@azure-tools/typespec-client-generator-core" ---- - diff --git a/.chronus/changes/upgrade-deps-sep-2024-2-2024-8-25-13-11-27.md b/.chronus/changes/upgrade-deps-sep-2024-2-2024-8-25-13-11-27.md deleted file mode 100644 index 9ddf9f76cd..0000000000 --- a/.chronus/changes/upgrade-deps-sep-2024-2-2024-8-25-13-11-27.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -changeKind: internal -packages: - - "@azure-tools/typespec-autorest-canonical" - - "@azure-tools/typespec-autorest" - - "@azure-tools/typespec-azure-core" - - "@azure-tools/typespec-azure-portal-core" - - "@azure-tools/typespec-azure-resource-manager" - - "@azure-tools/typespec-azure-rulesets" - - "@azure-tools/typespec-client-generator-core" ---- - diff --git a/.chronus/changes/upgrade-deps-sep-2024-2024-8-13-1-4-48.md b/.chronus/changes/upgrade-deps-sep-2024-2024-8-13-1-4-48.md deleted file mode 100644 index fac80248e3..0000000000 --- a/.chronus/changes/upgrade-deps-sep-2024-2024-8-13-1-4-48.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: dependencies -packages: - - "@azure-tools/typespec-autorest-canonical" - - "@azure-tools/typespec-autorest" - - "@azure-tools/typespec-azure-core" - - "@azure-tools/typespec-azure-portal-core" - - "@azure-tools/typespec-azure-resource-manager" - - "@azure-tools/typespec-azure-rulesets" - - "@azure-tools/typespec-client-generator-core" ---- - -Bump dependencies diff --git a/core b/core index 57a7e11a86..29c0082df3 160000 --- a/core +++ b/core @@ -1 +1 @@ -Subproject commit 57a7e11a86858d05c615229beb62637bc91dcbdb +Subproject commit 29c0082df30abf50262dc8bfd304622453973a12 diff --git a/packages/typespec-autorest-canonical/CHANGELOG.md b/packages/typespec-autorest-canonical/CHANGELOG.md index eb25748b8d..5ecad5d4d4 100644 --- a/packages/typespec-autorest-canonical/CHANGELOG.md +++ b/packages/typespec-autorest-canonical/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog - @azure-tools/typespec-autorest-canonical +## 0.8.0 + +### Bump dependencies + +- [#1534](https://github.com/Azure/typespec-azure/pull/1534) Bump dependencies + + ## 0.7.0 No changes, version bump only. diff --git a/packages/typespec-autorest-canonical/package.json b/packages/typespec-autorest-canonical/package.json index c4ea23aa39..336d2ee109 100644 --- a/packages/typespec-autorest-canonical/package.json +++ b/packages/typespec-autorest-canonical/package.json @@ -1,6 +1,6 @@ { "name": "@azure-tools/typespec-autorest-canonical", - "version": "0.7.0", + "version": "0.8.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting canonical swagger", "homepage": "https://azure.github.io/typespec-azure", diff --git a/packages/typespec-autorest/CHANGELOG.md b/packages/typespec-autorest/CHANGELOG.md index 41eb3dca82..902854a393 100644 --- a/packages/typespec-autorest/CHANGELOG.md +++ b/packages/typespec-autorest/CHANGELOG.md @@ -1,5 +1,17 @@ # Change Log - @azure-tools/typespec-autorest +## 0.47.0 + +### Bump dependencies + +- [#1534](https://github.com/Azure/typespec-azure/pull/1534) Bump dependencies + +### Features + +- [#1547](https://github.com/Azure/typespec-azure/pull/1547) Added support to use Scalar and Object as default types +- [#1627](https://github.com/Azure/typespec-azure/pull/1627) Adding support for loading example files from nested sub-folders. + + ## 0.46.0 ### Bug Fixes diff --git a/packages/typespec-autorest/package.json b/packages/typespec-autorest/package.json index c0ba6f73bb..c516b3cb2a 100644 --- a/packages/typespec-autorest/package.json +++ b/packages/typespec-autorest/package.json @@ -1,6 +1,6 @@ { "name": "@azure-tools/typespec-autorest", - "version": "0.46.0", + "version": "0.47.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting openapi from the TypeSpec REST protocol binding", "homepage": "https://azure.github.io/typespec-azure", diff --git a/packages/typespec-azure-core/CHANGELOG.md b/packages/typespec-azure-core/CHANGELOG.md index 7ab5472803..afe56ad575 100644 --- a/packages/typespec-azure-core/CHANGELOG.md +++ b/packages/typespec-azure-core/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log - @azure-tools/typespec-azure-core +## 0.47.0 + +### Bug Fixes + +- [#1416](https://github.com/Azure/typespec-azure/pull/1416) Fix #1180 Return StatusMonitor result field for non-resource PUT operations in getLroMetadata.finalResult + +### Bump dependencies + +- [#1534](https://github.com/Azure/typespec-azure/pull/1534) Bump dependencies + + ## 0.46.0 ### Features diff --git a/packages/typespec-azure-core/package.json b/packages/typespec-azure-core/package.json index b8e0890e0e..5bf7415b3c 100644 --- a/packages/typespec-azure-core/package.json +++ b/packages/typespec-azure-core/package.json @@ -1,6 +1,6 @@ { "name": "@azure-tools/typespec-azure-core", - "version": "0.46.0", + "version": "0.47.0", "author": "Microsoft Corporation", "description": "TypeSpec Azure Core library", "homepage": "https://azure.github.io/typespec-azure", diff --git a/packages/typespec-azure-portal-core/CHANGELOG.md b/packages/typespec-azure-portal-core/CHANGELOG.md index 0ae1db24fb..18a0384be2 100644 --- a/packages/typespec-azure-portal-core/CHANGELOG.md +++ b/packages/typespec-azure-portal-core/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog - @azure-tools/typespec-azure-portal-core +## 0.47.0 + +### Bump dependencies + +- [#1534](https://github.com/Azure/typespec-azure/pull/1534) Bump dependencies + + ## 0.46.0 No changes, version bump only. diff --git a/packages/typespec-azure-portal-core/package.json b/packages/typespec-azure-portal-core/package.json index e1ed2a8f8a..e71343a9a8 100644 --- a/packages/typespec-azure-portal-core/package.json +++ b/packages/typespec-azure-portal-core/package.json @@ -1,6 +1,6 @@ { "name": "@azure-tools/typespec-azure-portal-core", - "version": "0.46.0", + "version": "0.47.0", "author": "Microsoft Corporation", "description": "TypeSpec Azure Portal Core library", "license": "MIT", diff --git a/packages/typespec-azure-resource-manager/CHANGELOG.md b/packages/typespec-azure-resource-manager/CHANGELOG.md index 6fa061f76f..9d8d248903 100644 --- a/packages/typespec-azure-resource-manager/CHANGELOG.md +++ b/packages/typespec-azure-resource-manager/CHANGELOG.md @@ -1,5 +1,25 @@ # Change Log - @azure-tools/typespec-azure-resource-manager +## 0.47.0 + +### Bug Fixes + +- [#1416](https://github.com/Azure/typespec-azure/pull/1416) Fix #1180 Return StatusMonitor result field for non-resource PUT operations in getLroMetadata.finalResult +- [#1551](https://github.com/Azure/typespec-azure/pull/1551) Correct ManagedServiceIdentityType versioning issue +- [#1537](https://github.com/Azure/typespec-azure/pull/1537) Fix missing-x-ms-identifier rule not checking base class for properties + +### Bump dependencies + +- [#1534](https://github.com/Azure/typespec-azure/pull/1534) Bump dependencies + +### Features + +- [#1639](https://github.com/Azure/typespec-azure/pull/1639) Adding `ArmProviderActionSync` and `ArmProviderActionAsync` templates to the ARM library to perform actions at the subscription and tenant levels. +- [#1512](https://github.com/Azure/typespec-azure/pull/1512) `x-ms-skip-url-encoding` should be replaced with `allowReserved` +- [#1505](https://github.com/Azure/typespec-azure/pull/1505) Added common-types managed identity with delegation and network security perimeter +- [#1555](https://github.com/Azure/typespec-azure/pull/1555) Add `no-empty-model` rule + + ## 0.46.1 ### Bug Fixes diff --git a/packages/typespec-azure-resource-manager/package.json b/packages/typespec-azure-resource-manager/package.json index d359d15ce1..c0c41f0a2c 100644 --- a/packages/typespec-azure-resource-manager/package.json +++ b/packages/typespec-azure-resource-manager/package.json @@ -1,6 +1,6 @@ { "name": "@azure-tools/typespec-azure-resource-manager", - "version": "0.46.1", + "version": "0.47.0", "author": "Microsoft Corporation", "description": "TypeSpec Azure Resource Manager library", "homepage": "https://azure.github.io/typespec-azure", diff --git a/packages/typespec-azure-rulesets/CHANGELOG.md b/packages/typespec-azure-rulesets/CHANGELOG.md index 3322d08953..ddf8cc4dcc 100644 --- a/packages/typespec-azure-rulesets/CHANGELOG.md +++ b/packages/typespec-azure-rulesets/CHANGELOG.md @@ -1,5 +1,16 @@ # Changelog - @azure-tools/typespec-azure-rulesets +## 0.47.0 + +### Bump dependencies + +- [#1534](https://github.com/Azure/typespec-azure/pull/1534) Bump dependencies + +### Features + +- [#1555](https://github.com/Azure/typespec-azure/pull/1555) Add `no-empty-model` rule to ruleset + + ## 0.46.0 ### Bug Fixes diff --git a/packages/typespec-azure-rulesets/package.json b/packages/typespec-azure-rulesets/package.json index 0d691f97f6..ad37983374 100644 --- a/packages/typespec-azure-rulesets/package.json +++ b/packages/typespec-azure-rulesets/package.json @@ -1,6 +1,6 @@ { "name": "@azure-tools/typespec-azure-rulesets", - "version": "0.46.0", + "version": "0.47.0", "author": "Microsoft Corporation", "description": "TypeSpec ruleset for Azure specs", "homepage": "https://azure.github.io/typespec-azure", diff --git a/packages/typespec-client-generator-core/CHANGELOG.md b/packages/typespec-client-generator-core/CHANGELOG.md index 83ac465c73..9eb727a2cb 100644 --- a/packages/typespec-client-generator-core/CHANGELOG.md +++ b/packages/typespec-client-generator-core/CHANGELOG.md @@ -1,5 +1,32 @@ # Change Log - @azure-tools/typespec-client-generator-core +## 0.47.0 + +### Bug Fixes + +- [#1511](https://github.com/Azure/typespec-azure/pull/1511) Fix logic to check conflicting usage for model of multipart body and regular body +- [#1629](https://github.com/Azure/typespec-azure/pull/1629) do not promote api version param to client if service is not versioned +- [#1630](https://github.com/Azure/typespec-azure/pull/1630) do not override client default value for api version param in non-versioning service +- [#1607](https://github.com/Azure/typespec-azure/pull/1607) set service of og in using time instead of setting time + +### Bump dependencies + +- [#1534](https://github.com/Azure/typespec-azure/pull/1534) Bump dependencies + +### Features + +- [#1631](https://github.com/Azure/typespec-azure/pull/1631) support value type for client default value +- [#1515](https://github.com/Azure/typespec-azure/pull/1515) add `SdkLroServiceMetadata` + +### Deprecations + +- [#1613](https://github.com/Azure/typespec-azure/pull/1613) deprecate description in `SdkExampleBase` + +### Breaking Changes + +- [#1560](https://github.com/Azure/typespec-azure/pull/1560) Remove `.description` and `.details` from deprecated api surface + + ## 0.46.2 ### Bug Fixes diff --git a/packages/typespec-client-generator-core/package.json b/packages/typespec-client-generator-core/package.json index 26bdb5d9fc..4d85e7184a 100644 --- a/packages/typespec-client-generator-core/package.json +++ b/packages/typespec-client-generator-core/package.json @@ -1,6 +1,6 @@ { "name": "@azure-tools/typespec-client-generator-core", - "version": "0.46.2", + "version": "0.47.0", "author": "Microsoft Corporation", "description": "TypeSpec Data Plane Generation library", "homepage": "https://azure.github.io/typespec-azure", diff --git a/packages/website/playground-versions.json b/packages/website/playground-versions.json index 2e71ab8eb5..80b8de2390 100644 --- a/packages/website/playground-versions.json +++ b/packages/website/playground-versions.json @@ -1,4 +1,5 @@ [ + "0.47.x", "0.46.x", "0.45.x", "0.44.x", diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2FileSchema.md b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2FileSchema.md index 73aff02a38..93e5ba154f 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2FileSchema.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2FileSchema.md @@ -11,12 +11,12 @@ type OpenAPI2FileSchema: object; | Name | Type | | ------ | ------ | -| `default` | `unknown` | -| `description` | `string` | -| `example` | `unknown` | -| `externalDocs` | [`OpenAPI2ExternalDocs`](../interfaces/OpenAPI2ExternalDocs.md) | -| `format` | `string` | -| `readonly` | `boolean` | -| `required` | `string`[] | -| `title` | `string` | +| `default`? | `unknown` | +| `description`? | `string` | +| `example`? | `unknown` | +| `externalDocs`? | [`OpenAPI2ExternalDocs`](../interfaces/OpenAPI2ExternalDocs.md) | +| `format`? | `string` | +| `readonly`? | `boolean` | +| `required`? | `string`[] | +| `title`? | `string` | | `type` | `"file"` | diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2Operation.md b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2Operation.md index edadcb0a1e..21d44d6729 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2Operation.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2Operation.md @@ -11,19 +11,19 @@ type OpenAPI2Operation: Extensions & object; | Name | Type | Description | | ------ | ------ | ------ | -| `consumes` | `string`[] | A list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types. | -| `deprecated` | `boolean` | Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false. | -| `description` | `string` | A verbose explanation of the operation behavior. Commonmark syntax can be used for rich text representation. | -| `externalDocs` | [`OpenAPI2ExternalDocs`](../interfaces/OpenAPI2ExternalDocs.md) | Additional external documentation. | -| `operationId` | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions. | +| `consumes`? | `string`[] | A list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types. | +| `deprecated`? | `boolean` | Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false. | +| `description`? | `string` | A verbose explanation of the operation behavior. Commonmark syntax can be used for rich text representation. | +| `externalDocs`? | [`OpenAPI2ExternalDocs`](../interfaces/OpenAPI2ExternalDocs.md) | Additional external documentation. | +| `operationId`? | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions. | | `parameters` | [`Refable`](Refable.md)<[`OpenAPI2Parameter`](OpenAPI2Parameter.md)\>[] | A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it, but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. | -| `produces` | `string`[] | A list of MIME types the operation can produce. This overrides the produces definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types. | -| `responses` | [`OpenAPI2Responses`](OpenAPI2Responses.md) | - | -| `schemes` | `string`[] | The transfer protocol for the operation. Values MUST be from the list: "http", "https", "ws", "wss". The value overrides the Swagger Object schemes definition. | -| `security` | [`OpenAPI2SecurityScheme`](OpenAPI2SecurityScheme.md)[] | declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used. | -| `summary` | `string` | A short summary of what the operation does. | -| `tags` | `string`[] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | -| `x-ms-examples` | `Record`<`string`, [`Ref`](../interfaces/Ref.md)<`unknown`\>\> | - | -| `x-ms-long-running-operation` | `boolean` | - | -| `x-ms-long-running-operation-options` | [`XMSLongRunningOperationOptions`](XMSLongRunningOperationOptions.md) | - | -| `x-ms-pageable` | [`XmsPageable`](XmsPageable.md) | - | +| `produces`? | `string`[] | A list of MIME types the operation can produce. This overrides the produces definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types. | +| `responses`? | [`OpenAPI2Responses`](OpenAPI2Responses.md) | - | +| `schemes`? | `string`[] | The transfer protocol for the operation. Values MUST be from the list: "http", "https", "ws", "wss". The value overrides the Swagger Object schemes definition. | +| `security`? | [`OpenAPI2SecurityScheme`](OpenAPI2SecurityScheme.md)[] | declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used. | +| `summary`? | `string` | A short summary of what the operation does. | +| `tags`? | `string`[] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | +| `x-ms-examples`? | `Record`<`string`, [`Ref`](../interfaces/Ref.md)<`unknown`\>\> | - | +| `x-ms-long-running-operation`? | `boolean` | - | +| `x-ms-long-running-operation-options`? | [`XMSLongRunningOperationOptions`](XMSLongRunningOperationOptions.md) | - | +| `x-ms-pageable`? | [`XmsPageable`](XmsPageable.md) | - | diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2PathItem.md b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2PathItem.md index 5fb1ef811e..b8e830e224 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2PathItem.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2PathItem.md @@ -13,7 +13,7 @@ Describes the operations available on a single path. A Path Item may be empty, d | Name | Type | | ------ | ------ | -| `parameters` | [`OpenAPI2Parameter`](OpenAPI2Parameter.md)[] | +| `parameters`? | [`OpenAPI2Parameter`](OpenAPI2Parameter.md)[] | ## See diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2Schema.md b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2Schema.md index 072c16c27e..c56e86ab78 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2Schema.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2Schema.md @@ -11,33 +11,33 @@ type OpenAPI2Schema: Extensions & object; | Name | Type | Description | | ------ | ------ | ------ | -| `additionalProperties` | `boolean` \| [`Refable`](Refable.md)<[`OpenAPI2Schema`](OpenAPI2Schema.md)\> | indicates that additional unlisted properties can exist in this schema | -| `allOf` | [`Refable`](Refable.md)<[`OpenAPI2Schema`](OpenAPI2Schema.md)\>[] | Swagger allows combining and extending model definitions using the allOf property of JSON Schema, in effect offering model composition. allOf takes in an array of object definitions that are validated independently but together compose a single object. While composition offers model extensibility, it does not imply a hierarchy between the models. To support polymorphism, Swagger adds the support of the discriminator field. When used, the discriminator will be the name of the property used to decide which schema definition is used to validate the structure of the model. As such, the discriminator field MUST be a required field. The value of the chosen property has to be the friendly name given to the model under the definitions property. As such, inline schema definitions, which do not have a given id, cannot be used in polymorphism. | -| `default` | `string` \| `boolean` \| `number` \| `Record`<`string`, `unknown`\> | Declares the value of the property that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. "default" has no meaning for required parameters.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined type for this parameter. | -| `description` | `string` | This attribute is a string that provides a full description of the schema | -| `discriminator` | `string` | Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the required property list. When used, the value MUST be the name of this schema or any schema that inherits it. | -| `enum` | (`string` \| `number` \| `boolean`)[] | Restrict a value to a fixed set of values. It must be an array with at least one element, where each element is unique. | -| `exclusiveMaximum` | `boolean` | indicates that the maximum is exclusive of the number given | -| `exclusiveMinimum` | `boolean` | indicates that the minimum is exclusive of the number given | -| `format` | `string` | The extending format for the previously mentioned type. | -| `items` | [`Refable`](Refable.md)<[`OpenAPI2Schema`](OpenAPI2Schema.md)\> | Describes the type of items in the array. | -| `maxItems` | `number` | An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. | -| `maxLength` | `number` | A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. | -| `maxProperties` | `number` | An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value of this keyword. | -| `maximum` | `number` | the maximum value for the property if "exclusiveMaximum" is not present, or has boolean value false, then the instance is valid if it is lower than, or equal to, the value of "maximum"; if "exclusiveMaximum" has boolean value true, the instance is valid if it is strictly lower than the value of "maximum". | -| `minItems` | `number` | An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. | -| `minLength` | `number` | A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. | -| `minProperties` | `number` | An object instance is valid against "minProperties" if its number of properties is greater than, or equal to, the value of this keyword. | -| `minimum` | `number` | the minimum value for the property if "exclusiveMinimum" is not present, or has boolean value false, then the instance is valid if it is greater than, or equal to, the value of "minimum"; if "exclusiveMinimum" has boolean value true, the instance is valid if it is strictly greater than the value of "minimum". | -| `pattern` | `string` | A string instance is considered valid if the regular expression matches the instance successfully. | -| `properties` | `Record`<`string`, [`OpenAPI2SchemaProperty`](OpenAPI2SchemaProperty.md)\> | This attribute is an object with property definitions that define the valid values of instance object property values. When the instance value is an object, the property values of the instance object MUST conform to the property definitions in this object. In this object, each property definition's value MUST be a schema, and the property's name MUST be the name of the instance property that it defines. The instance property value MUST be valid according to the schema from the property definition. Properties are considered unordered, the order of the instance properties MAY be in any order. | -| `readOnly` | `boolean` | Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but MUST NOT be sent as part of the request. Properties marked as readOnly being true SHOULD NOT be in the required list of the defined schema. Default value is false. | -| `required` | `string`[] | A list of property names that are required to be sent from the client to the server. | -| `title` | `string` | This attribute is a string that provides a short description of the schema. | -| `type` | [`JsonType`](JsonType.md) | The JSON type for the schema | -| `uniqueItems` | `boolean` | if this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the instance validates successfully if all of its elements are unique. | -| `x-ms-enum` | `object` | - | -| `x-ms-enum.modelAsString` | `boolean` | If the enum should be extensible. | -| `x-ms-enum.name` | `string` | Name of the enum. | -| `x-ms-enum.values` | `object`[] | Provide alternative name and description for enum values. | -| `x-ms-mutability` | `string`[] | - | +| `additionalProperties`? | `boolean` \| [`Refable`](Refable.md)<[`OpenAPI2Schema`](OpenAPI2Schema.md)\> | indicates that additional unlisted properties can exist in this schema | +| `allOf`? | [`Refable`](Refable.md)<[`OpenAPI2Schema`](OpenAPI2Schema.md)\>[] | Swagger allows combining and extending model definitions using the allOf property of JSON Schema, in effect offering model composition. allOf takes in an array of object definitions that are validated independently but together compose a single object. While composition offers model extensibility, it does not imply a hierarchy between the models. To support polymorphism, Swagger adds the support of the discriminator field. When used, the discriminator will be the name of the property used to decide which schema definition is used to validate the structure of the model. As such, the discriminator field MUST be a required field. The value of the chosen property has to be the friendly name given to the model under the definitions property. As such, inline schema definitions, which do not have a given id, cannot be used in polymorphism. | +| `default`? | `string` \| `boolean` \| `number` \| `Record`<`string`, `unknown`\> | Declares the value of the property that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. "default" has no meaning for required parameters.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined type for this parameter. | +| `description`? | `string` | This attribute is a string that provides a full description of the schema | +| `discriminator`? | `string` | Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the required property list. When used, the value MUST be the name of this schema or any schema that inherits it. | +| `enum`? | (`string` \| `number` \| `boolean`)[] | Restrict a value to a fixed set of values. It must be an array with at least one element, where each element is unique. | +| `exclusiveMaximum`? | `boolean` | indicates that the maximum is exclusive of the number given | +| `exclusiveMinimum`? | `boolean` | indicates that the minimum is exclusive of the number given | +| `format`? | `string` | The extending format for the previously mentioned type. | +| `items`? | [`Refable`](Refable.md)<[`OpenAPI2Schema`](OpenAPI2Schema.md)\> | Describes the type of items in the array. | +| `maximum`? | `number` | the maximum value for the property if "exclusiveMaximum" is not present, or has boolean value false, then the instance is valid if it is lower than, or equal to, the value of "maximum"; if "exclusiveMaximum" has boolean value true, the instance is valid if it is strictly lower than the value of "maximum". | +| `maxItems`? | `number` | An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. | +| `maxLength`? | `number` | A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. | +| `maxProperties`? | `number` | An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value of this keyword. | +| `minimum`? | `number` | the minimum value for the property if "exclusiveMinimum" is not present, or has boolean value false, then the instance is valid if it is greater than, or equal to, the value of "minimum"; if "exclusiveMinimum" has boolean value true, the instance is valid if it is strictly greater than the value of "minimum". | +| `minItems`? | `number` | An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. | +| `minLength`? | `number` | A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. | +| `minProperties`? | `number` | An object instance is valid against "minProperties" if its number of properties is greater than, or equal to, the value of this keyword. | +| `pattern`? | `string` | A string instance is considered valid if the regular expression matches the instance successfully. | +| `properties`? | `Record`<`string`, [`OpenAPI2SchemaProperty`](OpenAPI2SchemaProperty.md)\> | This attribute is an object with property definitions that define the valid values of instance object property values. When the instance value is an object, the property values of the instance object MUST conform to the property definitions in this object. In this object, each property definition's value MUST be a schema, and the property's name MUST be the name of the instance property that it defines. The instance property value MUST be valid according to the schema from the property definition. Properties are considered unordered, the order of the instance properties MAY be in any order. | +| `readOnly`? | `boolean` | Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but MUST NOT be sent as part of the request. Properties marked as readOnly being true SHOULD NOT be in the required list of the defined schema. Default value is false. | +| `required`? | `string`[] | A list of property names that are required to be sent from the client to the server. | +| `title`? | `string` | This attribute is a string that provides a short description of the schema. | +| `type`? | [`JsonType`](JsonType.md) | The JSON type for the schema | +| `uniqueItems`? | `boolean` | if this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the instance validates successfully if all of its elements are unique. | +| `x-ms-enum`? | `object` | - | +| `x-ms-enum.modelAsString`? | `boolean` | If the enum should be extensible. | +| `x-ms-enum.name`? | `string` | Name of the enum. | +| `x-ms-enum.values`? | `object`[] | Provide alternative name and description for enum values. | +| `x-ms-mutability`? | `string`[] | - | diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2SchemaRefProperty.md b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2SchemaRefProperty.md index 4ccd0fdfb6..cf0d591832 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2SchemaRefProperty.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/OpenAPI2SchemaRefProperty.md @@ -18,4 +18,4 @@ Autorest allows a few properties to be next to $ref of a property. | Name | Type | Description | | ------ | ------ | ------ | -| `x-ms-client-name` | `string` | Provide a different name to be used in the client. | +| `x-ms-client-name`? | `string` | Provide a different name to be used in the client. | diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/XMSLongRunningOperationOptions.md b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/XMSLongRunningOperationOptions.md index a3025206df..198dfdf523 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/XMSLongRunningOperationOptions.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/XMSLongRunningOperationOptions.md @@ -11,5 +11,5 @@ type XMSLongRunningOperationOptions: object; | Name | Type | | ------ | ------ | -| `final-state-schema` | `string` | +| `final-state-schema`? | `string` | | `final-state-via` | [`XMSLongRunningFinalState`](XMSLongRunningFinalState.md) | diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/XmsPageable.md b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/XmsPageable.md index f75969d50a..9e81c27f2b 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/XmsPageable.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/type-aliases/XmsPageable.md @@ -14,6 +14,6 @@ https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-pagea | Name | Type | Description | | ------ | ------ | ------ | -| `itemName` | `string` | Name of the property containing the page items. Default: "value" | +| `itemName`? | `string` | Name of the property containing the page items. Default: "value" | | `nextLinkName` | `string` | Name of the property containing url to the next link. | -| `operationName` | `string` | Specifies the name (operationId) of the operation for retrieving the next page. Default: "Next" | +| `operationName`? | `string` | Specifies the name (operationId) of the operation for retrieving the next page. Default: "Next" | diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/variables/$lib.md index 3f63592e5f..78d57cdc1f 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/variables/$lib.md @@ -25,8 +25,6 @@ const $lib: TypeSpecLibrary | - | | `inline-cycle` | `object` | - | | `inline-cycle.default` | `CallableMessage`<[`"type"`]\> | - | -| `invalid-default` | `object` | - | -| `invalid-default.default` | `CallableMessage`<[`"type"`]\> | - | | `invalid-format` | `object` | - | | `invalid-format.default` | `CallableMessage`<[`"schema"`, `"format"`]\> | - | | `invalid-multi-collection-format` | `object` | - | diff --git a/packages/website/versioned_docs/version-latest/howtos/Client Generation/07tcgcTypes.mdx b/packages/website/versioned_docs/version-latest/howtos/Client Generation/07tcgcTypes.mdx index d6957bde59..b1b9362377 100644 --- a/packages/website/versioned_docs/version-latest/howtos/Client Generation/07tcgcTypes.mdx +++ b/packages/website/versioned_docs/version-latest/howtos/Client Generation/07tcgcTypes.mdx @@ -911,8 +911,8 @@ export interface SdkHttpOperation { bodyParam: SdkBodyParameter; // mapping of status codes to SdkHttpResponse for valid responses // HttpStatusCodeRange can represent either a single status code or a range. - responses: Map; - exceptions: Map; + responses: SdkHttpResponse[]; + exceptions: SdkHttpResponse[]; examples?: SdkHttpOperationExample[]; } ``` @@ -1277,6 +1277,7 @@ interface HttpStatusCodeRange { export interface SdkHttpResponse { kind: "http"; + statusCodes: number | HttpStatusCodeRange | "*"; headers: SdkServiceResponseHeader[]; apiVersions: string[]; type?: SdkType; @@ -1305,8 +1306,8 @@ interface SdkTypeBase { ### SdkBuiltInType -These are the mappings from the built in scalar TypeSpec types. -We add `encode` onto these types, telling us how to encode when sending to the service. +A `SdkBuiltInType` represents a built-in scalar TypeSpec type or scalar type that derives from a built-in scalar TypeSpec type, but datetime and duration are not included. +We add `encode` onto these types if `@encode` decorator exists, telling us how to encode when sending to the service. There is a one-to-one mapping between the TypeSpec scalar kinds and the `SdkBuiltInKinds`. @@ -1315,13 +1316,17 @@ There is a one-to-one mapping between the TypeSpec scalar kinds and the `SdkBuil ```ts export interface SdkBuiltInType extends SdkTypeBase { kind: SdkBuiltInKinds; - encode: string; name: string; + encode?: string; baseType?: SdkBuiltInType; crossLanguageDefinitionId: string; } ``` +The `crossLanguageDefinitionId` represents the fully qualified name of this type in TypeSpec language for the emitter to distinguish from the built-in TypeSpec types. + +For a full list of types defined in `@azure-tools/typespec-azure-core` library, please refer to its reference doc. + ### SdkDateTimeType ```ts @@ -1430,11 +1435,20 @@ export interface SdkUnionType extends SdkTypeBase { // determines if the union name was generated or not isGeneratedName: boolean; kind: "union"; - values: SdkType[]; + variantTypes: SdkType[]; crossLanguageDefinitionId: string; } ``` +### SdkTupleType + +```ts +export interface SdkTupleType extends SdkTypeBase { + kind: "tuple"; + valueTypes: SdkType[]; +} +``` + ### SdkModelType ```ts @@ -1502,7 +1516,7 @@ These types are used to represent an example of a service operation. We currently only support HTTP calls to the service. -So, we have `SdkHttpoperationExample` bind to `SdkHttpOperation`, `SdkHttpParameterExample` bind to `SdkHttpParameter`, `SdkHttpResponseExample` bind to `SdkHttpResponse`, and `SdkHttpResponseHeaderExample` bind to `SdkHttpResponseHeader`. +So, we have `SdkHttpoperationExample` bind to `SdkHttpOperation`, `SdkHttpParameterExampleValue` bind to `SdkHttpParameter`, `SdkHttpResponseExampleValue` bind to `SdkHttpResponse`, and `SdkHttpResponseHeaderExampleValue` bind to `SdkHttpResponseHeader`. Each type will have the example value type and its cooresponding definition type. @@ -1517,53 +1531,54 @@ interface SdkExampleBase { export interface SdkHttpOperationExample extends SdkExampleBase { kind: "http"; - parameters: SdkHttpParameterExample[]; - responses: Map; + parameters: SdkHttpParameterExampleValue[]; + responses: SdkHttpResponseExampleValue[]; } -export interface SdkHttpParameterExample { +export interface SdkHttpParameterExampleValue { parameter: SdkHttpParameter; - value: SdkTypeExample; + value: SdkExampleValue; } -export interface SdkHttpResponseExample { +export interface SdkHttpResponseExampleValue { response: SdkHttpResponse; - headers: SdkHttpResponseHeaderExample[]; - bodyValue?: SdkTypeExample; + statusCode: number; + headers: SdkHttpResponseHeaderExampleValue[]; + bodyValue?: SdkExampleValue; } -export interface SdkHttpResponseHeaderExample { +export interface SdkHttpResponseHeaderExampleValue { header: SdkServiceResponseHeader; - value: SdkTypeExample; + value: SdkExampleValue; } ``` -### SdkExampleType +### SdkExampleValue These types are used to represent the example value of a type. One definition types will have different example value types. -For `SdkUnionExample`, since it is hard to determine whether the example value should belong to which union variant, we will keep the raw value and leave the work for the emitter. -For `SdkModelExample`, we will help to map the example type to the right subtype for the discriminated type, and we will separate the additional properties value from the property value. +For `SdkUnionExampleValue`, since it is hard to determine whether the example value should belong to which union variant, we will keep the raw value and leave the work for the emitter. +For `SdkModelExampleValue`, we will help to map the example type to the right subtype for the discriminated type, and we will separate the additional properties value from the property value. But for the model with inheritance, we will not break down the type graph, just put all the example value in the child model. ```ts -export type SdkTypeExample = - | SdkStringExample - | SdkNumberExample - | SdkBooleanExample - | SdkNullExample - | SdkAnyExample - | SdkArrayExample - | SdkDictionaryExample - | SdkUnionExample - | SdkModelExample; +export type SdkExampleValue = + | SdkStringExampleValue + | SdkNumberExampleValue + | SdkBooleanExampleValue + | SdkNullExampleValue + | SdkUnknownExampleValue + | SdkArrayExampleValue + | SdkDictionaryExampleValue + | SdkUnionExampleValue + | SdkModelExampleValue; -export interface SdkExampleTypeBase { +interface SdkExampleValueBase { kind: string; type: SdkType; value: unknown; } -export interface SdkStringExample extends SdkExampleTypeBase { +export interface SdkStringExampleValue extends SdkExampleTypeBase { kind: "string"; type: | SdkBuiltInType @@ -1575,7 +1590,7 @@ export interface SdkStringExample extends SdkExampleTypeBase { value: string; } -export interface SdkNumberExample extends SdkExampleTypeBase { +export interface SdkNumberExampleValue extends SdkExampleTypeBase { kind: "number"; type: | SdkBuiltInType @@ -1587,47 +1602,47 @@ export interface SdkNumberExample extends SdkExampleTypeBase { value: number; } -export interface SdkBooleanExample extends SdkExampleTypeBase { +export interface SdkBooleanExampleValue extends SdkExampleTypeBase { kind: "boolean"; type: SdkBuiltInType | SdkConstantType; value: boolean; } -export interface SdkNullExample extends SdkExampleTypeBase { +export interface SdkNullExampleValue extends SdkExampleTypeBase { kind: "null"; type: SdkNullableType; value: null; } -export interface SdkAnyExample extends SdkExampleTypeBase { - kind: "any"; +export interface SdkUnknownExampleValue extends SdkExampleTypeBase { + kind: "unknown"; type: SdkBuiltInType; value: unknown; } -export interface SdkArrayExample extends SdkExampleTypeBase { +export interface SdkArrayExampleValue extends SdkExampleTypeBase { kind: "array"; type: SdkArrayType; - value: SdkTypeExample[]; + value: SdkExampleValue[]; } -export interface SdkDictionaryExample extends SdkExampleTypeBase { +export interface SdkDictionaryExampleValue extends SdkExampleTypeBase { kind: "dict"; type: SdkDictionaryType; - value: Record; + value: Record; } -export interface SdkUnionExample extends SdkExampleTypeBase { +export interface SdkUnionExampleValue extends SdkExampleTypeBase { kind: "union"; type: SdkUnionType; value: unknown; } -export interface SdkModelExample extends SdkExampleTypeBase { +export interface SdkModelExampleValue extends SdkExampleTypeBase { kind: "model"; type: SdkModelType; - value: Record; - additionalPropertiesValue?: Record; + value: Record; + additionalPropertiesValue?: Record; } ``` @@ -1728,7 +1743,7 @@ function serializeServiceOperationExample( function serializeTypeExample( context: PythonSdkContext, - example: SdkTypeExample, + example: SdkExampleValue, ): PythonSdkTypeExample { switch (example.kind) { case "string": @@ -1751,7 +1766,7 @@ function serializeTypeExample( ...example, type: getPythonSdkType(context, example.type), }; - case "any": + case "unknown": return { ...example, type: getPythonSdkType(context, example.type), diff --git a/packages/website/versioned_docs/version-latest/howtos/Client Generation/12multipart.mdx b/packages/website/versioned_docs/version-latest/howtos/Client Generation/12multipart.mdx new file mode 100644 index 0000000000..ff4491ae37 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/howtos/Client Generation/12multipart.mdx @@ -0,0 +1,159 @@ +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Multipart + +This doc details what emitters will generate for multipart request. + +## Common multipart request + +When content-type of operation is "multipart/form-data", the body payload is multipart payload. + + + + +```typespec +model Address { + city: string; +} +model MultipartRequest { + id: string; + address: Address; + profileImage: bytes; + pictures: bytes[]; +} + +@post +op upload( + @header contentType: "multipart/form-data", + @body body: MultipartRequest, +): NoContentResponse; +``` + + + + + +```python +class MultipartRequest: + id: str = rest_field() + address: "Address" = rest_field() + profile_image: FileType = rest_field(name="profileImage", is_multipart_file_input=True) + pictures: List[FileType] = rest_field(is_multipart_file_input=True) + +def upload( + self, body: Union[_models.MultipartRequest, JSON], **kwargs: Any +) -> None: +``` + + + + + +```csharp + +``` + + + + + +```typescript + +``` + + + + + +```java +// Model class +@Immutable +public final class MultipartRequest { + public MultipartRequest(String id, Address address, ProfileImageFileDetails profileImage, List pictures); +} + +// Client API +public void upload(MultipartRequest body); +``` + + + + +## Multipart request with `@multipartBody` + +With `@multipartBody`, typespec author could define part of multipart request with more detailed info. +For example, typespec author could use `File` model predefined in `@typespec/http` to declare the requiredness of filename and +contentType. + + + + +```typespec +model Address { + city: string; +} +model MultipartRequest { + id: HttpPart; + address: HttpPart
; + profileImage: HttpPart; + previousAddresses: HttpPart; + pictures: HttpPart[]; +} + +@post +op upload( + @header contentType: "multipart/form-data", + @multipartBody body: MultipartRequest, +): NoContentResponse; +``` + + + + + +```python +class MultipartRequest: + id: str = rest_field() + address: "Address" = rest_field() + profile_image: FileType = rest_field(name="profileImage", is_multipart_file_input=True) + pictures: List[FileType] = rest_field(is_multipart_file_input=True) + +def upload( + self, body: Union[_models.MultipartRequest, JSON], **kwargs: Any +) -> None: +``` + + + + + +```csharp + +``` + + + + + +```typescript + +``` + + + + + +```java +// Model class +@Immutable +public final class MultipartRequest { + public MultipartRequest(String id, Address address, FileDetails profileImage, List
previousAddresses, List pictures); +} + +// Client API +public void upload(MultipartRequest body); +``` + + + diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/index.md index 3ed4267a63..1ba6ba808e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/index.md @@ -38,19 +38,19 @@ title: "[P] JS API" - [ArmResourceDeploymentScope](type-aliases/ArmResourceDeploymentScope.md) - [FinalOperationStep](type-aliases/FinalOperationStep.md) +- [nextOperationStep](type-aliases/nextOperationStep.md) - [OperationStep](type-aliases/OperationStep.md) - [PollingLocationInfo](type-aliases/PollingLocationInfo.md) - [TerminationStatus](type-aliases/TerminationStatus.md) - [UnionEnum](type-aliases/UnionEnum.md) -- [nextOperationStep](type-aliases/nextOperationStep.md) ## Variables - [$lib](variables/$lib.md) - [$linter](variables/$linter.md) - [FinalOperationKey](variables/FinalOperationKey.md) -- [PollingOperationKey](variables/PollingOperationKey.md) - [namespace](variables/namespace.md) +- [PollingOperationKey](variables/PollingOperationKey.md) - [preventRestLibraryInterfaces](variables/preventRestLibraryInterfaces.md) - [useStandardOperations](variables/useStandardOperations.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationLinkMetadata.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationLinkMetadata.md index 193f121c28..7982e667d0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationLinkMetadata.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationLinkMetadata.md @@ -8,8 +8,8 @@ title: "[I] OperationLinkMetadata" | Property | Type | | ------ | ------ | | `link?` | [`OperationLink`](OperationLink.md) | -| `linkType` | `string` | | `linkedOperation` | `Operation` | +| `linkType` | `string` | | `parameterMap?` | `Map`<`string`, `PropertyMap`\> | | `parameters?` | `Type` | | `result?` | `ResultInfo` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationReference.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationReference.md index d9e75797e2..8ead99e868 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationReference.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationReference.md @@ -12,6 +12,7 @@ original operation to the parameters of the linked operation | Property | Type | Description | | ------ | ------ | ------ | | `kind` | `"reference"` | - | +| `link?` | [`OperationLink`](OperationLink.md) | headers linking to the operation | | `operation` | `Operation` | The referenced operation | | `parameterMap?` | `Map`<`string`, [`ParameterSource`](ParameterSource.md)\> | information on how to construct the operation parameters from the original request and response | | `parameters?` | `Map`<`string`, `PropertyMap`\> | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/index.md index 8d145cd177..6bb92ca97f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/index.md @@ -16,8 +16,8 @@ title: "[P] JS API" ## Variables - [$lib](variables/$lib.md) -- [PortalCoreKeys](variables/PortalCoreKeys.md) - [namespace](variables/namespace.md) +- [PortalCoreKeys](variables/PortalCoreKeys.md) ## Functions diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/data-types.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/data-types.md index e1a1fbed2b..37575be2f4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/data-types.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/data-types.md @@ -842,6 +842,20 @@ model Azure.ResourceManager.ResourceUriParameter | ----------- | -------- | ---------------------------------------------------------------------- | | resourceUri | `string` | The fully qualified Azure Resource manager identifier of the resource. | +### `SubscriptionActionScope` {#Azure.ResourceManager.SubscriptionActionScope} + +Template used by ArmProviderAction templates. + +```typespec +model Azure.ResourceManager.SubscriptionActionScope +``` + +#### Properties + +| Name | Type | Description | +| ---- | -------- | ---------------------- | +| name | `string` | Symbolic name of scope | + ### `SubscriptionLocationResource` {#Azure.ResourceManager.SubscriptionLocationResource} The location resource for subscription-based locations. This can be used as a parent @@ -857,6 +871,20 @@ model Azure.ResourceManager.SubscriptionLocationResource | -------- | -------------------- | ----------------------------- | | location | `Core.azureLocation` | The name of the Azure region. | +### `TenantActionScope` {#Azure.ResourceManager.TenantActionScope} + +Template used by ArmTenantAction templates. + +```typespec +model Azure.ResourceManager.TenantActionScope +``` + +#### Properties + +| Name | Type | Description | +| ---- | -------- | ---------------------- | +| name | `string` | Symbolic name of scope | + ### `TenantLocationResource` {#Azure.ResourceManager.TenantLocationResource} The location resource for tenant-based locations. This can be used as a parent @@ -930,6 +958,41 @@ union FooProvisioningState { ## Azure.ResourceManager.CommonTypes +### `AccessRule` {#Azure.ResourceManager.CommonTypes.AccessRule} + +Access rule in a network security perimeter configuration profile + +```typespec +model Azure.ResourceManager.CommonTypes.AccessRule +``` + +#### Properties + +| Name | Type | Description | +| ----------- | ------------------------------------------------------------------------------------------------ | ----------------------- | +| name? | `string` | Name of the access rule | +| properties? | [`AccessRuleProperties`](./data-types.md#Azure.ResourceManager.CommonTypes.AccessRuleProperties) | | + +### `AccessRuleProperties` {#Azure.ResourceManager.CommonTypes.AccessRuleProperties} + +Properties of Access Rule + +```typespec +model Azure.ResourceManager.CommonTypes.AccessRuleProperties +``` + +#### Properties + +| Name | Type | Description | +| -------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------ | +| direction? | [`AccessRuleDirection`](./data-types.md#Azure.ResourceManager.CommonTypes.AccessRuleDirection) | | +| addressPrefixes? | `string[]` | Address prefixes in the CIDR format for inbound rules | +| subscriptions? | `ResourceManager.CommonTypes.{ id: Core.armResourceIdentifier }[]` | Subscriptions for inbound rules | +| networkSecurityPerimeters? | `ResourceManager.CommonTypes.NetworkSecurityPerimeter[]` | Network security perimeters for inbound rules | +| fullyQualifiedDomainNames? | `string[]` | Fully qualified domain names (FQDN) for outbound rules | +| emailAddresses? | `string[]` | Email addresses for outbound rules | +| phoneNumbers? | `string[]` | Phone numbers for outbound rules | + ### `ApiVersionParameter` {#Azure.ResourceManager.CommonTypes.ApiVersionParameter} The default api-version parameter type. @@ -1004,6 +1067,37 @@ model Azure.ResourceManager.CommonTypes.CustomerManagedKeyEncryption | keyEncryptionKeyIdentity? | [`KeyEncryptionKeyIdentity`](./data-types.md#Azure.ResourceManager.CommonTypes.KeyEncryptionKeyIdentity) | All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. | | keyEncryptionKeyUrl? | `string` | key encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. | +### `DelegatedResource` {#Azure.ResourceManager.CommonTypes.DelegatedResource} + +Delegated resource properties - internal use only. + +```typespec +model Azure.ResourceManager.CommonTypes.DelegatedResource +``` + +#### Properties + +| Name | Type | Description | +| ----------------- | ----------- | ---------------------------------------------------------------------------- | +| resourceId? | `string` | The ARM resource id of the delegated resource - internal use only. | +| tenantId? | `Core.uuid` | The tenant id of the delegated resource - internal use only. | +| referralResource? | `string` | The delegation id of the referral delegation (optional) - internal use only. | +| location? | `string` | The source resource location - internal use only. | + +### `DelegatedResources` {#Azure.ResourceManager.CommonTypes.DelegatedResources} + +The set of delegated resources. The delegated resources dictionary keys will be source resource internal ids - internal use only. + +```typespec +model Azure.ResourceManager.CommonTypes.DelegatedResources +``` + +#### Properties + +| Name | Type | Description | +| ---- | ------------------------------------------------------------------------------------------ | --------------------- | +| | [`DelegatedResource`](./data-types.md#Azure.ResourceManager.CommonTypes.DelegatedResource) | Additional properties | + ### `Encryption` {#Azure.ResourceManager.CommonTypes.Encryption} (Optional) Discouraged to include in resource definition. Only needed where it is possible to disable platform (AKA infrastructure) encryption. Azure SQL TDE is an example of this. Values are enabled and disabled. @@ -1258,6 +1352,20 @@ model Azure.ResourceManager.CommonTypes.ManagedServiceIdentity | type | [`ManagedServiceIdentityType`](./data-types.md#Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType) | The type of managed identity assigned to this resource. | | userAssignedIdentities? | `Record` | The identities assigned to this resource by the user. | +### `ManagedServiceIdentityWithDelegation` {#Azure.ResourceManager.CommonTypes.ManagedServiceIdentityWithDelegation} + +Managed service identity (system assigned and/or user assigned identities and/or delegated identities) - internal use only. + +```typespec +model Azure.ResourceManager.CommonTypes.ManagedServiceIdentityWithDelegation +``` + +#### Properties + +| Name | Type | Description | +| ------------------- | -------------------------------------------------------------------------------------------- | ----------- | +| delegatedResources? | [`DelegatedResources`](./data-types.md#Azure.ResourceManager.CommonTypes.DelegatedResources) | | + ### `ManagementGroupNameParameter` {#Azure.ResourceManager.CommonTypes.ManagementGroupNameParameter} The default ManagementGroupName parameter type. @@ -1286,6 +1394,107 @@ model Azure.ResourceManager.CommonTypes.MoboBrokerResource | ---- | ---------------------------- | ------------------------------------------------------------- | | id? | `Core.armResourceIdentifier` | Resource identifier of a Managed-On-Behalf-Of broker resource | +### `NetworkSecurityPerimeter` {#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeter} + +Information about a network security perimeter (NSP) + +```typespec +model Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeter +``` + +#### Properties + +| Name | Type | Description | +| -------------- | ---------------------------- | ------------------------------------------------------------ | +| id? | `Core.armResourceIdentifier` | Fully qualified Azure resource ID of the NSP resource | +| perimeterGuid? | `Core.uuid` | Universal unique ID (UUID) of the network security perimeter | +| location? | `string` | Location of the network security perimeter | + +### `NetworkSecurityPerimeterConfiguration` {#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfiguration} + +Network security perimeter (NSP) configuration resource + +```typespec +model Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfiguration +``` + +#### Properties + +| Name | Type | Description | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | +| properties? | [`NetworkSecurityPerimeterConfigurationProperties`](./data-types.md#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationProperties) | | + +### `NetworkSecurityPerimeterConfigurationListResult` {#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationListResult} + +Result of a list NSP (network security perimeter) configurations request. + +```typespec +model Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationListResult +``` + +#### Properties + +| Name | Type | Description | +| --------- | --------------------------------------------------------------------- | ---------------------------------------------- | +| value? | `ResourceManager.CommonTypes.NetworkSecurityPerimeterConfiguration[]` | Array of network security perimeter results. | +| nextLink? | `url` | The link used to get the next page of results. | + +### `NetworkSecurityPerimeterConfigurationNameParameter` {#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationNameParameter} + +The name for a network security perimeter configuration + +```typespec +model Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationNameParameter +``` + +#### Template Parameters + +| Name | Description | +| ------- | ----------------------------------------------------------------------------------------------------------------------- | +| Segment | The resource type name for network security perimeter configuration (default is networkSecurityPerimeterConfigurations) | + +#### Properties + +| Name | Type | Description | +| ---- | -------- | ------------------------------------------------------- | +| name | `string` | The name for a network security perimeter configuration | + +### `NetworkSecurityPerimeterConfigurationProperties` {#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationProperties} + +Network security configuration properties. + +```typespec +model Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationProperties +``` + +#### Properties + +| Name | Type | Description | +| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | +| provisioningState? | [`NetworkSecurityPerimeterConfigurationProvisioningState`](./data-types.md#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationProvisioningState) | | +| provisioningIssues? | `ResourceManager.CommonTypes.ProvisioningIssue[]` | List of provisioning issues, if any | +| networkSecurityPerimeter? | [`NetworkSecurityPerimeter`](./data-types.md#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeter) | | +| resourceAssociation? | [`ResourceAssociation`](./data-types.md#Azure.ResourceManager.CommonTypes.ResourceAssociation) | | +| profile? | [`NetworkSecurityProfile`](./data-types.md#Azure.ResourceManager.CommonTypes.NetworkSecurityProfile) | | + +### `NetworkSecurityProfile` {#Azure.ResourceManager.CommonTypes.NetworkSecurityProfile} + +Network security perimeter configuration profile + +```typespec +model Azure.ResourceManager.CommonTypes.NetworkSecurityProfile +``` + +#### Properties + +| Name | Type | Description | +| -------------------------- | ------------------------------------------ | --------------------------------------- | +| name? | `string` | Name of the profile | +| accessRulesVersion? | `int32` | Current access rules version | +| accessRules? | `ResourceManager.CommonTypes.AccessRule[]` | List of Access Rules | +| diagnosticSettingsVersion? | `int32` | Current diagnostic settings version | +| enabledLogCategories? | `string[]` | List of log categories that are enabled | + ### `Operation` {#Azure.ResourceManager.CommonTypes.Operation} Details of a REST API operation, returned from the Resource Provider Operations API @@ -1548,6 +1757,39 @@ model Azure.ResourceManager.CommonTypes.PrivateLinkServiceConnectionState | description? | `string` | The reason for approval/rejection of the connection. | | actionsRequired? | `string` | A message indicating if changes on the service provider require any updates on the consumer. | +### `ProvisioningIssue` {#Azure.ResourceManager.CommonTypes.ProvisioningIssue} + +Describes a provisioning issue for a network security perimeter configuration + +```typespec +model Azure.ResourceManager.CommonTypes.ProvisioningIssue +``` + +#### Properties + +| Name | Type | Description | +| ----------- | -------------------------------------------------------------------------------------------------------------- | ----------------- | +| name? | `string` | Name of the issue | +| properties? | [`ProvisioningIssueProperties`](./data-types.md#Azure.ResourceManager.CommonTypes.ProvisioningIssueProperties) | | + +### `ProvisioningIssueProperties` {#Azure.ResourceManager.CommonTypes.ProvisioningIssueProperties} + +Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules + +```typespec +model Azure.ResourceManager.CommonTypes.ProvisioningIssueProperties +``` + +#### Properties + +| Name | Type | Description | +| --------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| issueType? | [`IssueType`](./data-types.md#Azure.ResourceManager.CommonTypes.IssueType) | Type of issue | +| severity? | [`Severity`](./data-types.md#Azure.ResourceManager.CommonTypes.Severity) | Severity of the issue. | +| description? | `string` | Description of the issue | +| suggestedResourceIds? | `Core.armResourceIdentifier[]` | Fully qualified resource IDs of suggested resources that can be associated to the network security perimeter (NSP) to remediate the issue. | +| suggestedAccessRules? | `ResourceManager.CommonTypes.AccessRule[]` | Access rules that can be added to the network security profile (NSP) to remediate the issue. | + ### `ProxyResource` {#Azure.ResourceManager.CommonTypes.ProxyResource} The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location @@ -1577,6 +1819,21 @@ model Azure.ResourceManager.CommonTypes.Resource | type? | `string` | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" | | systemData? | [`SystemData`](./data-types.md#Azure.ResourceManager.CommonTypes.SystemData) | Azure Resource Manager metadata containing createdBy and modifiedBy information. | +### `ResourceAssociation` {#Azure.ResourceManager.CommonTypes.ResourceAssociation} + +Information about resource association + +```typespec +model Azure.ResourceManager.CommonTypes.ResourceAssociation +``` + +#### Properties + +| Name | Type | Description | +| ----------- | ------------------------------------------------------------------------------------------------------------------ | -------------------------------- | +| name? | `string` | Name of the resource association | +| accessMode? | [`ResourceAssociationAccessMode`](./data-types.md#Azure.ResourceManager.CommonTypes.ResourceAssociationAccessMode) | | + ### `ResourceGroupNameParameter` {#Azure.ResourceManager.CommonTypes.ResourceGroupNameParameter} The default resource group parameter type. @@ -1783,6 +2040,14 @@ enum Azure.ResourceManager.CommonTypes.Versions | v4 | | The Azure Resource Manager v4 common types. | | v5 | | The Azure Resource Manager v5 common types. | +### `AccessRuleDirection` {#Azure.ResourceManager.CommonTypes.AccessRuleDirection} + +Direction of Access Rule + +```typespec +union Azure.ResourceManager.CommonTypes.AccessRuleDirection +``` + ### `ActionType` {#Azure.ResourceManager.CommonTypes.ActionType} Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. @@ -1831,6 +2096,14 @@ union Azure.ResourceManager.CommonTypes.ExtendedLocationType union Azure.ResourceManager.CommonTypes.InfrastructureEncryption ``` +### `IssueType` {#Azure.ResourceManager.CommonTypes.IssueType} + +Type of issue + +```typespec +union Azure.ResourceManager.CommonTypes.IssueType +``` + ### `KeyEncryptionKeyIdentityType` {#Azure.ResourceManager.CommonTypes.KeyEncryptionKeyIdentityType} The type of identity to use. @@ -1847,6 +2120,14 @@ Type of managed service identity (where both SystemAssigned and UserAssigned typ union Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType ``` +### `NetworkSecurityPerimeterConfigurationProvisioningState` {#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationProvisioningState} + +Provisioning state of a network security perimeter configuration that is being created or updated. + +```typespec +union Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationProvisioningState +``` + ### `Origin` {#Azure.ResourceManager.CommonTypes.Origin} The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" @@ -1871,12 +2152,36 @@ The private endpoint connection status. union Azure.ResourceManager.CommonTypes.PrivateEndpointServiceConnectionStatus ``` +### `PublicNetworkAccess` {#Azure.ResourceManager.CommonTypes.PublicNetworkAccess} + +Allow, disallow, or let network security perimeter configuration control public network access to the protected resource. Value is optional but if passed in, it must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'. + +```typespec +union Azure.ResourceManager.CommonTypes.PublicNetworkAccess +``` + +### `ResourceAssociationAccessMode` {#Azure.ResourceManager.CommonTypes.ResourceAssociationAccessMode} + +Access mode of the resource association + +```typespec +union Azure.ResourceManager.CommonTypes.ResourceAssociationAccessMode +``` + ### `ResourceIdentityType` {#Azure.ResourceManager.CommonTypes.ResourceIdentityType} ```typespec union Azure.ResourceManager.CommonTypes.ResourceIdentityType ``` +### `Severity` {#Azure.ResourceManager.CommonTypes.Severity} + +Severity of the issue. + +```typespec +union Azure.ResourceManager.CommonTypes.Severity +``` + ### `SkuTier` {#Azure.ResourceManager.CommonTypes.SkuTier} This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/index.mdx b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/index.mdx index 8fa442cd3c..b15c9863f5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/index.mdx +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/index.mdx @@ -87,6 +87,8 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager - [`ArmCustomPatchAsync`](./interfaces.md#Azure.ResourceManager.ArmCustomPatchAsync) - [`ArmCustomPatchSync`](./interfaces.md#Azure.ResourceManager.ArmCustomPatchSync) - [`ArmListBySubscription`](./interfaces.md#Azure.ResourceManager.ArmListBySubscription) +- [`ArmProviderActionAsync`](./interfaces.md#Azure.ResourceManager.ArmProviderActionAsync) +- [`ArmProviderActionSync`](./interfaces.md#Azure.ResourceManager.ArmProviderActionSync) - [`ArmResourceActionAsync`](./interfaces.md#Azure.ResourceManager.ArmResourceActionAsync) - [`ArmResourceActionAsyncBase`](./interfaces.md#Azure.ResourceManager.ArmResourceActionAsyncBase) - [`ArmResourceActionNoContentAsync`](./interfaces.md#Azure.ResourceManager.ArmResourceActionNoContentAsync) @@ -155,7 +157,9 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager - [`ResourcePlanProperty`](./data-types.md#Azure.ResourceManager.ResourcePlanProperty) - [`ResourceSkuProperty`](./data-types.md#Azure.ResourceManager.ResourceSkuProperty) - [`ResourceUriParameter`](./data-types.md#Azure.ResourceManager.ResourceUriParameter) +- [`SubscriptionActionScope`](./data-types.md#Azure.ResourceManager.SubscriptionActionScope) - [`SubscriptionLocationResource`](./data-types.md#Azure.ResourceManager.SubscriptionLocationResource) +- [`TenantActionScope`](./data-types.md#Azure.ResourceManager.TenantActionScope) - [`TenantLocationResource`](./data-types.md#Azure.ResourceManager.TenantLocationResource) - [`TrackedResource`](./data-types.md#Azure.ResourceManager.TrackedResource) @@ -163,11 +167,15 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager ### Models +- [`AccessRule`](./data-types.md#Azure.ResourceManager.CommonTypes.AccessRule) +- [`AccessRuleProperties`](./data-types.md#Azure.ResourceManager.CommonTypes.AccessRuleProperties) - [`ApiVersionParameter`](./data-types.md#Azure.ResourceManager.CommonTypes.ApiVersionParameter) - [`AzureEntityResource`](./data-types.md#Azure.ResourceManager.CommonTypes.AzureEntityResource) - [`CheckNameAvailabilityRequest`](./data-types.md#Azure.ResourceManager.CommonTypes.CheckNameAvailabilityRequest) - [`CheckNameAvailabilityResponse`](./data-types.md#Azure.ResourceManager.CommonTypes.CheckNameAvailabilityResponse) - [`CustomerManagedKeyEncryption`](./data-types.md#Azure.ResourceManager.CommonTypes.CustomerManagedKeyEncryption) +- [`DelegatedResource`](./data-types.md#Azure.ResourceManager.CommonTypes.DelegatedResource) +- [`DelegatedResources`](./data-types.md#Azure.ResourceManager.CommonTypes.DelegatedResources) - [`Encryption`](./data-types.md#Azure.ResourceManager.CommonTypes.Encryption) - [`EncryptionProperties`](./data-types.md#Azure.ResourceManager.CommonTypes.EncryptionProperties) - [`ErrorAdditionalInfo`](./data-types.md#Azure.ResourceManager.CommonTypes.ErrorAdditionalInfo) @@ -185,8 +193,15 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager - [`LocationResourceParameter`](./data-types.md#Azure.ResourceManager.CommonTypes.LocationResourceParameter) - [`ManagedOnBehalfOfConfiguration`](./data-types.md#Azure.ResourceManager.CommonTypes.ManagedOnBehalfOfConfiguration) - [`ManagedServiceIdentity`](./data-types.md#Azure.ResourceManager.CommonTypes.ManagedServiceIdentity) +- [`ManagedServiceIdentityWithDelegation`](./data-types.md#Azure.ResourceManager.CommonTypes.ManagedServiceIdentityWithDelegation) - [`ManagementGroupNameParameter`](./data-types.md#Azure.ResourceManager.CommonTypes.ManagementGroupNameParameter) - [`MoboBrokerResource`](./data-types.md#Azure.ResourceManager.CommonTypes.MoboBrokerResource) +- [`NetworkSecurityPerimeter`](./data-types.md#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeter) +- [`NetworkSecurityPerimeterConfiguration`](./data-types.md#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfiguration) +- [`NetworkSecurityPerimeterConfigurationListResult`](./data-types.md#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationListResult) +- [`NetworkSecurityPerimeterConfigurationNameParameter`](./data-types.md#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationNameParameter) +- [`NetworkSecurityPerimeterConfigurationProperties`](./data-types.md#Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationProperties) +- [`NetworkSecurityProfile`](./data-types.md#Azure.ResourceManager.CommonTypes.NetworkSecurityProfile) - [`Operation`](./data-types.md#Azure.ResourceManager.CommonTypes.Operation) - [`OperationDisplay`](./data-types.md#Azure.ResourceManager.CommonTypes.OperationDisplay) - [`OperationIdParameter`](./data-types.md#Azure.ResourceManager.CommonTypes.OperationIdParameter) @@ -203,8 +218,11 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager - [`PrivateLinkResourceParameter`](./data-types.md#Azure.ResourceManager.CommonTypes.PrivateLinkResourceParameter) - [`PrivateLinkResourceProperties`](./data-types.md#Azure.ResourceManager.CommonTypes.PrivateLinkResourceProperties) - [`PrivateLinkServiceConnectionState`](./data-types.md#Azure.ResourceManager.CommonTypes.PrivateLinkServiceConnectionState) +- [`ProvisioningIssue`](./data-types.md#Azure.ResourceManager.CommonTypes.ProvisioningIssue) +- [`ProvisioningIssueProperties`](./data-types.md#Azure.ResourceManager.CommonTypes.ProvisioningIssueProperties) - [`ProxyResource`](./data-types.md#Azure.ResourceManager.CommonTypes.ProxyResource) - [`Resource`](./data-types.md#Azure.ResourceManager.CommonTypes.Resource) +- [`ResourceAssociation`](./data-types.md#Azure.ResourceManager.CommonTypes.ResourceAssociation) - [`ResourceGroupNameParameter`](./data-types.md#Azure.ResourceManager.CommonTypes.ResourceGroupNameParameter) - [`ResourceModelWithAllowedPropertySet`](./data-types.md#Azure.ResourceManager.CommonTypes.ResourceModelWithAllowedPropertySet) - [`ScopeParameter`](./data-types.md#Azure.ResourceManager.CommonTypes.ScopeParameter) diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/interfaces.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/interfaces.md index 0fc27525a0..b0217d5796 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/interfaces.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/interfaces.md @@ -671,6 +671,39 @@ op Azure.ResourceManager.ArmListBySubscription(apiVersion: string, subscriptionI | Response | Optional. The success response for the list operation | | Error | Optional. The error response, if non-standard. | +### `ArmProviderActionAsync` {#Azure.ResourceManager.ArmProviderActionAsync} + +```typespec +op Azure.ResourceManager.ArmProviderActionAsync(apiVersion: string, subscriptionId: Azure.Core.uuid, location: string, resourceGroupName: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced", body: Request): Response | Azure.ResourceManager.CommonTypes.ErrorResponse +``` + +#### Template Parameters + +| Name | Description | +| ---------- | ----------------------------------------------------------------------------- | +| Request | The request model for the action | +| Response | The response type for the action | +| Scope | The scope of the action (SubscriptionActionScope or TenantActionScope) | +| Parameters | Optional. Additional parameters after the path parameters (e.g. Location) | +| LroHeaders | Optional. Allows overriding the lro headers returned in the Accepted response | +| Error | Optional. The error response, if non-standard. | + +### `ArmProviderActionSync` {#Azure.ResourceManager.ArmProviderActionSync} + +```typespec +op Azure.ResourceManager.ArmProviderActionSync(apiVersion: string, subscriptionId: Azure.Core.uuid, location: string, resourceGroupName: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced", body: Request): Response | Azure.ResourceManager.CommonTypes.ErrorResponse +``` + +#### Template Parameters + +| Name | Description | +| ---------- | ------------------------------------------------------------------------- | +| Request | The request model for the action | +| Response | The response type for the action | +| Scope | The scope of the action (SubscriptionActionScope or TenantActionScope) | +| Parameters | Optional. Additional parameters after the path parameters (e.g. Location) | +| Error | Optional. The error response, if non-standard. | + ### `ArmResourceActionAsync` {#Azure.ResourceManager.ArmResourceActionAsync} ```typespec diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/index.md index 74b273c1e2..5a1cbbf678 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/index.md @@ -9,8 +9,8 @@ title: "[P] JS API" ## Interfaces -- [ArmCommonTypeVersions](interfaces/ArmCommonTypeVersions.md) - [ArmCommonTypesResolutionOptions](interfaces/ArmCommonTypesResolutionOptions.md) +- [ArmCommonTypeVersions](interfaces/ArmCommonTypeVersions.md) - [ArmLifecycleOperations](interfaces/ArmLifecycleOperations.md) - [ArmResourceDetails](interfaces/ArmResourceDetails.md) - [ArmResourceDetailsBase](interfaces/ArmResourceDetailsBase.md) @@ -33,8 +33,8 @@ title: "[P] JS API" - [$armCommonTypesVersion](functions/$armCommonTypesVersion.md) - [$armLibraryNamespace](functions/$armLibraryNamespace.md) -- [$armProviderNameValue](functions/$armProviderNameValue.md) - [$armProviderNamespace](functions/$armProviderNamespace.md) +- [$armProviderNameValue](functions/$armProviderNameValue.md) - [$armResourceAction](functions/$armResourceAction.md) - [$armResourceCollectionAction](functions/$armResourceCollectionAction.md) - [$armResourceCreateOrUpdate](functions/$armResourceCreateOrUpdate.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/linter.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/linter.md index 9817643f96..8b4584a855 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/linter.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/linter.md @@ -56,3 +56,4 @@ Available ruleSets: | `@azure-tools/typespec-azure-resource-manager/resource-name` | Check the resource name. | | `@azure-tools/typespec-azure-resource-manager/retry-after` | Check if retry-after header appears in response body. | | [`@azure-tools/typespec-azure-resource-manager/unsupported-type`](/libraries/azure-resource-manager/rules/unsupported-type.md) | Check for unsupported ARM types. | +| [`@azure-tools/typespec-azure-resource-manager/no-empty-model`](/libraries/azure-resource-manager/rules/no-empty-model.md) | ARM Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/no-empty-model.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/no-empty-model.md new file mode 100644 index 0000000000..c2b30eda06 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/no-empty-model.md @@ -0,0 +1,51 @@ +--- +title: no-empty-model +--- + +```text title=- Full name- +@azure-tools/typespec-azure-resource-manager/no-empty-model +``` + +ARM Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. + +#### ❌ Incorrect + +```tsp +model Information { + address: {}; +} +``` + +#### ❌ Incorrect + +```tsp +model Empty {} +``` + +#### ✅ Correct + +```tsp +model Information { + address: Address; +} + +model Address { + street: string; + city: string; + state: string; + country: string; + postalCode: string; +} +``` + +#### ✅ Correct + +```tsp +model Information { + street: string; + city: string; + state: string; + country: string; + postalCode: string; +} +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/addFormatInfo.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/addFormatInfo.md deleted file mode 100644 index af3f2b27ad..0000000000 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/addFormatInfo.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -jsApi: true -title: "[F] addFormatInfo" - ---- -```ts -function addFormatInfo( - context, - type, - propertyType): void -``` - -Add format info onto an sdk type. Since the format decorator -decorates the ModelProperty, we add the format info onto the property's internal -type. - -## Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `context` | [`TCGCContext`](../interfaces/TCGCContext.md) | sdk context | -| `type` | `ModelProperty` \| `Scalar` | the original typespec type. Used to grab the format decorator off of | -| `propertyType` | [`SdkType`](../type-aliases/SdkType.md) | the type of the property, i.e. the internal type that we add the format info onto | - -## Returns - -`void` diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/index.md index 39287b53d0..7992158a30 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/index.md @@ -12,13 +12,12 @@ title: "[P] JS API" - [CreateSdkContextOptions](interfaces/CreateSdkContextOptions.md) - [DecoratorInfo](interfaces/DecoratorInfo.md) - [MultipartOptions](interfaces/MultipartOptions.md) -- [SdkAnyExample](interfaces/SdkAnyExample.md) -- [SdkArrayExample](interfaces/SdkArrayExample.md) +- [SdkArrayExampleValue](interfaces/SdkArrayExampleValue.md) - [SdkArrayType](interfaces/SdkArrayType.md) - [SdkBasicServiceMethod](interfaces/SdkBasicServiceMethod.md) - [SdkBodyModelPropertyType](interfaces/SdkBodyModelPropertyType.md) - [SdkBodyParameter](interfaces/SdkBodyParameter.md) -- [SdkBooleanExample](interfaces/SdkBooleanExample.md) +- [SdkBooleanExampleValue](interfaces/SdkBooleanExampleValue.md) - [SdkBuiltInType](interfaces/SdkBuiltInType.md) - [SdkClient](interfaces/SdkClient.md) - [SdkClientAccessor](interfaces/SdkClientAccessor.md) @@ -27,7 +26,7 @@ title: "[P] JS API" - [SdkContext](interfaces/SdkContext.md) - [SdkCredentialParameter](interfaces/SdkCredentialParameter.md) - [SdkCredentialType](interfaces/SdkCredentialType.md) -- [SdkDictionaryExample](interfaces/SdkDictionaryExample.md) +- [SdkDictionaryExampleValue](interfaces/SdkDictionaryExampleValue.md) - [SdkDictionaryType](interfaces/SdkDictionaryType.md) - [SdkDurationType](interfaces/SdkDurationType.md) - [SdkEmitterOptions](interfaces/SdkEmitterOptions.md) @@ -35,25 +34,29 @@ title: "[P] JS API" - [SdkEndpointType](interfaces/SdkEndpointType.md) - [SdkEnumType](interfaces/SdkEnumType.md) - [SdkEnumValueType](interfaces/SdkEnumValueType.md) -- [SdkExampleTypeBase](interfaces/SdkExampleTypeBase.md) - [SdkHeaderParameter](interfaces/SdkHeaderParameter.md) +- [SdkHttpErrorResponse](interfaces/SdkHttpErrorResponse.md) - [SdkHttpOperation](interfaces/SdkHttpOperation.md) - [SdkHttpOperationExample](interfaces/SdkHttpOperationExample.md) -- [SdkHttpParameterExample](interfaces/SdkHttpParameterExample.md) +- [SdkHttpParameterExampleValue](interfaces/SdkHttpParameterExampleValue.md) - [SdkHttpResponse](interfaces/SdkHttpResponse.md) -- [SdkHttpResponseExample](interfaces/SdkHttpResponseExample.md) -- [SdkHttpResponseHeaderExample](interfaces/SdkHttpResponseHeaderExample.md) +- [SdkHttpResponseExampleValue](interfaces/SdkHttpResponseExampleValue.md) +- [SdkHttpResponseHeaderExampleValue](interfaces/SdkHttpResponseHeaderExampleValue.md) - [SdkInitializationType](interfaces/SdkInitializationType.md) - [SdkLroPagingServiceMethod](interfaces/SdkLroPagingServiceMethod.md) +- [SdkLroServiceFinalResponse](interfaces/SdkLroServiceFinalResponse.md) +- [SdkLroServiceFinalStep](interfaces/SdkLroServiceFinalStep.md) +- [SdkLroServiceMetadata](interfaces/SdkLroServiceMetadata.md) - [SdkLroServiceMethod](interfaces/SdkLroServiceMethod.md) +- [SdkLroServicePollingStep](interfaces/SdkLroServicePollingStep.md) - [SdkMethodParameter](interfaces/SdkMethodParameter.md) - [SdkMethodResponse](interfaces/SdkMethodResponse.md) -- [SdkModelExample](interfaces/SdkModelExample.md) +- [SdkModelExampleValue](interfaces/SdkModelExampleValue.md) - [SdkModelPropertyTypeBase](interfaces/SdkModelPropertyTypeBase.md) - [SdkModelType](interfaces/SdkModelType.md) -- [SdkNullExample](interfaces/SdkNullExample.md) - [SdkNullableType](interfaces/SdkNullableType.md) -- [SdkNumberExample](interfaces/SdkNumberExample.md) +- [SdkNullExampleValue](interfaces/SdkNullExampleValue.md) +- [SdkNumberExampleValue](interfaces/SdkNumberExampleValue.md) - [SdkOperationGroup](interfaces/SdkOperationGroup.md) - [SdkPackage](interfaces/SdkPackage.md) - [SdkPagingServiceMethod](interfaces/SdkPagingServiceMethod.md) @@ -61,10 +64,11 @@ title: "[P] JS API" - [SdkQueryParameter](interfaces/SdkQueryParameter.md) - [SdkServiceResponse](interfaces/SdkServiceResponse.md) - [SdkServiceResponseHeader](interfaces/SdkServiceResponseHeader.md) -- [SdkStringExample](interfaces/SdkStringExample.md) +- [SdkStringExampleValue](interfaces/SdkStringExampleValue.md) - [SdkTupleType](interfaces/SdkTupleType.md) -- [SdkUnionExample](interfaces/SdkUnionExample.md) +- [SdkUnionExampleValue](interfaces/SdkUnionExampleValue.md) - [SdkUnionType](interfaces/SdkUnionType.md) +- [SdkUnknownExampleValue](interfaces/SdkUnknownExampleValue.md) - [TCGCContext](interfaces/TCGCContext.md) ## Type Aliases @@ -74,6 +78,7 @@ title: "[P] JS API" - [LanguageScopes](type-aliases/LanguageScopes.md) - [SdkBuiltInKinds](type-aliases/SdkBuiltInKinds.md) - [SdkDateTimeType](type-aliases/SdkDateTimeType.md) +- [SdkExampleValue](type-aliases/SdkExampleValue.md) - [SdkHttpPackage](type-aliases/SdkHttpPackage.md) - [SdkHttpParameter](type-aliases/SdkHttpParameter.md) - [SdkMethod](type-aliases/SdkMethod.md) @@ -83,7 +88,6 @@ title: "[P] JS API" - [SdkServiceOperation](type-aliases/SdkServiceOperation.md) - [SdkServiceParameter](type-aliases/SdkServiceParameter.md) - [SdkType](type-aliases/SdkType.md) -- [SdkTypeExample](type-aliases/SdkTypeExample.md) ## Variables @@ -104,7 +108,6 @@ title: "[P] JS API" - [$usage](functions/$usage.md) - [$useSystemTextJsonConverter](functions/$useSystemTextJsonConverter.md) - [addEncodeInfo](functions/addEncodeInfo.md) -- [addFormatInfo](functions/addFormatInfo.md) - [createDiagnostic](functions/createDiagnostic.md) - [createSdkContext](functions/createSdkContext.md) - [createStateSymbol](functions/createStateSymbol.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkAnyExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkAnyExample.md deleted file mode 100644 index c7c76a1d86..0000000000 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkAnyExample.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] SdkAnyExample" - ---- -## Extends - -- [`SdkExampleTypeBase`](SdkExampleTypeBase.md) - -## Properties - -| Property | Type | Overrides | -| ------ | ------ | ------ | -| `kind` | `"any"` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`kind` | -| `type` | [`SdkBuiltInType`](SdkBuiltInType.md) | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`type` | -| `value` | `unknown` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayExample.md deleted file mode 100644 index b6fdae3103..0000000000 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayExample.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] SdkArrayExample" - ---- -## Extends - -- [`SdkExampleTypeBase`](SdkExampleTypeBase.md) - -## Properties - -| Property | Type | Overrides | -| ------ | ------ | ------ | -| `kind` | `"array"` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`kind` | -| `type` | [`SdkArrayType`](SdkArrayType.md) | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`type` | -| `value` | [`SdkTypeExample`](../type-aliases/SdkTypeExample.md)[] | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayExampleValue.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayExampleValue.md new file mode 100644 index 0000000000..6eebd832c1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayExampleValue.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] SdkArrayExampleValue" + +--- +## Extends + +- `SdkExampleValueBase` + +## Properties + +| Property | Type | Overrides | +| ------ | ------ | ------ | +| `kind` | `"array"` | `SdkExampleValueBase.kind` | +| `type` | [`SdkArrayType`](SdkArrayType.md) | `SdkExampleValueBase.type` | +| `value` | [`SdkExampleValue`](../type-aliases/SdkExampleValue.md)[] | `SdkExampleValueBase.value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayType.md index 3ba18f2bf5..d33d2f649c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayType.md @@ -9,17 +9,15 @@ title: "[I] SdkArrayType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | `SdkTypeBase.__accessSet` | -| `__raw?` | `Type` | - | - | `SdkTypeBase.__raw` | -| `crossLanguageDefinitionId` | `string` | - | - | - | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | `SdkTypeBase.decorators` | -| `deprecation?` | `string` | - | - | `SdkTypeBase.deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.details` | -| `doc?` | `string` | - | - | `SdkTypeBase.doc` | -| `kind` | `"array"` | - | `SdkTypeBase.kind` | - | -| `name` | `string` | - | - | - | -| `summary?` | `string` | - | - | `SdkTypeBase.summary` | -| `valueType` | [`SdkType`](../type-aliases/SdkType.md) | - | - | - | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | `SdkTypeBase.__accessSet` | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `crossLanguageDefinitionId` | `string` | - | - | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkTypeBase.decorators` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `doc?` | `string` | - | `SdkTypeBase.doc` | +| `kind` | `"array"` | `SdkTypeBase.kind` | - | +| `name` | `string` | - | - | +| `summary?` | `string` | - | `SdkTypeBase.summary` | +| `valueType` | [`SdkType`](../type-aliases/SdkType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBasicServiceMethod.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBasicServiceMethod.md index 88f2f6bb5e..2a0920e2ab 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBasicServiceMethod.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBasicServiceMethod.md @@ -15,22 +15,20 @@ title: "[I] SdkBasicServiceMethod" ## Properties -| Property | Type | Description | Inherited from | -| ------ | ------ | ------ | ------ | -| `__raw?` | `Operation` | - | `SdkServiceMethodBase.__raw` | -| `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | - | `SdkServiceMethodBase.access` | -| `apiVersions` | `string`[] | - | `SdkServiceMethodBase.apiVersions` | -| `crossLanguageDefintionId` | `string` | - | `SdkServiceMethodBase.crossLanguageDefintionId` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkServiceMethodBase.decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | `SdkServiceMethodBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | `SdkServiceMethodBase.details` | -| `doc?` | `string` | - | `SdkServiceMethodBase.doc` | -| `exception?` | [`SdkMethodResponse`](SdkMethodResponse.md) | - | `SdkServiceMethodBase.exception` | -| `generateConvenient` | `boolean` | - | `SdkServiceMethodBase.generateConvenient` | -| `generateProtocol` | `boolean` | - | `SdkServiceMethodBase.generateProtocol` | -| `kind` | `"basic"` | - | - | -| `name` | `string` | - | `SdkServiceMethodBase.name` | -| `operation` | `TServiceOperation` | - | `SdkServiceMethodBase.operation` | -| `parameters` | [`SdkMethodParameter`](SdkMethodParameter.md)[] | - | `SdkServiceMethodBase.parameters` | -| `response` | [`SdkMethodResponse`](SdkMethodResponse.md) | - | `SdkServiceMethodBase.response` | -| `summary?` | `string` | - | `SdkServiceMethodBase.summary` | +| Property | Type | Inherited from | +| ------ | ------ | ------ | +| `__raw?` | `Operation` | `SdkServiceMethodBase.__raw` | +| `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | `SdkServiceMethodBase.access` | +| `apiVersions` | `string`[] | `SdkServiceMethodBase.apiVersions` | +| `crossLanguageDefintionId` | `string` | `SdkServiceMethodBase.crossLanguageDefintionId` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | `SdkServiceMethodBase.decorators` | +| `doc?` | `string` | `SdkServiceMethodBase.doc` | +| `exception?` | [`SdkMethodResponse`](SdkMethodResponse.md) | `SdkServiceMethodBase.exception` | +| `generateConvenient` | `boolean` | `SdkServiceMethodBase.generateConvenient` | +| `generateProtocol` | `boolean` | `SdkServiceMethodBase.generateProtocol` | +| `kind` | `"basic"` | - | +| `name` | `string` | `SdkServiceMethodBase.name` | +| `operation` | `TServiceOperation` | `SdkServiceMethodBase.operation` | +| `parameters` | [`SdkMethodParameter`](SdkMethodParameter.md)[] | `SdkServiceMethodBase.parameters` | +| `response` | [`SdkMethodResponse`](SdkMethodResponse.md) | `SdkServiceMethodBase.response` | +| `summary?` | `string` | `SdkServiceMethodBase.summary` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBodyModelPropertyType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBodyModelPropertyType.md index 527b348a4d..ade8a8b123 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBodyModelPropertyType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBodyModelPropertyType.md @@ -9,27 +9,25 @@ title: "[I] SdkBodyModelPropertyType" ## Properties -| Property | Type | Description | Inherited from | -| ------ | ------ | ------ | ------ | -| `__raw?` | `ModelProperty` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | -| `apiVersions` | `string`[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | -| `clientDefaultValue?` | `any` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | -| `crossLanguageDefinitionId` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`details` | -| `discriminator` | `boolean` | - | - | -| `doc?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | -| `flatten` | `boolean` | - | - | -| `isApiVersionParam` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | -| `isGeneratedName` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | -| `isMultipartFileInput` | `boolean` | - | - | -| `kind` | `"property"` | - | - | -| `multipartOptions?` | [`MultipartOptions`](MultipartOptions.md) | - | - | -| `name` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | -| `onClient` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | -| `optional` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | -| `serializedName` | `string` | - | - | -| `summary?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | -| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | -| `visibility?` | `Visibility`[] | - | - | +| Property | Type | Inherited from | +| ------ | ------ | ------ | +| `__raw?` | `ModelProperty` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | +| `apiVersions` | `string`[] | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | +| `clientDefaultValue?` | `unknown` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | +| `crossLanguageDefinitionId` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | +| `discriminator` | `boolean` | - | +| `doc?` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | +| `flatten` | `boolean` | - | +| `isApiVersionParam` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | +| `isGeneratedName` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | +| `isMultipartFileInput` | `boolean` | - | +| `kind` | `"property"` | - | +| `multipartOptions?` | [`MultipartOptions`](MultipartOptions.md) | - | +| `name` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | +| `onClient` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | +| `optional` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | +| `serializedName` | `string` | - | +| `summary?` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | +| `type` | [`SdkType`](../type-aliases/SdkType.md) | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | +| `visibility?` | `Visibility`[] | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBodyParameter.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBodyParameter.md index 45b0a50c07..20526678cc 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBodyParameter.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBodyParameter.md @@ -9,24 +9,22 @@ title: "[I] SdkBodyParameter" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__raw?` | `ModelProperty` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | -| `apiVersions` | `string`[] | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | -| `clientDefaultValue?` | `any` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | -| `contentTypes` | `string`[] | - | - | - | -| `correspondingMethodParams` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md)[] | - | - | - | -| `crossLanguageDefinitionId` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | -| `defaultContentType` | `string` | - | - | - | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`details` | -| `doc?` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | -| `isApiVersionParam` | `boolean` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | -| `isGeneratedName` | `boolean` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | -| `kind` | `"body"` | - | - | - | -| `name` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | -| `onClient` | `boolean` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | -| `optional` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | - | -| `summary?` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | -| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__raw?` | `ModelProperty` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | +| `apiVersions` | `string`[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | +| `clientDefaultValue?` | `unknown` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | +| `contentTypes` | `string`[] | - | - | +| `correspondingMethodParams` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md)[] | - | - | +| `crossLanguageDefinitionId` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | +| `defaultContentType` | `string` | - | - | +| `doc?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | +| `isApiVersionParam` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | +| `isGeneratedName` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | +| `kind` | `"body"` | - | - | +| `name` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | +| `onClient` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | +| `optional` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | - | +| `summary?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | +| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBooleanExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBooleanExample.md deleted file mode 100644 index 3d6972f79d..0000000000 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBooleanExample.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] SdkBooleanExample" - ---- -## Extends - -- [`SdkExampleTypeBase`](SdkExampleTypeBase.md) - -## Properties - -| Property | Type | Overrides | -| ------ | ------ | ------ | -| `kind` | `"boolean"` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`kind` | -| `type` | [`SdkBuiltInType`](SdkBuiltInType.md) \| [`SdkConstantType`](SdkConstantType.md) | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`type` | -| `value` | `boolean` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBooleanExampleValue.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBooleanExampleValue.md new file mode 100644 index 0000000000..cb76ddb1e7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBooleanExampleValue.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] SdkBooleanExampleValue" + +--- +## Extends + +- `SdkExampleValueBase` + +## Properties + +| Property | Type | Overrides | +| ------ | ------ | ------ | +| `kind` | `"boolean"` | `SdkExampleValueBase.kind` | +| `type` | [`SdkBuiltInType`](SdkBuiltInType.md) \| [`SdkConstantType`](SdkConstantType.md) | `SdkExampleValueBase.type` | +| `value` | `boolean` | `SdkExampleValueBase.value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBuiltInType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBuiltInType.md index 6d7ea37ba3..f454b88ffd 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBuiltInType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBuiltInType.md @@ -9,18 +9,16 @@ title: "[I] SdkBuiltInType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | `SdkTypeBase.__accessSet` | -| `__raw?` | `Type` | - | - | `SdkTypeBase.__raw` | -| `baseType?` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | - | -| `crossLanguageDefinitionId` | `string` | - | - | - | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | `SdkTypeBase.decorators` | -| `deprecation?` | `string` | - | - | `SdkTypeBase.deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.details` | -| `doc?` | `string` | - | - | `SdkTypeBase.doc` | -| `encode` | `string` | - | - | - | -| `kind` | [`SdkBuiltInKinds`](../type-aliases/SdkBuiltInKinds.md) | - | `SdkTypeBase.kind` | - | -| `name` | `string` | - | - | - | -| `summary?` | `string` | - | - | `SdkTypeBase.summary` | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | `SdkTypeBase.__accessSet` | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `baseType?` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | +| `crossLanguageDefinitionId` | `string` | - | - | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkTypeBase.decorators` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `doc?` | `string` | - | `SdkTypeBase.doc` | +| `encode?` | `string` | - | - | +| `kind` | [`SdkBuiltInKinds`](../type-aliases/SdkBuiltInKinds.md) | `SdkTypeBase.kind` | - | +| `name` | `string` | - | - | +| `summary?` | `string` | - | `SdkTypeBase.summary` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkClientAccessor.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkClientAccessor.md index f046b4d48f..e51a3dadfb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkClientAccessor.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkClientAccessor.md @@ -15,18 +15,16 @@ title: "[I] SdkClientAccessor" ## Properties -| Property | Type | Description | Inherited from | -| ------ | ------ | ------ | ------ | -| `__raw?` | `Operation` | - | `SdkMethodBase.__raw` | -| `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | - | `SdkMethodBase.access` | -| `apiVersions` | `string`[] | - | `SdkMethodBase.apiVersions` | -| `crossLanguageDefintionId` | `string` | - | `SdkMethodBase.crossLanguageDefintionId` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkMethodBase.decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | `SdkMethodBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | `SdkMethodBase.details` | -| `doc?` | `string` | - | `SdkMethodBase.doc` | -| `kind` | `"clientaccessor"` | - | - | -| `name` | `string` | - | `SdkMethodBase.name` | -| `parameters` | [`SdkParameter`](../type-aliases/SdkParameter.md)[] | - | `SdkMethodBase.parameters` | -| `response` | [`SdkClientType`](SdkClientType.md)<`TServiceOperation`\> | - | - | -| `summary?` | `string` | - | `SdkMethodBase.summary` | +| Property | Type | Inherited from | +| ------ | ------ | ------ | +| `__raw?` | `Operation` | `SdkMethodBase.__raw` | +| `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | `SdkMethodBase.access` | +| `apiVersions` | `string`[] | `SdkMethodBase.apiVersions` | +| `crossLanguageDefintionId` | `string` | `SdkMethodBase.crossLanguageDefintionId` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | `SdkMethodBase.decorators` | +| `doc?` | `string` | `SdkMethodBase.doc` | +| `kind` | `"clientaccessor"` | - | +| `name` | `string` | `SdkMethodBase.name` | +| `parameters` | [`SdkParameter`](../type-aliases/SdkParameter.md)[] | `SdkMethodBase.parameters` | +| `response` | [`SdkClientType`](SdkClientType.md)<`TServiceOperation`\> | - | +| `summary?` | `string` | `SdkMethodBase.summary` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkClientType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkClientType.md index 8fd6b27e5d..09fc3b0fbc 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkClientType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkClientType.md @@ -15,19 +15,17 @@ title: "[I] SdkClientType" ## Properties -| Property | Type | Description | Inherited from | -| ------ | ------ | ------ | ------ | -| `__raw` | [`SdkClient`](SdkClient.md) \| [`SdkOperationGroup`](SdkOperationGroup.md) | - | - | -| `apiVersions` | `string`[] | - | - | -| `crossLanguageDefinitionId` | `string` | - | - | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `DecoratedType.decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | -| `doc?` | `string` | - | - | -| `initialization` | [`SdkInitializationType`](SdkInitializationType.md) | - | - | -| `kind` | `"client"` | - | - | -| `methods` | [`SdkMethod`](../type-aliases/SdkMethod.md)<`TServiceOperation`\>[] | - | - | -| `name` | `string` | - | - | -| `nameSpace` | `string` | - | - | -| `parent?` | [`SdkClientType`](SdkClientType.md)<`TServiceOperation`\> | - | - | -| `summary?` | `string` | - | - | +| Property | Type | Inherited from | +| ------ | ------ | ------ | +| `__raw` | [`SdkClient`](SdkClient.md) \| [`SdkOperationGroup`](SdkOperationGroup.md) | - | +| `apiVersions` | `string`[] | - | +| `crossLanguageDefinitionId` | `string` | - | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | `DecoratedType.decorators` | +| `doc?` | `string` | - | +| `initialization` | [`SdkInitializationType`](SdkInitializationType.md) | - | +| `kind` | `"client"` | - | +| `methods` | [`SdkMethod`](../type-aliases/SdkMethod.md)<`TServiceOperation`\>[] | - | +| `name` | `string` | - | +| `nameSpace` | `string` | - | +| `parent?` | [`SdkClientType`](SdkClientType.md)<`TServiceOperation`\> | - | +| `summary?` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkConstantType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkConstantType.md index 0331fc01f5..9263546b8c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkConstantType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkConstantType.md @@ -9,18 +9,16 @@ title: "[I] SdkConstantType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | `SdkTypeBase.__accessSet` | -| `__raw?` | `Type` | - | - | `SdkTypeBase.__raw` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | `SdkTypeBase.decorators` | -| `deprecation?` | `string` | - | - | `SdkTypeBase.deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.details` | -| `doc?` | `string` | - | - | `SdkTypeBase.doc` | -| `isGeneratedName` | `boolean` | - | - | - | -| `kind` | `"constant"` | - | `SdkTypeBase.kind` | - | -| `name` | `string` | - | - | - | -| `summary?` | `string` | - | - | `SdkTypeBase.summary` | -| `value` | `null` \| `string` \| `number` \| `boolean` | - | - | - | -| `valueType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | - | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | `SdkTypeBase.__accessSet` | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkTypeBase.decorators` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `doc?` | `string` | - | `SdkTypeBase.doc` | +| `isGeneratedName` | `boolean` | - | - | +| `kind` | `"constant"` | `SdkTypeBase.kind` | - | +| `name` | `string` | - | - | +| `summary?` | `string` | - | `SdkTypeBase.summary` | +| `value` | `null` \| `string` \| `number` \| `boolean` | - | - | +| `valueType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkContext.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkContext.md index c5c293337f..c203ac4bc1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkContext.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkContext.md @@ -34,8 +34,8 @@ title: "[I] SdkContext" | `filterOutCoreModels?` | `boolean` | [`TCGCContext`](TCGCContext.md).`filterOutCoreModels` | | `flattenUnionAsEnum?` | `boolean` | [`TCGCContext`](TCGCContext.md).`flattenUnionAsEnum` | | `generateConvenienceMethods?` | `boolean` | [`TCGCContext`](TCGCContext.md).`generateConvenienceMethods` | -| `generateProtocolMethods?` | `boolean` | [`TCGCContext`](TCGCContext.md).`generateProtocolMethods` | | `generatedNames?` | `Map`<`Model` \| `Union` \| `TspLiteralType`, `string`\> | [`TCGCContext`](TCGCContext.md).`generatedNames` | +| `generateProtocolMethods?` | `boolean` | [`TCGCContext`](TCGCContext.md).`generateProtocolMethods` | | `httpOperationCache?` | `Map`<`Operation`, `HttpOperation`\> | [`TCGCContext`](TCGCContext.md).`httpOperationCache` | | `knownScalars?` | `Record`<`string`, [`SdkBuiltInKinds`](../type-aliases/SdkBuiltInKinds.md)\> | [`TCGCContext`](TCGCContext.md).`knownScalars` | | `modelsMap?` | `Map`<`Type`, [`SdkModelType`](SdkModelType.md) \| [`SdkEnumType`](SdkEnumType.md)\> | [`TCGCContext`](TCGCContext.md).`modelsMap` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkCredentialParameter.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkCredentialParameter.md index 2241c20de2..0b8180f2e8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkCredentialParameter.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkCredentialParameter.md @@ -9,21 +9,19 @@ title: "[I] SdkCredentialParameter" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__raw?` | `ModelProperty` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | -| `apiVersions` | `string`[] | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | -| `clientDefaultValue?` | `any` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | -| `crossLanguageDefinitionId` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`details` | -| `doc?` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | -| `isApiVersionParam` | `boolean` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | -| `isGeneratedName` | `boolean` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | -| `kind` | `"credential"` | - | - | - | -| `name` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | -| `onClient` | `true` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | - | -| `optional` | `boolean` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | -| `summary?` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | -| `type` | [`SdkCredentialType`](SdkCredentialType.md) \| [`SdkUnionType`](SdkUnionType.md)<[`SdkCredentialType`](SdkCredentialType.md)\> | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | - | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__raw?` | `ModelProperty` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | +| `apiVersions` | `string`[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | +| `clientDefaultValue?` | `unknown` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | +| `crossLanguageDefinitionId` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | +| `doc?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | +| `isApiVersionParam` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | +| `isGeneratedName` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | +| `kind` | `"credential"` | - | - | +| `name` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | +| `onClient` | `true` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | - | +| `optional` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | +| `summary?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | +| `type` | [`SdkCredentialType`](SdkCredentialType.md) \| [`SdkUnionType`](SdkUnionType.md)<[`SdkCredentialType`](SdkCredentialType.md)\> | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkCredentialType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkCredentialType.md index e782083147..4eebff83f6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkCredentialType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkCredentialType.md @@ -9,15 +9,13 @@ title: "[I] SdkCredentialType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | `SdkTypeBase.__accessSet` | -| `__raw?` | `Type` | - | - | `SdkTypeBase.__raw` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | `SdkTypeBase.decorators` | -| `deprecation?` | `string` | - | - | `SdkTypeBase.deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.details` | -| `doc?` | `string` | - | - | `SdkTypeBase.doc` | -| `kind` | `"credential"` | - | `SdkTypeBase.kind` | - | -| `scheme` | `HttpAuth` | - | - | - | -| `summary?` | `string` | - | - | `SdkTypeBase.summary` | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | `SdkTypeBase.__accessSet` | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkTypeBase.decorators` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `doc?` | `string` | - | `SdkTypeBase.doc` | +| `kind` | `"credential"` | `SdkTypeBase.kind` | - | +| `scheme` | `HttpAuth` | - | - | +| `summary?` | `string` | - | `SdkTypeBase.summary` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryExample.md deleted file mode 100644 index 958e33e488..0000000000 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryExample.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] SdkDictionaryExample" - ---- -## Extends - -- [`SdkExampleTypeBase`](SdkExampleTypeBase.md) - -## Properties - -| Property | Type | Overrides | -| ------ | ------ | ------ | -| `kind` | `"dict"` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`kind` | -| `type` | [`SdkDictionaryType`](SdkDictionaryType.md) | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`type` | -| `value` | `Record`<`string`, [`SdkTypeExample`](../type-aliases/SdkTypeExample.md)\> | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryExampleValue.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryExampleValue.md new file mode 100644 index 0000000000..201478657e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryExampleValue.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] SdkDictionaryExampleValue" + +--- +## Extends + +- `SdkExampleValueBase` + +## Properties + +| Property | Type | Overrides | +| ------ | ------ | ------ | +| `kind` | `"dict"` | `SdkExampleValueBase.kind` | +| `type` | [`SdkDictionaryType`](SdkDictionaryType.md) | `SdkExampleValueBase.type` | +| `value` | `Record`<`string`, [`SdkExampleValue`](../type-aliases/SdkExampleValue.md)\> | `SdkExampleValueBase.value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryType.md index bb0d365d84..339d16040a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryType.md @@ -9,16 +9,14 @@ title: "[I] SdkDictionaryType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | `SdkTypeBase.__accessSet` | -| `__raw?` | `Type` | - | - | `SdkTypeBase.__raw` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | `SdkTypeBase.decorators` | -| `deprecation?` | `string` | - | - | `SdkTypeBase.deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.details` | -| `doc?` | `string` | - | - | `SdkTypeBase.doc` | -| `keyType` | [`SdkType`](../type-aliases/SdkType.md) | - | - | - | -| `kind` | `"dict"` | - | `SdkTypeBase.kind` | - | -| `summary?` | `string` | - | - | `SdkTypeBase.summary` | -| `valueType` | [`SdkType`](../type-aliases/SdkType.md) | - | - | - | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | `SdkTypeBase.__accessSet` | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkTypeBase.decorators` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `doc?` | `string` | - | `SdkTypeBase.doc` | +| `keyType` | [`SdkType`](../type-aliases/SdkType.md) | - | - | +| `kind` | `"dict"` | `SdkTypeBase.kind` | - | +| `summary?` | `string` | - | `SdkTypeBase.summary` | +| `valueType` | [`SdkType`](../type-aliases/SdkType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDurationType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDurationType.md index 533d7c5dc7..e3cbeb9fa0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDurationType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDurationType.md @@ -9,19 +9,17 @@ title: "[I] SdkDurationType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | `SdkTypeBase.__accessSet` | -| `__raw?` | `Type` | - | - | `SdkTypeBase.__raw` | -| `baseType?` | [`SdkDurationType`](SdkDurationType.md) | - | - | - | -| `crossLanguageDefinitionId` | `string` | - | - | - | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | `SdkTypeBase.decorators` | -| `deprecation?` | `string` | - | - | `SdkTypeBase.deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.details` | -| `doc?` | `string` | - | - | `SdkTypeBase.doc` | -| `encode` | `DurationKnownEncoding` | - | - | - | -| `kind` | `"duration"` | - | `SdkTypeBase.kind` | - | -| `name` | `string` | - | - | - | -| `summary?` | `string` | - | - | `SdkTypeBase.summary` | -| `wireType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | - | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | `SdkTypeBase.__accessSet` | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `baseType?` | [`SdkDurationType`](SdkDurationType.md) | - | - | +| `crossLanguageDefinitionId` | `string` | - | - | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkTypeBase.decorators` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `doc?` | `string` | - | `SdkTypeBase.doc` | +| `encode` | `DurationKnownEncoding` | - | - | +| `kind` | `"duration"` | `SdkTypeBase.kind` | - | +| `name` | `string` | - | - | +| `summary?` | `string` | - | `SdkTypeBase.summary` | +| `wireType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEndpointParameter.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEndpointParameter.md index edcf2f593c..a52e409a3c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEndpointParameter.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEndpointParameter.md @@ -9,23 +9,21 @@ title: "[I] SdkEndpointParameter" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__raw?` | `ModelProperty` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | -| `apiVersions` | `string`[] | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | -| `clientDefaultValue?` | `any` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | -| `crossLanguageDefinitionId` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`details` | -| `doc?` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | -| `isApiVersionParam` | `boolean` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | -| `isGeneratedName` | `boolean` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | -| `kind` | `"endpoint"` | - | - | - | -| `name` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | -| `onClient` | `true` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | - | -| `optional` | `boolean` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | -| `serializedName?` | `string` | - | - | - | -| `summary?` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | -| `type` | [`SdkEndpointType`](SdkEndpointType.md) \| [`SdkUnionType`](SdkUnionType.md)<[`SdkEndpointType`](SdkEndpointType.md)\> | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | - | -| `urlEncode` | `boolean` | - | - | - | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__raw?` | `ModelProperty` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | +| `apiVersions` | `string`[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | +| `clientDefaultValue?` | `unknown` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | +| `crossLanguageDefinitionId` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | +| `doc?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | +| `isApiVersionParam` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | +| `isGeneratedName` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | +| `kind` | `"endpoint"` | - | - | +| `name` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | +| `onClient` | `true` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | - | +| `optional` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | +| `serializedName?` | `string` | - | - | +| `summary?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | +| `type` | [`SdkEndpointType`](SdkEndpointType.md) \| [`SdkUnionType`](SdkUnionType.md)<[`SdkEndpointType`](SdkEndpointType.md)\> | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | - | +| `urlEncode` | `boolean` | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEndpointType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEndpointType.md index d7aea16995..fdfb8e2249 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEndpointType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEndpointType.md @@ -9,16 +9,14 @@ title: "[I] SdkEndpointType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | `SdkTypeBase.__accessSet` | -| `__raw?` | `Type` | - | - | `SdkTypeBase.__raw` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | `SdkTypeBase.decorators` | -| `deprecation?` | `string` | - | - | `SdkTypeBase.deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.details` | -| `doc?` | `string` | - | - | `SdkTypeBase.doc` | -| `kind` | `"endpoint"` | - | `SdkTypeBase.kind` | - | -| `serverUrl` | `string` | - | - | - | -| `summary?` | `string` | - | - | `SdkTypeBase.summary` | -| `templateArguments` | [`SdkPathParameter`](SdkPathParameter.md)[] | - | - | - | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | `SdkTypeBase.__accessSet` | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkTypeBase.decorators` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `doc?` | `string` | - | `SdkTypeBase.doc` | +| `kind` | `"endpoint"` | `SdkTypeBase.kind` | - | +| `serverUrl` | `string` | - | - | +| `summary?` | `string` | - | `SdkTypeBase.summary` | +| `templateArguments` | [`SdkPathParameter`](SdkPathParameter.md)[] | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumType.md index 0b1e195c29..0ac5e107d6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumType.md @@ -9,25 +9,23 @@ title: "[I] SdkEnumType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | `SdkTypeBase.__accessSet` | -| `__raw?` | `Type` | - | - | `SdkTypeBase.__raw` | -| `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | - | - | - | -| `apiVersions` | `string`[] | - | - | - | -| `crossLanguageDefinitionId` | `string` | - | - | - | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | `SdkTypeBase.decorators` | -| `deprecation?` | `string` | - | - | `SdkTypeBase.deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.details` | -| `doc?` | `string` | - | - | `SdkTypeBase.doc` | -| `isFixed` | `boolean` | - | - | - | -| `isFlags` | `boolean` | - | - | - | -| `isGeneratedName` | `boolean` | - | - | - | -| `isUnionAsEnum` | `boolean` | - | - | - | -| `kind` | `"enum"` | - | `SdkTypeBase.kind` | - | -| `name` | `string` | - | - | - | -| `summary?` | `string` | - | - | `SdkTypeBase.summary` | -| `usage` | [`UsageFlags`](../enumerations/UsageFlags.md) | - | - | - | -| `valueType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | - | -| `values` | [`SdkEnumValueType`](SdkEnumValueType.md)[] | - | - | - | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | `SdkTypeBase.__accessSet` | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | - | - | +| `apiVersions` | `string`[] | - | - | +| `crossLanguageDefinitionId` | `string` | - | - | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkTypeBase.decorators` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `doc?` | `string` | - | `SdkTypeBase.doc` | +| `isFixed` | `boolean` | - | - | +| `isFlags` | `boolean` | - | - | +| `isGeneratedName` | `boolean` | - | - | +| `isUnionAsEnum` | `boolean` | - | - | +| `kind` | `"enum"` | `SdkTypeBase.kind` | - | +| `name` | `string` | - | - | +| `summary?` | `string` | - | `SdkTypeBase.summary` | +| `usage` | [`UsageFlags`](../enumerations/UsageFlags.md) | - | - | +| `values` | [`SdkEnumValueType`](SdkEnumValueType.md)[] | - | - | +| `valueType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumValueType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumValueType.md index 91a8c907dc..e41ac4100e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumValueType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumValueType.md @@ -9,18 +9,16 @@ title: "[I] SdkEnumValueType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | `SdkTypeBase.__accessSet` | -| `__raw?` | `Type` | - | - | `SdkTypeBase.__raw` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | `SdkTypeBase.decorators` | -| `deprecation?` | `string` | - | - | `SdkTypeBase.deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.details` | -| `doc?` | `string` | - | - | `SdkTypeBase.doc` | -| `enumType` | [`SdkEnumType`](SdkEnumType.md) | - | - | - | -| `kind` | `"enumvalue"` | - | `SdkTypeBase.kind` | - | -| `name` | `string` | - | - | - | -| `summary?` | `string` | - | - | `SdkTypeBase.summary` | -| `value` | `string` \| `number` | - | - | - | -| `valueType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | - | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | `SdkTypeBase.__accessSet` | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkTypeBase.decorators` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `doc?` | `string` | - | `SdkTypeBase.doc` | +| `enumType` | [`SdkEnumType`](SdkEnumType.md) | - | - | +| `kind` | `"enumvalue"` | `SdkTypeBase.kind` | - | +| `name` | `string` | - | - | +| `summary?` | `string` | - | `SdkTypeBase.summary` | +| `value` | `string` \| `number` | - | - | +| `valueType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkExampleTypeBase.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkExampleTypeBase.md deleted file mode 100644 index acdd698d99..0000000000 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkExampleTypeBase.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -jsApi: true -title: "[I] SdkExampleTypeBase" - ---- -## Extended by - -- [`SdkStringExample`](SdkStringExample.md) -- [`SdkNumberExample`](SdkNumberExample.md) -- [`SdkBooleanExample`](SdkBooleanExample.md) -- [`SdkNullExample`](SdkNullExample.md) -- [`SdkAnyExample`](SdkAnyExample.md) -- [`SdkArrayExample`](SdkArrayExample.md) -- [`SdkDictionaryExample`](SdkDictionaryExample.md) -- [`SdkUnionExample`](SdkUnionExample.md) -- [`SdkModelExample`](SdkModelExample.md) - -## Properties - -| Property | Type | -| ------ | ------ | -| `kind` | `string` | -| `type` | [`SdkType`](../type-aliases/SdkType.md) | -| `value` | `unknown` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHeaderParameter.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHeaderParameter.md index 91fd3ad70c..bd7632fb2e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHeaderParameter.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHeaderParameter.md @@ -9,24 +9,22 @@ title: "[I] SdkHeaderParameter" ## Properties -| Property | Type | Description | Inherited from | -| ------ | ------ | ------ | ------ | -| `__raw?` | `ModelProperty` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | -| `apiVersions` | `string`[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | -| `clientDefaultValue?` | `any` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | -| `collectionFormat?` | [`CollectionFormat`](../type-aliases/CollectionFormat.md) | - | - | -| `correspondingMethodParams` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md)[] | - | - | -| `crossLanguageDefinitionId` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`details` | -| `doc?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | -| `isApiVersionParam` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | -| `isGeneratedName` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | -| `kind` | `"header"` | - | - | -| `name` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | -| `onClient` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | -| `optional` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | -| `serializedName` | `string` | - | - | -| `summary?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | -| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | +| Property | Type | Inherited from | +| ------ | ------ | ------ | +| `__raw?` | `ModelProperty` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | +| `apiVersions` | `string`[] | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | +| `clientDefaultValue?` | `unknown` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | +| `collectionFormat?` | [`CollectionFormat`](../type-aliases/CollectionFormat.md) | - | +| `correspondingMethodParams` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md)[] | - | +| `crossLanguageDefinitionId` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | +| `doc?` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | +| `isApiVersionParam` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | +| `isGeneratedName` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | +| `kind` | `"header"` | - | +| `name` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | +| `onClient` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | +| `optional` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | +| `serializedName` | `string` | - | +| `summary?` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | +| `type` | [`SdkType`](../type-aliases/SdkType.md) | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpErrorResponse.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpErrorResponse.md new file mode 100644 index 0000000000..a7440d80c4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpErrorResponse.md @@ -0,0 +1,22 @@ +--- +jsApi: true +title: "[I] SdkHttpErrorResponse" + +--- +## Extends + +- `SdkHttpResponseBase` + +## Properties + +| Property | Type | Inherited from | +| ------ | ------ | ------ | +| `__raw` | `HttpOperationResponse` | `SdkHttpResponseBase.__raw` | +| `apiVersions` | `string`[] | `SdkHttpResponseBase.apiVersions` | +| `contentTypes?` | `string`[] | `SdkHttpResponseBase.contentTypes` | +| `defaultContentType?` | `string` | `SdkHttpResponseBase.defaultContentType` | +| `description?` | `string` | `SdkHttpResponseBase.description` | +| `headers` | [`SdkServiceResponseHeader`](SdkServiceResponseHeader.md)[] | `SdkHttpResponseBase.headers` | +| `kind` | `"http"` | `SdkHttpResponseBase.kind` | +| `statusCodes` | `number` \| `"*"` \| `HttpStatusCodeRange` | - | +| `type?` | [`SdkType`](../type-aliases/SdkType.md) | `SdkHttpResponseBase.type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpOperation.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpOperation.md index c790f1caf6..e137e46b8a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpOperation.md @@ -14,10 +14,10 @@ title: "[I] SdkHttpOperation" | `__raw` | `HttpOperation` | | `bodyParam?` | [`SdkBodyParameter`](SdkBodyParameter.md) | | `examples?` | [`SdkHttpOperationExample`](SdkHttpOperationExample.md)[] | -| `exceptions` | `Map`<`number` \| `"*"` \| `HttpStatusCodeRange`, [`SdkHttpResponse`](SdkHttpResponse.md)\> | +| `exceptions` | [`SdkHttpErrorResponse`](SdkHttpErrorResponse.md)[] | | `kind` | `"http"` | | `parameters` | ([`SdkPathParameter`](SdkPathParameter.md) \| [`SdkQueryParameter`](SdkQueryParameter.md) \| [`SdkHeaderParameter`](SdkHeaderParameter.md))[] | | `path` | `string` | -| `responses` | `Map`<`number` \| `HttpStatusCodeRange`, [`SdkHttpResponse`](SdkHttpResponse.md)\> | +| `responses` | [`SdkHttpResponse`](SdkHttpResponse.md)[] | | `uriTemplate` | `string` | | `verb` | `HttpVerb` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpOperationExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpOperationExample.md index 4409c08a19..8b22adfc2b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpOperationExample.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpOperationExample.md @@ -9,12 +9,13 @@ title: "[I] SdkHttpOperationExample" ## Properties -| Property | Type | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | -| `description` | `string` | - | `SdkExampleBase.description` | -| `filePath` | `string` | - | `SdkExampleBase.filePath` | -| `kind` | `"http"` | `SdkExampleBase.kind` | - | -| `name` | `string` | - | `SdkExampleBase.name` | -| `parameters` | [`SdkHttpParameterExample`](SdkHttpParameterExample.md)[] | - | - | -| `rawExample` | `any` | - | `SdkExampleBase.rawExample` | -| `responses` | `Map`<`number`, [`SdkHttpResponseExample`](SdkHttpResponseExample.md)\> | - | - | +| Property | Type | Description | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | ------ | +| ~~`description`~~ | `string` | **Deprecated** Use `doc` instead. | - | `SdkExampleBase.description` | +| `doc` | `string` | - | - | `SdkExampleBase.doc` | +| `filePath` | `string` | - | - | `SdkExampleBase.filePath` | +| `kind` | `"http"` | - | `SdkExampleBase.kind` | - | +| `name` | `string` | - | - | `SdkExampleBase.name` | +| `parameters` | [`SdkHttpParameterExampleValue`](SdkHttpParameterExampleValue.md)[] | - | - | - | +| `rawExample` | `any` | - | - | `SdkExampleBase.rawExample` | +| `responses` | [`SdkHttpResponseExampleValue`](SdkHttpResponseExampleValue.md)[] | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpParameterExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpParameterExampleValue.md similarity index 57% rename from packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpParameterExample.md rename to packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpParameterExampleValue.md index 361d5c602b..2ce1ee468f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpParameterExample.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpParameterExampleValue.md @@ -1,6 +1,6 @@ --- jsApi: true -title: "[I] SdkHttpParameterExample" +title: "[I] SdkHttpParameterExampleValue" --- ## Properties @@ -8,4 +8,4 @@ title: "[I] SdkHttpParameterExample" | Property | Type | | ------ | ------ | | `parameter` | [`SdkHttpParameter`](../type-aliases/SdkHttpParameter.md) | -| `value` | [`SdkTypeExample`](../type-aliases/SdkTypeExample.md) | +| `value` | [`SdkExampleValue`](../type-aliases/SdkExampleValue.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponse.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponse.md index 8a1404c861..413fa5d014 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponse.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponse.md @@ -5,17 +5,18 @@ title: "[I] SdkHttpResponse" --- ## Extends -- [`SdkServiceResponse`](SdkServiceResponse.md) +- `SdkHttpResponseBase` ## Properties | Property | Type | Inherited from | | ------ | ------ | ------ | -| `__raw` | `HttpOperationResponse` | - | -| `apiVersions` | `string`[] | [`SdkServiceResponse`](SdkServiceResponse.md).`apiVersions` | -| `contentTypes?` | `string`[] | - | -| `defaultContentType?` | `string` | - | -| `description?` | `string` | - | -| `headers` | [`SdkServiceResponseHeader`](SdkServiceResponseHeader.md)[] | [`SdkServiceResponse`](SdkServiceResponse.md).`headers` | -| `kind` | `"http"` | - | -| `type?` | [`SdkType`](../type-aliases/SdkType.md) | [`SdkServiceResponse`](SdkServiceResponse.md).`type` | +| `__raw` | `HttpOperationResponse` | `SdkHttpResponseBase.__raw` | +| `apiVersions` | `string`[] | `SdkHttpResponseBase.apiVersions` | +| `contentTypes?` | `string`[] | `SdkHttpResponseBase.contentTypes` | +| `defaultContentType?` | `string` | `SdkHttpResponseBase.defaultContentType` | +| `description?` | `string` | `SdkHttpResponseBase.description` | +| `headers` | [`SdkServiceResponseHeader`](SdkServiceResponseHeader.md)[] | `SdkHttpResponseBase.headers` | +| `kind` | `"http"` | `SdkHttpResponseBase.kind` | +| `statusCodes` | `number` \| `HttpStatusCodeRange` | - | +| `type?` | [`SdkType`](../type-aliases/SdkType.md) | `SdkHttpResponseBase.type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponseExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponseExample.md deleted file mode 100644 index 09e77b0b68..0000000000 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponseExample.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -jsApi: true -title: "[I] SdkHttpResponseExample" - ---- -## Properties - -| Property | Type | -| ------ | ------ | -| `bodyValue?` | [`SdkTypeExample`](../type-aliases/SdkTypeExample.md) | -| `headers` | [`SdkHttpResponseHeaderExample`](SdkHttpResponseHeaderExample.md)[] | -| `response` | [`SdkHttpResponse`](SdkHttpResponse.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponseExampleValue.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponseExampleValue.md new file mode 100644 index 0000000000..bd04fed5ad --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponseExampleValue.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[I] SdkHttpResponseExampleValue" + +--- +## Properties + +| Property | Type | +| ------ | ------ | +| `bodyValue?` | [`SdkExampleValue`](../type-aliases/SdkExampleValue.md) | +| `headers` | [`SdkHttpResponseHeaderExampleValue`](SdkHttpResponseHeaderExampleValue.md)[] | +| `response` | [`SdkHttpResponse`](SdkHttpResponse.md) | +| `statusCode` | `number` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponseHeaderExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponseHeaderExampleValue.md similarity index 56% rename from packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponseHeaderExample.md rename to packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponseHeaderExampleValue.md index d285394c37..e8d4cf6ce9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponseHeaderExample.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkHttpResponseHeaderExampleValue.md @@ -1,6 +1,6 @@ --- jsApi: true -title: "[I] SdkHttpResponseHeaderExample" +title: "[I] SdkHttpResponseHeaderExampleValue" --- ## Properties @@ -8,4 +8,4 @@ title: "[I] SdkHttpResponseHeaderExample" | Property | Type | | ------ | ------ | | `header` | [`SdkServiceResponseHeader`](SdkServiceResponseHeader.md) | -| `value` | [`SdkTypeExample`](../type-aliases/SdkTypeExample.md) | +| `value` | [`SdkExampleValue`](../type-aliases/SdkExampleValue.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkInitializationType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkInitializationType.md index c202cdfe59..4e4acd0133 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkInitializationType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkInitializationType.md @@ -9,26 +9,24 @@ title: "[I] SdkInitializationType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | [`SdkModelType`](SdkModelType.md).`__accessSet` | -| `__raw?` | `Type` | - | - | [`SdkModelType`](SdkModelType.md).`__raw` | -| `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | - | - | [`SdkModelType`](SdkModelType.md).`access` | -| `additionalProperties?` | [`SdkType`](../type-aliases/SdkType.md) | - | - | [`SdkModelType`](SdkModelType.md).`additionalProperties` | -| `apiVersions` | `string`[] | - | - | [`SdkModelType`](SdkModelType.md).`apiVersions` | -| `baseModel?` | [`SdkModelType`](SdkModelType.md) | - | - | [`SdkModelType`](SdkModelType.md).`baseModel` | -| `crossLanguageDefinitionId` | `string` | - | - | [`SdkModelType`](SdkModelType.md).`crossLanguageDefinitionId` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | [`SdkModelType`](SdkModelType.md).`decorators` | -| `deprecation?` | `string` | - | - | [`SdkModelType`](SdkModelType.md).`deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | [`SdkModelType`](SdkModelType.md).`description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | [`SdkModelType`](SdkModelType.md).`details` | -| `discriminatedSubtypes?` | `Record`<`string`, [`SdkModelType`](SdkModelType.md)\> | - | - | [`SdkModelType`](SdkModelType.md).`discriminatedSubtypes` | -| `discriminatorProperty?` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md) | - | - | [`SdkModelType`](SdkModelType.md).`discriminatorProperty` | -| `discriminatorValue?` | `string` | - | - | [`SdkModelType`](SdkModelType.md).`discriminatorValue` | -| `doc?` | `string` | - | - | [`SdkModelType`](SdkModelType.md).`doc` | -| `isGeneratedName` | `boolean` | - | - | [`SdkModelType`](SdkModelType.md).`isGeneratedName` | -| `kind` | `"model"` | - | - | [`SdkModelType`](SdkModelType.md).`kind` | -| `name` | `string` | - | - | [`SdkModelType`](SdkModelType.md).`name` | -| `properties` | [`SdkParameter`](../type-aliases/SdkParameter.md)[] | - | [`SdkModelType`](SdkModelType.md).`properties` | - | -| `summary?` | `string` | - | - | [`SdkModelType`](SdkModelType.md).`summary` | -| `usage` | [`UsageFlags`](../enumerations/UsageFlags.md) | - | - | [`SdkModelType`](SdkModelType.md).`usage` | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | [`SdkModelType`](SdkModelType.md).`__accessSet` | +| `__raw?` | `Type` | - | [`SdkModelType`](SdkModelType.md).`__raw` | +| `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | - | [`SdkModelType`](SdkModelType.md).`access` | +| `additionalProperties?` | [`SdkType`](../type-aliases/SdkType.md) | - | [`SdkModelType`](SdkModelType.md).`additionalProperties` | +| `apiVersions` | `string`[] | - | [`SdkModelType`](SdkModelType.md).`apiVersions` | +| `baseModel?` | [`SdkModelType`](SdkModelType.md) | - | [`SdkModelType`](SdkModelType.md).`baseModel` | +| `crossLanguageDefinitionId` | `string` | - | [`SdkModelType`](SdkModelType.md).`crossLanguageDefinitionId` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | [`SdkModelType`](SdkModelType.md).`decorators` | +| `deprecation?` | `string` | - | [`SdkModelType`](SdkModelType.md).`deprecation` | +| `discriminatedSubtypes?` | `Record`<`string`, [`SdkModelType`](SdkModelType.md)\> | - | [`SdkModelType`](SdkModelType.md).`discriminatedSubtypes` | +| `discriminatorProperty?` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md) | - | [`SdkModelType`](SdkModelType.md).`discriminatorProperty` | +| `discriminatorValue?` | `string` | - | [`SdkModelType`](SdkModelType.md).`discriminatorValue` | +| `doc?` | `string` | - | [`SdkModelType`](SdkModelType.md).`doc` | +| `isGeneratedName` | `boolean` | - | [`SdkModelType`](SdkModelType.md).`isGeneratedName` | +| `kind` | `"model"` | - | [`SdkModelType`](SdkModelType.md).`kind` | +| `name` | `string` | - | [`SdkModelType`](SdkModelType.md).`name` | +| `properties` | [`SdkParameter`](../type-aliases/SdkParameter.md)[] | [`SdkModelType`](SdkModelType.md).`properties` | - | +| `summary?` | `string` | - | [`SdkModelType`](SdkModelType.md).`summary` | +| `usage` | [`UsageFlags`](../enumerations/UsageFlags.md) | - | [`SdkModelType`](SdkModelType.md).`usage` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroPagingServiceMethod.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroPagingServiceMethod.md index 774c10a13d..2a1fb58acd 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroPagingServiceMethod.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroPagingServiceMethod.md @@ -18,19 +18,18 @@ title: "[I] SdkLroPagingServiceMethod" | Property | Type | Description | Inherited from | | ------ | ------ | ------ | ------ | | `__raw?` | `Operation` | - | `SdkServiceMethodBase.__raw` | -| `__raw_lro_metadata` | `LroMetadata` | - | `SdkLroServiceMethodOptions.__raw_lro_metadata` | +| ~~`__raw_lro_metadata`~~ | `LroMetadata` | **Deprecated** This property will be removed in future releases. Use `lroMetadata` for synthesized LRO metadata. If you still want to access primitive LRO info, use `lroMetadata.__raw`. | `SdkLroServiceMethodOptions.__raw_lro_metadata` | | `__raw_paged_metadata` | `PagedResultMetadata` | - | `SdkPagingServiceMethodOptions.__raw_paged_metadata` | | `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | - | `SdkServiceMethodBase.access` | | `apiVersions` | `string`[] | - | `SdkServiceMethodBase.apiVersions` | | `crossLanguageDefintionId` | `string` | - | `SdkServiceMethodBase.crossLanguageDefintionId` | | `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkServiceMethodBase.decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | `SdkServiceMethodBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | `SdkServiceMethodBase.details` | | `doc?` | `string` | - | `SdkServiceMethodBase.doc` | | `exception?` | [`SdkMethodResponse`](SdkMethodResponse.md) | - | `SdkServiceMethodBase.exception` | | `generateConvenient` | `boolean` | - | `SdkServiceMethodBase.generateConvenient` | | `generateProtocol` | `boolean` | - | `SdkServiceMethodBase.generateProtocol` | | `kind` | `"lropaging"` | - | - | +| `lroMetadata` | [`SdkLroServiceMetadata`](SdkLroServiceMetadata.md) | - | `SdkLroServiceMethodOptions.lroMetadata` | | `name` | `string` | - | `SdkServiceMethodBase.name` | | `nextLinkOperation?` | [`SdkHttpOperation`](SdkHttpOperation.md) | - | `SdkPagingServiceMethodOptions.nextLinkOperation` | | `nextLinkPath?` | `string` | - | `SdkPagingServiceMethodOptions.nextLinkPath` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServiceFinalResponse.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServiceFinalResponse.md new file mode 100644 index 0000000000..09fd76b1ec --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServiceFinalResponse.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[I] SdkLroServiceFinalResponse" + +--- +Synthesized long running operation response metadata. + +## Properties + +| Property | Type | Description | +| ------ | ------ | ------ | +| `envelopeResult` | [`SdkModelType`](SdkModelType.md) | Intact response type | +| `result` | [`SdkModelType`](SdkModelType.md) | Meaningful result type | +| `resultPath?` | `string` | Property path to fetch {result} from {envelopeResult}. Note that this property is available only in some LRO patterns. | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServiceFinalStep.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServiceFinalStep.md new file mode 100644 index 0000000000..708eeeeecf --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServiceFinalStep.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] SdkLroServiceFinalStep" + +--- +Long running operation final step metadata. + +## Properties + +| Property | Type | Description | +| ------ | ------ | ------ | +| `kind` | `"finalOperationLink"` \| `"finalOperationReference"` \| `"pollingSuccessProperty"` \| `"noPollingResult"` | Final step kind | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServiceMetadata.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServiceMetadata.md new file mode 100644 index 0000000000..f1ff10a270 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServiceMetadata.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] SdkLroServiceMetadata" + +--- +Long running operation metadata. + +## Properties + +| Property | Type | Description | +| ------ | ------ | ------ | +| `__raw` | `LroMetadata` | LRO metadata from TypeSpec core library | +| `finalResponse?` | [`SdkLroServiceFinalResponse`](SdkLroServiceFinalResponse.md) | Synthesized final response metadata | +| `finalStateVia` | `FinalStateValue` | Legacy `finalStateVia` value | +| `finalStep?` | [`SdkLroServiceFinalStep`](SdkLroServiceFinalStep.md) | Final step metadata | +| `pollingStep` | [`SdkLroServicePollingStep`](SdkLroServicePollingStep.md) | Polling step metadata | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServiceMethod.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServiceMethod.md index e37e211753..18ebdec636 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServiceMethod.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServiceMethod.md @@ -18,18 +18,17 @@ title: "[I] SdkLroServiceMethod" | Property | Type | Description | Inherited from | | ------ | ------ | ------ | ------ | | `__raw?` | `Operation` | - | `SdkServiceMethodBase.__raw` | -| `__raw_lro_metadata` | `LroMetadata` | - | `SdkLroServiceMethodOptions.__raw_lro_metadata` | +| ~~`__raw_lro_metadata`~~ | `LroMetadata` | **Deprecated** This property will be removed in future releases. Use `lroMetadata` for synthesized LRO metadata. If you still want to access primitive LRO info, use `lroMetadata.__raw`. | `SdkLroServiceMethodOptions.__raw_lro_metadata` | | `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | - | `SdkServiceMethodBase.access` | | `apiVersions` | `string`[] | - | `SdkServiceMethodBase.apiVersions` | | `crossLanguageDefintionId` | `string` | - | `SdkServiceMethodBase.crossLanguageDefintionId` | | `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkServiceMethodBase.decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | `SdkServiceMethodBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | `SdkServiceMethodBase.details` | | `doc?` | `string` | - | `SdkServiceMethodBase.doc` | | `exception?` | [`SdkMethodResponse`](SdkMethodResponse.md) | - | `SdkServiceMethodBase.exception` | | `generateConvenient` | `boolean` | - | `SdkServiceMethodBase.generateConvenient` | | `generateProtocol` | `boolean` | - | `SdkServiceMethodBase.generateProtocol` | | `kind` | `"lro"` | - | - | +| `lroMetadata` | [`SdkLroServiceMetadata`](SdkLroServiceMetadata.md) | - | `SdkLroServiceMethodOptions.lroMetadata` | | `name` | `string` | - | `SdkServiceMethodBase.name` | | `operation` | `TServiceOperation` | - | `SdkServiceMethodBase.operation` | | `parameters` | [`SdkMethodParameter`](SdkMethodParameter.md)[] | - | `SdkServiceMethodBase.parameters` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServicePollingStep.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServicePollingStep.md new file mode 100644 index 0000000000..063dd86552 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkLroServicePollingStep.md @@ -0,0 +1,12 @@ +--- +jsApi: true +title: "[I] SdkLroServicePollingStep" + +--- +Long running operation polling step metadata. + +## Properties + +| Property | Type | Description | +| ------ | ------ | ------ | +| `responseBody?` | [`SdkModelType`](SdkModelType.md) | Response body type | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkMethodParameter.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkMethodParameter.md index 63bfb3c9e2..d69a7cce01 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkMethodParameter.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkMethodParameter.md @@ -9,21 +9,19 @@ title: "[I] SdkMethodParameter" ## Properties -| Property | Type | Description | Inherited from | -| ------ | ------ | ------ | ------ | -| `__raw?` | `ModelProperty` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | -| `apiVersions` | `string`[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | -| `clientDefaultValue?` | `any` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | -| `crossLanguageDefinitionId` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`details` | -| `doc?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | -| `isApiVersionParam` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | -| `isGeneratedName` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | -| `kind` | `"method"` | - | - | -| `name` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | -| `onClient` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | -| `optional` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | -| `summary?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | -| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | +| Property | Type | Inherited from | +| ------ | ------ | ------ | +| `__raw?` | `ModelProperty` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | +| `apiVersions` | `string`[] | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | +| `clientDefaultValue?` | `unknown` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | +| `crossLanguageDefinitionId` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | +| `doc?` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | +| `isApiVersionParam` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | +| `isGeneratedName` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | +| `kind` | `"method"` | - | +| `name` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | +| `onClient` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | +| `optional` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | +| `summary?` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | +| `type` | [`SdkType`](../type-aliases/SdkType.md) | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelExample.md deleted file mode 100644 index 6c6712f86d..0000000000 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelExample.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -jsApi: true -title: "[I] SdkModelExample" - ---- -## Extends - -- [`SdkExampleTypeBase`](SdkExampleTypeBase.md) - -## Properties - -| Property | Type | Overrides | -| ------ | ------ | ------ | -| `additionalPropertiesValue?` | `Record`<`string`, [`SdkTypeExample`](../type-aliases/SdkTypeExample.md)\> | - | -| `kind` | `"model"` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`kind` | -| `type` | [`SdkModelType`](SdkModelType.md) | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`type` | -| `value` | `Record`<`string`, [`SdkTypeExample`](../type-aliases/SdkTypeExample.md)\> | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelExampleValue.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelExampleValue.md new file mode 100644 index 0000000000..b04bd6e88e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelExampleValue.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[I] SdkModelExampleValue" + +--- +## Extends + +- `SdkExampleValueBase` + +## Properties + +| Property | Type | Overrides | +| ------ | ------ | ------ | +| `additionalPropertiesValue?` | `Record`<`string`, [`SdkExampleValue`](../type-aliases/SdkExampleValue.md)\> | - | +| `kind` | `"model"` | `SdkExampleValueBase.kind` | +| `type` | [`SdkModelType`](SdkModelType.md) | `SdkExampleValueBase.type` | +| `value` | `Record`<`string`, [`SdkExampleValue`](../type-aliases/SdkExampleValue.md)\> | `SdkExampleValueBase.value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelPropertyTypeBase.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelPropertyTypeBase.md index b4c4c78e75..e5ab2b7493 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelPropertyTypeBase.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelPropertyTypeBase.md @@ -20,20 +20,18 @@ title: "[I] SdkModelPropertyTypeBase" ## Properties -| Property | Type | Description | Inherited from | -| ------ | ------ | ------ | ------ | -| `__raw?` | `ModelProperty` | - | - | -| `apiVersions` | `string`[] | - | - | -| `clientDefaultValue?` | `any` | - | - | -| `crossLanguageDefinitionId` | `string` | - | - | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `DecoratedType.decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | -| `doc?` | `string` | - | - | -| `isApiVersionParam` | `boolean` | - | - | -| `isGeneratedName` | `boolean` | - | - | -| `name` | `string` | - | - | -| `onClient` | `boolean` | - | - | -| `optional` | `boolean` | - | - | -| `summary?` | `string` | - | - | -| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | - | +| Property | Type | Inherited from | +| ------ | ------ | ------ | +| `__raw?` | `ModelProperty` | - | +| `apiVersions` | `string`[] | - | +| `clientDefaultValue?` | `unknown` | - | +| `crossLanguageDefinitionId` | `string` | - | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | `DecoratedType.decorators` | +| `doc?` | `string` | - | +| `isApiVersionParam` | `boolean` | - | +| `isGeneratedName` | `boolean` | - | +| `name` | `string` | - | +| `onClient` | `boolean` | - | +| `optional` | `boolean` | - | +| `summary?` | `string` | - | +| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelType.md index 5b35e678d5..84c81a14c1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelType.md @@ -13,26 +13,24 @@ title: "[I] SdkModelType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | `SdkTypeBase.__accessSet` | -| `__raw?` | `Type` | - | - | `SdkTypeBase.__raw` | -| `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | - | - | - | -| `additionalProperties?` | [`SdkType`](../type-aliases/SdkType.md) | - | - | - | -| `apiVersions` | `string`[] | - | - | - | -| `baseModel?` | [`SdkModelType`](SdkModelType.md) | - | - | - | -| `crossLanguageDefinitionId` | `string` | - | - | - | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | `SdkTypeBase.decorators` | -| `deprecation?` | `string` | - | - | `SdkTypeBase.deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.details` | -| `discriminatedSubtypes?` | `Record`<`string`, [`SdkModelType`](SdkModelType.md)\> | - | - | - | -| `discriminatorProperty?` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md) | - | - | - | -| `discriminatorValue?` | `string` | - | - | - | -| `doc?` | `string` | - | - | `SdkTypeBase.doc` | -| `isGeneratedName` | `boolean` | - | - | - | -| `kind` | `"model"` | - | `SdkTypeBase.kind` | - | -| `name` | `string` | - | - | - | -| `properties` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md)[] | - | - | - | -| `summary?` | `string` | - | - | `SdkTypeBase.summary` | -| `usage` | [`UsageFlags`](../enumerations/UsageFlags.md) | - | - | - | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | `SdkTypeBase.__accessSet` | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | - | - | +| `additionalProperties?` | [`SdkType`](../type-aliases/SdkType.md) | - | - | +| `apiVersions` | `string`[] | - | - | +| `baseModel?` | [`SdkModelType`](SdkModelType.md) | - | - | +| `crossLanguageDefinitionId` | `string` | - | - | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkTypeBase.decorators` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `discriminatedSubtypes?` | `Record`<`string`, [`SdkModelType`](SdkModelType.md)\> | - | - | +| `discriminatorProperty?` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md) | - | - | +| `discriminatorValue?` | `string` | - | - | +| `doc?` | `string` | - | `SdkTypeBase.doc` | +| `isGeneratedName` | `boolean` | - | - | +| `kind` | `"model"` | `SdkTypeBase.kind` | - | +| `name` | `string` | - | - | +| `properties` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md)[] | - | - | +| `summary?` | `string` | - | `SdkTypeBase.summary` | +| `usage` | [`UsageFlags`](../enumerations/UsageFlags.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNullExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNullExample.md deleted file mode 100644 index 9c7602f391..0000000000 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNullExample.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] SdkNullExample" - ---- -## Extends - -- [`SdkExampleTypeBase`](SdkExampleTypeBase.md) - -## Properties - -| Property | Type | Overrides | -| ------ | ------ | ------ | -| `kind` | `"null"` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`kind` | -| `type` | [`SdkNullableType`](SdkNullableType.md) | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`type` | -| `value` | `null` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNullExampleValue.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNullExampleValue.md new file mode 100644 index 0000000000..b607b7ddf1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNullExampleValue.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] SdkNullExampleValue" + +--- +## Extends + +- `SdkExampleValueBase` + +## Properties + +| Property | Type | Overrides | +| ------ | ------ | ------ | +| `kind` | `"null"` | `SdkExampleValueBase.kind` | +| `type` | [`SdkNullableType`](SdkNullableType.md) | `SdkExampleValueBase.type` | +| `value` | `null` | `SdkExampleValueBase.value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNullableType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNullableType.md index f5cb634731..16eb073299 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNullableType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNullableType.md @@ -9,15 +9,13 @@ title: "[I] SdkNullableType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | `SdkTypeBase.__accessSet` | -| `__raw?` | `Type` | - | - | `SdkTypeBase.__raw` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | `SdkTypeBase.decorators` | -| `deprecation?` | `string` | - | - | `SdkTypeBase.deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.details` | -| `doc?` | `string` | - | - | `SdkTypeBase.doc` | -| `kind` | `"nullable"` | - | `SdkTypeBase.kind` | - | -| `summary?` | `string` | - | - | `SdkTypeBase.summary` | -| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | - | - | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | `SdkTypeBase.__accessSet` | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkTypeBase.decorators` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `doc?` | `string` | - | `SdkTypeBase.doc` | +| `kind` | `"nullable"` | `SdkTypeBase.kind` | - | +| `summary?` | `string` | - | `SdkTypeBase.summary` | +| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNumberExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNumberExampleValue.md similarity index 53% rename from packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNumberExample.md rename to packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNumberExampleValue.md index e274d5e89a..5903cc26a7 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNumberExample.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkNumberExampleValue.md @@ -1,16 +1,16 @@ --- jsApi: true -title: "[I] SdkNumberExample" +title: "[I] SdkNumberExampleValue" --- ## Extends -- [`SdkExampleTypeBase`](SdkExampleTypeBase.md) +- `SdkExampleValueBase` ## Properties | Property | Type | Overrides | | ------ | ------ | ------ | -| `kind` | `"number"` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`kind` | -| `type` | \| [`SdkBuiltInType`](SdkBuiltInType.md) \| [`SdkDateTimeType`](../type-aliases/SdkDateTimeType.md) \| [`SdkDurationType`](SdkDurationType.md) \| [`SdkEnumType`](SdkEnumType.md) \| [`SdkEnumValueType`](SdkEnumValueType.md) \| [`SdkConstantType`](SdkConstantType.md) | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`type` | -| `value` | `number` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`value` | +| `kind` | `"number"` | `SdkExampleValueBase.kind` | +| `type` | \| [`SdkBuiltInType`](SdkBuiltInType.md) \| [`SdkDateTimeType`](../type-aliases/SdkDateTimeType.md) \| [`SdkDurationType`](SdkDurationType.md) \| [`SdkEnumType`](SdkEnumType.md) \| [`SdkEnumValueType`](SdkEnumValueType.md) \| [`SdkConstantType`](SdkConstantType.md) | `SdkExampleValueBase.type` | +| `value` | `number` | `SdkExampleValueBase.value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkPagingServiceMethod.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkPagingServiceMethod.md index e44bf4140c..89d683711e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkPagingServiceMethod.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkPagingServiceMethod.md @@ -15,25 +15,23 @@ title: "[I] SdkPagingServiceMethod" ## Properties -| Property | Type | Description | Inherited from | -| ------ | ------ | ------ | ------ | -| `__raw?` | `Operation` | - | `SdkServiceMethodBase.__raw` | -| `__raw_paged_metadata` | `PagedResultMetadata` | - | `SdkPagingServiceMethodOptions.__raw_paged_metadata` | -| `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | - | `SdkServiceMethodBase.access` | -| `apiVersions` | `string`[] | - | `SdkServiceMethodBase.apiVersions` | -| `crossLanguageDefintionId` | `string` | - | `SdkServiceMethodBase.crossLanguageDefintionId` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkServiceMethodBase.decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | `SdkServiceMethodBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | `SdkServiceMethodBase.details` | -| `doc?` | `string` | - | `SdkServiceMethodBase.doc` | -| `exception?` | [`SdkMethodResponse`](SdkMethodResponse.md) | - | `SdkServiceMethodBase.exception` | -| `generateConvenient` | `boolean` | - | `SdkServiceMethodBase.generateConvenient` | -| `generateProtocol` | `boolean` | - | `SdkServiceMethodBase.generateProtocol` | -| `kind` | `"paging"` | - | - | -| `name` | `string` | - | `SdkServiceMethodBase.name` | -| `nextLinkOperation?` | [`SdkHttpOperation`](SdkHttpOperation.md) | - | `SdkPagingServiceMethodOptions.nextLinkOperation` | -| `nextLinkPath?` | `string` | - | `SdkPagingServiceMethodOptions.nextLinkPath` | -| `operation` | `TServiceOperation` | - | `SdkServiceMethodBase.operation` | -| `parameters` | [`SdkMethodParameter`](SdkMethodParameter.md)[] | - | `SdkServiceMethodBase.parameters` | -| `response` | [`SdkMethodResponse`](SdkMethodResponse.md) | - | `SdkServiceMethodBase.response` | -| `summary?` | `string` | - | `SdkServiceMethodBase.summary` | +| Property | Type | Inherited from | +| ------ | ------ | ------ | +| `__raw?` | `Operation` | `SdkServiceMethodBase.__raw` | +| `__raw_paged_metadata` | `PagedResultMetadata` | `SdkPagingServiceMethodOptions.__raw_paged_metadata` | +| `access` | [`AccessFlags`](../type-aliases/AccessFlags.md) | `SdkServiceMethodBase.access` | +| `apiVersions` | `string`[] | `SdkServiceMethodBase.apiVersions` | +| `crossLanguageDefintionId` | `string` | `SdkServiceMethodBase.crossLanguageDefintionId` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | `SdkServiceMethodBase.decorators` | +| `doc?` | `string` | `SdkServiceMethodBase.doc` | +| `exception?` | [`SdkMethodResponse`](SdkMethodResponse.md) | `SdkServiceMethodBase.exception` | +| `generateConvenient` | `boolean` | `SdkServiceMethodBase.generateConvenient` | +| `generateProtocol` | `boolean` | `SdkServiceMethodBase.generateProtocol` | +| `kind` | `"paging"` | - | +| `name` | `string` | `SdkServiceMethodBase.name` | +| `nextLinkOperation?` | [`SdkHttpOperation`](SdkHttpOperation.md) | `SdkPagingServiceMethodOptions.nextLinkOperation` | +| `nextLinkPath?` | `string` | `SdkPagingServiceMethodOptions.nextLinkPath` | +| `operation` | `TServiceOperation` | `SdkServiceMethodBase.operation` | +| `parameters` | [`SdkMethodParameter`](SdkMethodParameter.md)[] | `SdkServiceMethodBase.parameters` | +| `response` | [`SdkMethodResponse`](SdkMethodResponse.md) | `SdkServiceMethodBase.response` | +| `summary?` | `string` | `SdkServiceMethodBase.summary` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkPathParameter.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkPathParameter.md index b91d1275d4..357e08e03e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkPathParameter.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkPathParameter.md @@ -14,12 +14,10 @@ title: "[I] SdkPathParameter" | `__raw?` | `ModelProperty` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | | `allowReserved` | `boolean` | - | - | - | | `apiVersions` | `string`[] | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | -| `clientDefaultValue?` | `any` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | +| `clientDefaultValue?` | `unknown` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | | `correspondingMethodParams` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md)[] | - | - | - | | `crossLanguageDefinitionId` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | | `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`details` | | `doc?` | `string` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | | `explode` | `boolean` | - | - | - | | `isApiVersionParam` | `boolean` | - | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkQueryParameter.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkQueryParameter.md index 4f51d0f77f..c2cebccafb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkQueryParameter.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkQueryParameter.md @@ -9,25 +9,23 @@ title: "[I] SdkQueryParameter" ## Properties -| Property | Type | Description | Inherited from | -| ------ | ------ | ------ | ------ | -| `__raw?` | `ModelProperty` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | -| `apiVersions` | `string`[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | -| `clientDefaultValue?` | `any` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | -| `collectionFormat?` | [`CollectionFormat`](../type-aliases/CollectionFormat.md) | - | - | -| `correspondingMethodParams` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md)[] | - | - | -| `crossLanguageDefinitionId` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`details` | -| `doc?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | -| `explode` | `boolean` | - | - | -| `isApiVersionParam` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | -| `isGeneratedName` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | -| `kind` | `"query"` | - | - | -| `name` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | -| `onClient` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | -| `optional` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | -| `serializedName` | `string` | - | - | -| `summary?` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | -| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | +| Property | Type | Inherited from | +| ------ | ------ | ------ | +| `__raw?` | `ModelProperty` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | +| `apiVersions` | `string`[] | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | +| `clientDefaultValue?` | `unknown` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`clientDefaultValue` | +| `collectionFormat?` | [`CollectionFormat`](../type-aliases/CollectionFormat.md) | - | +| `correspondingMethodParams` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md)[] | - | +| `crossLanguageDefinitionId` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`crossLanguageDefinitionId` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`decorators` | +| `doc?` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`doc` | +| `explode` | `boolean` | - | +| `isApiVersionParam` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isApiVersionParam` | +| `isGeneratedName` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`isGeneratedName` | +| `kind` | `"query"` | - | +| `name` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`name` | +| `onClient` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`onClient` | +| `optional` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | +| `serializedName` | `string` | - | +| `summary?` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`summary` | +| `type` | [`SdkType`](../type-aliases/SdkType.md) | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkServiceResponse.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkServiceResponse.md index ff9febabff..ab57f92915 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkServiceResponse.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkServiceResponse.md @@ -3,10 +3,6 @@ jsApi: true title: "[I] SdkServiceResponse" --- -## Extended by - -- [`SdkHttpResponse`](SdkHttpResponse.md) - ## Properties | Property | Type | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkServiceResponseHeader.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkServiceResponseHeader.md index ed231c1ae4..90e112d5ac 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkServiceResponseHeader.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkServiceResponseHeader.md @@ -5,12 +5,10 @@ title: "[I] SdkServiceResponseHeader" --- ## Properties -| Property | Type | Description | -| ------ | ------ | ------ | -| `__raw` | `ModelProperty` | - | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | -| `doc?` | `string` | - | -| `serializedName` | `string` | - | -| `summary?` | `string` | - | -| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | +| Property | Type | +| ------ | ------ | +| `__raw` | `ModelProperty` | +| `doc?` | `string` | +| `serializedName` | `string` | +| `summary?` | `string` | +| `type` | [`SdkType`](../type-aliases/SdkType.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkStringExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkStringExampleValue.md similarity index 53% rename from packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkStringExample.md rename to packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkStringExampleValue.md index 2ca585eeee..576e481b87 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkStringExample.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkStringExampleValue.md @@ -1,16 +1,16 @@ --- jsApi: true -title: "[I] SdkStringExample" +title: "[I] SdkStringExampleValue" --- ## Extends -- [`SdkExampleTypeBase`](SdkExampleTypeBase.md) +- `SdkExampleValueBase` ## Properties | Property | Type | Overrides | | ------ | ------ | ------ | -| `kind` | `"string"` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`kind` | -| `type` | \| [`SdkBuiltInType`](SdkBuiltInType.md) \| [`SdkDateTimeType`](../type-aliases/SdkDateTimeType.md) \| [`SdkDurationType`](SdkDurationType.md) \| [`SdkEnumType`](SdkEnumType.md) \| [`SdkEnumValueType`](SdkEnumValueType.md) \| [`SdkConstantType`](SdkConstantType.md) | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`type` | -| `value` | `string` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`value` | +| `kind` | `"string"` | `SdkExampleValueBase.kind` | +| `type` | \| [`SdkBuiltInType`](SdkBuiltInType.md) \| [`SdkDateTimeType`](../type-aliases/SdkDateTimeType.md) \| [`SdkDurationType`](SdkDurationType.md) \| [`SdkEnumType`](SdkEnumType.md) \| [`SdkEnumValueType`](SdkEnumValueType.md) \| [`SdkConstantType`](SdkConstantType.md) | `SdkExampleValueBase.type` | +| `value` | `string` | `SdkExampleValueBase.value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkTupleType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkTupleType.md index 54cc9c1f02..9d4dea3069 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkTupleType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkTupleType.md @@ -9,15 +9,13 @@ title: "[I] SdkTupleType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | `SdkTypeBase.__accessSet` | -| `__raw?` | `Type` | - | - | `SdkTypeBase.__raw` | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | `SdkTypeBase.decorators` | -| `deprecation?` | `string` | - | - | `SdkTypeBase.deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.details` | -| `doc?` | `string` | - | - | `SdkTypeBase.doc` | -| `kind` | `"tuple"` | - | `SdkTypeBase.kind` | - | -| `summary?` | `string` | - | - | `SdkTypeBase.summary` | -| `values` | [`SdkType`](../type-aliases/SdkType.md)[] | - | - | - | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | `SdkTypeBase.__accessSet` | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkTypeBase.decorators` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `doc?` | `string` | - | `SdkTypeBase.doc` | +| `kind` | `"tuple"` | `SdkTypeBase.kind` | - | +| `summary?` | `string` | - | `SdkTypeBase.summary` | +| `valueTypes` | [`SdkType`](../type-aliases/SdkType.md)[] | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionExample.md deleted file mode 100644 index 7d4f1a2f59..0000000000 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionExample.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -jsApi: true -title: "[I] SdkUnionExample" - ---- -## Extends - -- [`SdkExampleTypeBase`](SdkExampleTypeBase.md) - -## Properties - -| Property | Type | Overrides | -| ------ | ------ | ------ | -| `kind` | `"union"` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`kind` | -| `type` | [`SdkUnionType`](SdkUnionType.md)<[`SdkType`](../type-aliases/SdkType.md)\> | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`type` | -| `value` | `unknown` | [`SdkExampleTypeBase`](SdkExampleTypeBase.md).`value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionExampleValue.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionExampleValue.md new file mode 100644 index 0000000000..e3bb962591 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionExampleValue.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] SdkUnionExampleValue" + +--- +## Extends + +- `SdkExampleValueBase` + +## Properties + +| Property | Type | Overrides | +| ------ | ------ | ------ | +| `kind` | `"union"` | `SdkExampleValueBase.kind` | +| `type` | [`SdkUnionType`](SdkUnionType.md)<[`SdkType`](../type-aliases/SdkType.md)\> | `SdkExampleValueBase.type` | +| `value` | `unknown` | `SdkExampleValueBase.value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionType.md index 826e0f450f..8e41df82c5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionType.md @@ -15,18 +15,16 @@ title: "[I] SdkUnionType" ## Properties -| Property | Type | Description | Overrides | Inherited from | -| ------ | ------ | ------ | ------ | ------ | -| `__accessSet?` | `boolean` | - | - | `SdkTypeBase.__accessSet` | -| `__raw?` | `Type` | - | - | `SdkTypeBase.__raw` | -| `crossLanguageDefinitionId` | `string` | - | - | - | -| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | - | `SdkTypeBase.decorators` | -| `deprecation?` | `string` | - | - | `SdkTypeBase.deprecation` | -| ~~`description?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.description` | -| ~~`details?`~~ | `string` | **Deprecated** Use `doc` and `summary` instead. | - | `SdkTypeBase.details` | -| `doc?` | `string` | - | - | `SdkTypeBase.doc` | -| `isGeneratedName` | `boolean` | - | - | - | -| `kind` | `"union"` | - | `SdkTypeBase.kind` | - | -| `name` | `string` | - | - | - | -| `summary?` | `string` | - | - | `SdkTypeBase.summary` | -| `values` | `TValueType`[] | - | - | - | +| Property | Type | Overrides | Inherited from | +| ------ | ------ | ------ | ------ | +| `__accessSet?` | `boolean` | - | `SdkTypeBase.__accessSet` | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `crossLanguageDefinitionId` | `string` | - | - | +| `decorators` | [`DecoratorInfo`](DecoratorInfo.md)[] | - | `SdkTypeBase.decorators` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `doc?` | `string` | - | `SdkTypeBase.doc` | +| `isGeneratedName` | `boolean` | - | - | +| `kind` | `"union"` | `SdkTypeBase.kind` | - | +| `name` | `string` | - | - | +| `summary?` | `string` | - | `SdkTypeBase.summary` | +| `variantTypes` | `TValueType`[] | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnknownExampleValue.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnknownExampleValue.md new file mode 100644 index 0000000000..78e1a46dba --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnknownExampleValue.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[I] SdkUnknownExampleValue" + +--- +## Extends + +- `SdkExampleValueBase` + +## Properties + +| Property | Type | Overrides | +| ------ | ------ | ------ | +| `kind` | `"unknown"` | `SdkExampleValueBase.kind` | +| `type` | [`SdkBuiltInType`](SdkBuiltInType.md) | `SdkExampleValueBase.type` | +| `value` | `unknown` | `SdkExampleValueBase.value` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/TCGCContext.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/TCGCContext.md index db5a33c166..235c39ba8b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/TCGCContext.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/TCGCContext.md @@ -26,8 +26,8 @@ title: "[I] TCGCContext" | `filterOutCoreModels?` | `boolean` | | `flattenUnionAsEnum?` | `boolean` | | `generateConvenienceMethods?` | `boolean` | -| `generateProtocolMethods?` | `boolean` | | `generatedNames?` | `Map`<`Model` \| `Union` \| `TspLiteralType`, `string`\> | +| `generateProtocolMethods?` | `boolean` | | `httpOperationCache?` | `Map`<`Operation`, `HttpOperation`\> | | `knownScalars?` | `Record`<`string`, [`SdkBuiltInKinds`](../type-aliases/SdkBuiltInKinds.md)\> | | `modelsMap?` | `Map`<`Type`, [`SdkModelType`](SdkModelType.md) \| [`SdkEnumType`](SdkEnumType.md)\> | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkBuiltInKinds.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkBuiltInKinds.md index 46df868172..0ba544d48a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkBuiltInKinds.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkBuiltInKinds.md @@ -4,5 +4,5 @@ title: "[T] SdkBuiltInKinds" --- ```ts -type SdkBuiltInKinds: Exclude | "any"; +type SdkBuiltInKinds: Exclude | "unknown"; ``` diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkExampleValue.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkExampleValue.md new file mode 100644 index 0000000000..3a43e248d7 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkExampleValue.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[T] SdkExampleValue" + +--- +```ts +type SdkExampleValue: + | SdkStringExampleValue + | SdkNumberExampleValue + | SdkBooleanExampleValue + | SdkNullExampleValue + | SdkUnknownExampleValue + | SdkArrayExampleValue + | SdkDictionaryExampleValue + | SdkUnionExampleValue + | SdkModelExampleValue; +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkTypeExample.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkTypeExample.md deleted file mode 100644 index f685681343..0000000000 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkTypeExample.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -jsApi: true -title: "[T] SdkTypeExample" - ---- -```ts -type SdkTypeExample: - | SdkStringExample - | SdkNumberExample - | SdkBooleanExample - | SdkNullExample - | SdkAnyExample - | SdkArrayExample - | SdkDictionaryExample - | SdkUnionExample - | SdkModelExample; -``` diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2024-10-09.md b/packages/website/versioned_docs/version-latest/release-notes/release-2024-10-09.md new file mode 100644 index 0000000000..3484c0ef19 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2024-10-09.md @@ -0,0 +1,59 @@ +--- +title: 0.47.0 October 2024 +--- + +See TypeSpec Core 0.61 [release notes](https://typespec.io/docs/release-notes/release-2024-10-09) + +:::warning +This release contains deprecations and breaking changes +::: + +## Breaking Changes + +### @azure-tools/typespec-client-generator-core + +- [#1560](https://github.com/Azure/typespec-azure/pull/1560) Remove `.description` and `.details` from deprecated api surface + +## Deprecations + +### @azure-tools/typespec-client-generator-core + +- [#1613](https://github.com/Azure/typespec-azure/pull/1613) deprecate description in `SdkExampleBase` + +## Features + +### @azure-tools/typespec-autorest + +- [#1547](https://github.com/Azure/typespec-azure/pull/1547) Added support to use Scalar and Object as default types +- [#1627](https://github.com/Azure/typespec-azure/pull/1627) Adding support for loading example files from nested sub-folders. + +### @azure-tools/typespec-azure-resource-manager + +- [#1512](https://github.com/Azure/typespec-azure/pull/1512) `x-ms-skip-url-encoding` should be replaced with `allowReserved` +- [#1505](https://github.com/Azure/typespec-azure/pull/1505) Added common-types managed identity with delegation and network security perimeter +- [#1555](https://github.com/Azure/typespec-azure/pull/1555) Add `no-empty-model` rule +- [#1639](https://github.com/Azure/typespec-azure/pull/1639) Adding `ArmProviderActionSync` and `ArmProviderActionAsync` templates to the ARM library to perform actions at the subscription and tenant levels. + +### @azure-tools/typespec-client-generator-core + +- [#1631](https://github.com/Azure/typespec-azure/pull/1631) support value type for client default value +- [#1515](https://github.com/Azure/typespec-azure/pull/1515) add `SdkLroServiceMetadata` + +## Bug Fixes + +### @azure-tools/typespec-azure-core + +- [#1416](https://github.com/Azure/typespec-azure/pull/1416) Fix #1180 Return StatusMonitor result field for non-resource PUT operations in getLroMetadata.finalResult + +### @azure-tools/typespec-azure-resource-manager + +- [#1416](https://github.com/Azure/typespec-azure/pull/1416) Fix #1180 Return StatusMonitor result field for non-resource PUT operations in getLroMetadata.finalResult +- [#1551](https://github.com/Azure/typespec-azure/pull/1551) Correct ManagedServiceIdentityType versioning issue +- [#1537](https://github.com/Azure/typespec-azure/pull/1537) Fix missing-x-ms-identifier rule not checking base class for properties + +### @azure-tools/typespec-client-generator-core + +- [#1511](https://github.com/Azure/typespec-azure/pull/1511) Fix logic to check conflicting usage for model of multipart body and regular body +- [#1629](https://github.com/Azure/typespec-azure/pull/1629) do not promote api version param to client if service is not versioned +- [#1630](https://github.com/Azure/typespec-azure/pull/1630) do not override client default value for api version param in non-versioning service +- [#1607](https://github.com/Azure/typespec-azure/pull/1607) set service of og in using time instead of setting time