diff --git a/common/changes/@azure-tools/typespec-autorest/dependabot-submodules-core-324a6b7_2024-01-12-16-17.json b/common/changes/@azure-tools/typespec-autorest/dependabot-submodules-core-324a6b7_2024-01-12-16-17.json deleted file mode 100644 index fad931078e..0000000000 --- a/common/changes/@azure-tools/typespec-autorest/dependabot-submodules-core-324a6b7_2024-01-12-16-17.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-autorest", - "comment": "", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-autorest" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-autorest/feature-encoded-name_2024-01-05-16-33.json b/common/changes/@azure-tools/typespec-autorest/feature-encoded-name_2024-01-05-16-33.json deleted file mode 100644 index 15b17bbba9..0000000000 --- a/common/changes/@azure-tools/typespec-autorest/feature-encoded-name_2024-01-05-16-33.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-autorest", - "comment": "Add support for `@encodedName` decorator", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-autorest" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-autorest/upgrade-general-dec-2023_2023-12-13-18-38.json b/common/changes/@azure-tools/typespec-autorest/upgrade-general-dec-2023_2023-12-13-18-38.json deleted file mode 100644 index d74be9edc1..0000000000 --- a/common/changes/@azure-tools/typespec-autorest/upgrade-general-dec-2023_2023-12-13-18-38.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-autorest", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-autorest" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-autorest/vitest-ui_2024-01-11-21-20.json b/common/changes/@azure-tools/typespec-autorest/vitest-ui_2024-01-11-21-20.json deleted file mode 100644 index fad931078e..0000000000 --- a/common/changes/@azure-tools/typespec-autorest/vitest-ui_2024-01-11-21-20.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-autorest", - "comment": "", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-autorest" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-autorest/vitest_2023-12-27-20-32.json b/common/changes/@azure-tools/typespec-autorest/vitest_2023-12-27-20-32.json deleted file mode 100644 index fad931078e..0000000000 --- a/common/changes/@azure-tools/typespec-autorest/vitest_2023-12-27-20-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-autorest", - "comment": "", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-autorest" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-azure-core/azhang_filterCamelCase_2024-01-11-18-04.json b/common/changes/@azure-tools/typespec-azure-core/azhang_filterCamelCase_2024-01-11-18-04.json deleted file mode 100644 index 7496ec1824..0000000000 --- a/common/changes/@azure-tools/typespec-azure-core/azhang_filterCamelCase_2024-01-11-18-04.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-azure-core", - "comment": "Relaxing camelCase linting rule to allow a single non-alphabetical char. Also added standard filterParameter", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-azure-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-azure-core/dependabot-submodules-core-40253e3_2023-12-22-17-29.json b/common/changes/@azure-tools/typespec-azure-core/dependabot-submodules-core-40253e3_2023-12-22-17-29.json deleted file mode 100644 index 0a119a4d66..0000000000 --- a/common/changes/@azure-tools/typespec-azure-core/dependabot-submodules-core-40253e3_2023-12-22-17-29.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-azure-core", - "comment": "", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-azure-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-azure-core/rename-template-params_2024-01-16-20-17.json b/common/changes/@azure-tools/typespec-azure-core/rename-template-params_2024-01-16-20-17.json deleted file mode 100644 index 17133c154d..0000000000 --- a/common/changes/@azure-tools/typespec-azure-core/rename-template-params_2024-01-16-20-17.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-azure-core", - "comment": "Renamed template parameters for clarity and consistency.", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-azure-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-azure-core/upgrade-general-dec-2023_2023-12-13-18-38.json b/common/changes/@azure-tools/typespec-azure-core/upgrade-general-dec-2023_2023-12-13-18-38.json deleted file mode 100644 index 39ffed0aba..0000000000 --- a/common/changes/@azure-tools/typespec-azure-core/upgrade-general-dec-2023_2023-12-13-18-38.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-azure-core", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-azure-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-azure-core/vitest-ui_2024-01-11-21-20.json b/common/changes/@azure-tools/typespec-azure-core/vitest-ui_2024-01-11-21-20.json deleted file mode 100644 index 0a119a4d66..0000000000 --- a/common/changes/@azure-tools/typespec-azure-core/vitest-ui_2024-01-11-21-20.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-azure-core", - "comment": "", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-azure-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-azure-core/vitest_2023-12-27-20-32.json b/common/changes/@azure-tools/typespec-azure-core/vitest_2023-12-27-20-32.json deleted file mode 100644 index 0a119a4d66..0000000000 --- a/common/changes/@azure-tools/typespec-azure-core/vitest_2023-12-27-20-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-azure-core", - "comment": "", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-azure-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-azure-resource-manager/dependabot-submodules-core-40253e3_2023-12-22-17-29.json b/common/changes/@azure-tools/typespec-azure-resource-manager/dependabot-submodules-core-40253e3_2023-12-22-17-29.json deleted file mode 100644 index 741827fea8..0000000000 --- a/common/changes/@azure-tools/typespec-azure-resource-manager/dependabot-submodules-core-40253e3_2023-12-22-17-29.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-azure-resource-manager", - "comment": "", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-azure-resource-manager" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-azure-resource-manager/fix-arm-common-version-on-enum-member_2024-01-22-21-54.json b/common/changes/@azure-tools/typespec-azure-resource-manager/fix-arm-common-version-on-enum-member_2024-01-22-21-54.json deleted file mode 100644 index c5fb35d7fd..0000000000 --- a/common/changes/@azure-tools/typespec-azure-resource-manager/fix-arm-common-version-on-enum-member_2024-01-22-21-54.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-azure-resource-manager", - "comment": "Fix: Resolve selected arm common version when used on version enum members", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-azure-resource-manager" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-azure-resource-manager/rename-template-params_2024-01-16-20-17.json b/common/changes/@azure-tools/typespec-azure-resource-manager/rename-template-params_2024-01-16-20-17.json deleted file mode 100644 index 09a5a36556..0000000000 --- a/common/changes/@azure-tools/typespec-azure-resource-manager/rename-template-params_2024-01-16-20-17.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-azure-resource-manager", - "comment": "Renamed template parameters for clarity and consistency.", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-azure-resource-manager" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-azure-resource-manager/upgrade-general-dec-2023_2023-12-13-18-38.json b/common/changes/@azure-tools/typespec-azure-resource-manager/upgrade-general-dec-2023_2023-12-13-18-38.json deleted file mode 100644 index ba7837f49b..0000000000 --- a/common/changes/@azure-tools/typespec-azure-resource-manager/upgrade-general-dec-2023_2023-12-13-18-38.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-azure-resource-manager", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-azure-resource-manager" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-azure-resource-manager/vitest-ui_2024-01-11-21-20.json b/common/changes/@azure-tools/typespec-azure-resource-manager/vitest-ui_2024-01-11-21-20.json deleted file mode 100644 index 741827fea8..0000000000 --- a/common/changes/@azure-tools/typespec-azure-resource-manager/vitest-ui_2024-01-11-21-20.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-azure-resource-manager", - "comment": "", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-azure-resource-manager" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-azure-resource-manager/vitest_2023-12-27-20-32.json b/common/changes/@azure-tools/typespec-azure-resource-manager/vitest_2023-12-27-20-32.json deleted file mode 100644 index 741827fea8..0000000000 --- a/common/changes/@azure-tools/typespec-azure-resource-manager/vitest_2023-12-27-20-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-azure-resource-manager", - "comment": "", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-azure-resource-manager" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-client-generator-core/additional_properties_2023-12-13-06-56.json b/common/changes/@azure-tools/typespec-client-generator-core/additional_properties_2023-12-13-06-56.json deleted file mode 100644 index 71cf19e637..0000000000 --- a/common/changes/@azure-tools/typespec-client-generator-core/additional_properties_2023-12-13-06-56.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-client-generator-core", - "comment": "Add type info for additional properties in model type.", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-client-generator-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-client-generator-core/clientName_2024-01-13-00-59.json b/common/changes/@azure-tools/typespec-client-generator-core/clientName_2024-01-13-00-59.json deleted file mode 100644 index a9166ea871..0000000000 --- a/common/changes/@azure-tools/typespec-client-generator-core/clientName_2024-01-13-00-59.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-client-generator-core", - "comment": "add decorator @clientName", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-client-generator-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-client-generator-core/fix_tcgc_issue_2024-01-12-09-48.json b/common/changes/@azure-tools/typespec-client-generator-core/fix_tcgc_issue_2024-01-12-09-48.json deleted file mode 100644 index 75b8abf182..0000000000 --- a/common/changes/@azure-tools/typespec-client-generator-core/fix_tcgc_issue_2024-01-12-09-48.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-client-generator-core", - "comment": "Fix missing models when client hierarchy and naming issue for enum with projected name.", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-client-generator-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-client-generator-core/rename-template-params_2024-01-16-20-17.json b/common/changes/@azure-tools/typespec-client-generator-core/rename-template-params_2024-01-16-20-17.json deleted file mode 100644 index 820fdf683c..0000000000 --- a/common/changes/@azure-tools/typespec-client-generator-core/rename-template-params_2024-01-16-20-17.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-client-generator-core", - "comment": "Renamed template parameters for clarity and consistency.", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-client-generator-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-client-generator-core/tcgc-encodedName_2024-01-08-20-01.json b/common/changes/@azure-tools/typespec-client-generator-core/tcgc-encodedName_2024-01-08-20-01.json deleted file mode 100644 index 3a13dcd206..0000000000 --- a/common/changes/@azure-tools/typespec-client-generator-core/tcgc-encodedName_2024-01-08-20-01.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-client-generator-core", - "comment": "add support for encodedName", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-client-generator-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-client-generator-core/tcgc-flatten-property_2024-01-08-09-09.json b/common/changes/@azure-tools/typespec-client-generator-core/tcgc-flatten-property_2024-01-08-09-09.json deleted file mode 100644 index 267ae7e412..0000000000 --- a/common/changes/@azure-tools/typespec-client-generator-core/tcgc-flatten-property_2024-01-08-09-09.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-client-generator-core", - "comment": "feat(decorator): add `@flattenProperty`", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-client-generator-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-client-generator-core/tcgc-remove_dynamic_2024-01-08-22-20.json b/common/changes/@azure-tools/typespec-client-generator-core/tcgc-remove_dynamic_2024-01-08-22-20.json deleted file mode 100644 index acb0d96d5e..0000000000 --- a/common/changes/@azure-tools/typespec-client-generator-core/tcgc-remove_dynamic_2024-01-08-22-20.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-client-generator-core", - "comment": "remove dynamic testing to support vitest plugin", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-client-generator-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-client-generator-core/unionLiterals_2024-01-22-20-38.json b/common/changes/@azure-tools/typespec-client-generator-core/unionLiterals_2024-01-22-20-38.json deleted file mode 100644 index 7d62e28d9d..0000000000 --- a/common/changes/@azure-tools/typespec-client-generator-core/unionLiterals_2024-01-22-20-38.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-client-generator-core", - "comment": "add tests for unions of literals and types", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-client-generator-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-client-generator-core/upgrade-general-dec-2023_2023-12-13-18-38.json b/common/changes/@azure-tools/typespec-client-generator-core/upgrade-general-dec-2023_2023-12-13-18-38.json deleted file mode 100644 index 5337dd4fde..0000000000 --- a/common/changes/@azure-tools/typespec-client-generator-core/upgrade-general-dec-2023_2023-12-13-18-38.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-client-generator-core", - "comment": "Update dependencies", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-client-generator-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-client-generator-core/vitest-ui_2024-01-11-21-20.json b/common/changes/@azure-tools/typespec-client-generator-core/vitest-ui_2024-01-11-21-20.json deleted file mode 100644 index ad8dbd87a6..0000000000 --- a/common/changes/@azure-tools/typespec-client-generator-core/vitest-ui_2024-01-11-21-20.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-client-generator-core", - "comment": "", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-client-generator-core" -} \ No newline at end of file diff --git a/common/changes/@azure-tools/typespec-client-generator-core/vitest_2023-12-27-20-32.json b/common/changes/@azure-tools/typespec-client-generator-core/vitest_2023-12-27-20-32.json deleted file mode 100644 index ad8dbd87a6..0000000000 --- a/common/changes/@azure-tools/typespec-client-generator-core/vitest_2023-12-27-20-32.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@azure-tools/typespec-client-generator-core", - "comment": "", - "type": "none" - } - ], - "packageName": "@azure-tools/typespec-client-generator-core" -} \ No newline at end of file diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index 8a1ab7686d..608a096cdb 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -17,13 +17,13 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-plugin-typespec '@vitest/coverage-v8': specifier: ^1.1.0 @@ -56,7 +56,7 @@ importers: specifier: ~12.17.0 version: 12.17.0 '@typespec/bundler': - specifier: workspace:~0.1.0-alpha.4 + specifier: workspace:~0.1.0-alpha.5 version: link:../bundler json5: specifier: ^2.2.3 @@ -75,7 +75,7 @@ importers: specifier: ^7.5.6 version: 7.5.6 '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@vitest/coverage-v8': specifier: ^1.1.0 @@ -120,7 +120,7 @@ importers: specifier: ~3.0.1 version: 3.0.2(rollup@4.9.1) '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler picocolors: specifier: ~1.0.0 @@ -139,7 +139,7 @@ importers: specifier: ~17.0.32 version: 17.0.32 '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@vitest/coverage-v8': specifier: ^1.1.0 @@ -230,10 +230,10 @@ importers: specifier: ~17.0.32 version: 17.0.32 '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../internal-build-utils '@vitest/coverage-v8': specifier: ^1.1.0 @@ -263,7 +263,7 @@ importers: specifier: ~0.5.21 version: 0.5.21 tmlanguage-generator: - specifier: workspace:~0.5.1 + specifier: workspace:~0.5.2 version: link:../tmlanguage-generator ts-node: specifier: ~10.9.1 @@ -330,7 +330,7 @@ importers: specifier: ~6.14.0 version: 6.14.0(@eslint/eslintrc@3.0.0)(eslint@8.56.0)(typescript@5.3.3) '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@vitest/coverage-v8': specifier: ^1.1.0 @@ -385,10 +385,10 @@ importers: specifier: ~18.2.7 version: 18.2.18 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@vitest/coverage-v8': specifier: ^1.1.0 @@ -418,16 +418,16 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-plugin-typespec '@typespec/library-linter': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -479,7 +479,7 @@ importers: specifier: ~17.0.32 version: 17.0.32 '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@vitest/coverage-v8': specifier: ^1.1.0 @@ -516,19 +516,19 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-plugin-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../internal-build-utils '@typespec/library-linter': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -567,10 +567,10 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@vitest/coverage-v8': specifier: ^1.1.0 @@ -600,22 +600,22 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../http '@typespec/library-linter': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../library-linter '@typespec/rest': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../rest '@typespec/tspd': specifier: workspace:~0.46.0 @@ -652,31 +652,31 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../http '@typespec/library-linter': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../library-linter '@typespec/openapi': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../openapi '@typespec/rest': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../rest '@typespec/tspd': specifier: workspace:~0.46.0 version: link:../tspd '@typespec/versioning': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../versioning '@vitest/coverage-v8': specifier: ^1.1.0 @@ -709,31 +709,31 @@ importers: specifier: ^2.0.221 version: 2.0.224(react@18.2.0) '@typespec/bundler': - specifier: workspace:~0.1.0-alpha.4 + specifier: workspace:~0.1.0-alpha.5 version: link:../bundler '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/html-program-viewer': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../html-program-viewer '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../http '@typespec/openapi': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.51.1 + specifier: workspace:~0.52.0 version: link:../openapi3 '@typespec/protobuf': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../protobuf '@typespec/rest': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../rest '@typespec/versioning': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../versioning clsx: specifier: ^2.0.0 @@ -800,7 +800,7 @@ importers: specifier: ^4.18.0 version: 4.18.3 '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@vitejs/plugin-react': specifier: ~4.2.1 @@ -842,34 +842,34 @@ importers: ../../core/packages/playground-website: dependencies: '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/html-program-viewer': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../html-program-viewer '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../http '@typespec/json-schema': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../json-schema '@typespec/openapi': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.51.1 + specifier: workspace:~0.52.0 version: link:../openapi3 '@typespec/playground': - specifier: workspace:~0.1.0-alpha.4 + specifier: workspace:~0.1.0-alpha.5 version: link:../playground '@typespec/protobuf': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../protobuf '@typespec/rest': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../rest '@typespec/versioning': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../versioning es-module-shims: specifier: ~1.8.0 @@ -906,7 +906,7 @@ importers: specifier: ^4.18.0 version: 4.18.3 '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@vitejs/plugin-react': specifier: ~4.2.1 @@ -952,10 +952,10 @@ importers: specifier: ~5.0.2 version: 5.0.5(rollup@4.9.1) '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/internal-build-utils': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../internal-build-utils prettier_2: specifier: npm:prettier@2.8.7 @@ -976,13 +976,13 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-plugin-typespec '@typespec/tspd': specifier: workspace:~0.46.0 @@ -1018,19 +1018,19 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../http '@typespec/library-linter': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -1063,38 +1063,38 @@ importers: specifier: workspace:~0.45.0 version: link:../best-practices '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/html-program-viewer': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../html-program-viewer '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../http '@typespec/json-schema': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../json-schema '@typespec/openapi': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.51.1 + specifier: workspace:~0.52.0 version: link:../openapi3 '@typespec/rest': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../rest '@typespec/versioning': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../versioning devDependencies: '@types/node': specifier: ~18.11.9 version: 18.11.19 '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../internal-build-utils '@vitest/coverage-v8': specifier: ^1.1.0 @@ -1127,7 +1127,7 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/internal-build-utils': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../internal-build-utils ecmarkup: specifier: ~18.1.0 @@ -1149,7 +1149,7 @@ importers: specifier: ~3.0.5 version: 3.0.5 '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec eslint: specifier: ^8.55.0 @@ -1164,7 +1164,7 @@ importers: ../../core/packages/tspd: dependencies: '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler picocolors: specifier: ~1.0.0 @@ -1186,10 +1186,10 @@ importers: specifier: ~17.0.32 version: 17.0.32 '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@typespec/prettier-plugin-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../prettier-plugin-typespec '@vitest/coverage-v8': specifier: ^1.1.0 @@ -1225,10 +1225,10 @@ importers: ../../core/packages/typespec-vs: devDependencies: '@typespec/internal-build-utils': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../internal-build-utils typespec-vscode: - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../typespec-vscode ../../core/packages/typespec-vscode: @@ -1249,13 +1249,13 @@ importers: specifier: ~1.85.0 version: 1.85.0 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../internal-build-utils '@vitest/coverage-v8': specifier: ^1.1.0 @@ -1294,16 +1294,16 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-plugin-typespec '@typespec/library-linter': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../library-linter '@typespec/tspd': specifier: workspace:~0.46.0 @@ -1360,7 +1360,7 @@ importers: specifier: ^3.0.0 version: 3.0.0(@types/react@18.2.45)(react@18.2.0) '@typespec/playground': - specifier: workspace:~0.1.0-alpha.4 + specifier: workspace:~0.1.0-alpha.5 version: link:../playground clsx: specifier: ^2.0.0 @@ -1400,34 +1400,34 @@ importers: specifier: ~18.2.22 version: 18.2.45 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../eslint-config-typespec '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../http '@typespec/internal-build-utils': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../internal-build-utils '@typespec/json-schema': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../json-schema '@typespec/openapi': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../openapi '@typespec/openapi3': - specifier: workspace:~0.51.1 + specifier: workspace:~0.52.0 version: link:../openapi3 '@typespec/playground-website': specifier: workspace:* version: link:../playground-website '@typespec/protobuf': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../protobuf '@typespec/rest': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../rest '@typespec/spec': specifier: workspace:* @@ -1436,7 +1436,7 @@ importers: specifier: workspace:~0.46.0 version: link:../tspd '@typespec/versioning': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../versioning dotenv: specifier: ~16.3.1 @@ -1475,7 +1475,7 @@ importers: ../../packages/e2e-tests: devDependencies: '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/compiler dotenv: specifier: ~16.3.1 @@ -1487,44 +1487,44 @@ importers: ../../packages/samples: dependencies: '@azure-tools/typespec-autorest': - specifier: workspace:~0.37.2 + specifier: workspace:~0.38.0 version: link:../typespec-autorest '@azure-tools/typespec-azure-core': - specifier: workspace:~0.37.2 + specifier: workspace:~0.38.0 version: link:../typespec-azure-core '@azure-tools/typespec-azure-resource-manager': - specifier: workspace:~0.37.1 + specifier: workspace:~0.38.0 version: link:../typespec-azure-resource-manager '@azure-tools/typespec-client-generator-core': - specifier: workspace:~0.37.0 + specifier: workspace:~0.38.0 version: link:../typespec-client-generator-core '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/compiler '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/http '@typespec/openapi': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/openapi '@typespec/openapi3': - specifier: workspace:~0.51.1 + specifier: workspace:~0.52.0 version: link:../../core/packages/openapi3 '@typespec/rest': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/rest '@typespec/versioning': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/versioning devDependencies: '@types/node': specifier: ~18.11.9 version: 18.11.19 '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/eslint-config-typespec '@typespec/internal-build-utils': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/internal-build-utils '@typespec/samples': specifier: workspace:~1.0.0 @@ -1557,40 +1557,40 @@ importers: ../../packages/typespec-autorest: devDependencies: '@azure-tools/typespec-azure-core': - specifier: workspace:~0.37.2 + specifier: workspace:~0.38.0 version: link:../typespec-azure-core '@types/node': specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/http '@typespec/json-schema': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/json-schema '@typespec/library-linter': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/library-linter '@typespec/openapi': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/openapi '@typespec/rest': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/rest '@typespec/tspd': specifier: workspace:~0.46.0 version: link:../../core/packages/tspd '@typespec/versioning': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/versioning '@vitest/coverage-v8': specifier: ^1.1.0 @@ -1623,31 +1623,31 @@ importers: specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/http '@typespec/library-linter': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/library-linter '@typespec/openapi': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/openapi '@typespec/rest': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/rest '@typespec/tspd': specifier: workspace:~0.46.0 version: link:../../core/packages/tspd '@typespec/versioning': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/versioning '@vitest/coverage-v8': specifier: ^1.1.0 @@ -1674,37 +1674,37 @@ importers: ../../packages/typespec-azure-playground-website: dependencies: '@azure-tools/typespec-autorest': - specifier: workspace:~0.37.2 + specifier: workspace:~0.38.0 version: link:../typespec-autorest '@azure-tools/typespec-azure-core': - specifier: workspace:~0.37.2 + specifier: workspace:~0.38.0 version: link:../typespec-azure-core '@azure-tools/typespec-azure-resource-manager': - specifier: workspace:~0.37.1 + specifier: workspace:~0.38.0 version: link:../typespec-azure-resource-manager '@azure-tools/typespec-client-generator-core': - specifier: workspace:~0.37.0 + specifier: workspace:~0.38.0 version: link:../typespec-client-generator-core '@emotion/react': specifier: ^11.11.1 version: 11.11.3(@types/react@18.2.45)(react@18.2.0) '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/compiler '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/http '@typespec/openapi': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/openapi '@typespec/openapi3': - specifier: workspace:~0.51.1 + specifier: workspace:~0.52.0 version: link:../../core/packages/openapi3 '@typespec/rest': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/rest '@typespec/versioning': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/versioning '@vitejs/plugin-react': specifier: ~4.2.1 @@ -1735,13 +1735,13 @@ importers: specifier: ~18.2.7 version: 18.2.18 '@typespec/bundler': - specifier: workspace:~0.1.0-alpha.4 + specifier: workspace:~0.1.0-alpha.5 version: link:../../core/packages/bundler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/eslint-config-typespec '@typespec/playground': - specifier: workspace:~0.1.0-alpha.4 + specifier: workspace:~0.1.0-alpha.5 version: link:../../core/packages/playground cross-env: specifier: ~7.0.3 @@ -1759,40 +1759,40 @@ importers: ../../packages/typespec-azure-resource-manager: devDependencies: '@azure-tools/typespec-autorest': - specifier: workspace:~0.37.2 + specifier: workspace:~0.38.0 version: link:../typespec-autorest '@azure-tools/typespec-azure-core': - specifier: workspace:~0.37.2 + specifier: workspace:~0.38.0 version: link:../typespec-azure-core '@types/node': specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/http '@typespec/library-linter': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/library-linter '@typespec/openapi': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/openapi '@typespec/rest': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/rest '@typespec/tspd': specifier: workspace:~0.46.0 version: link:../../core/packages/tspd '@typespec/versioning': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/versioning '@vitest/coverage-v8': specifier: ^1.1.0 @@ -1826,7 +1826,7 @@ importers: version: 8.0.0 devDependencies: '@azure-tools/typespec-azure-core': - specifier: workspace:~0.37.2 + specifier: workspace:~0.38.0 version: link:../typespec-azure-core '@types/node': specifier: ~18.11.9 @@ -1835,31 +1835,31 @@ importers: specifier: ^0.0.30 version: 0.0.30 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/http '@typespec/library-linter': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/library-linter '@typespec/prettier-plugin-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/prettier-plugin-typespec '@typespec/rest': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/rest '@typespec/tspd': specifier: workspace:~0.46.0 version: link:../../core/packages/tspd '@typespec/versioning': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/versioning '@vitest/coverage-v8': specifier: ^1.1.0 @@ -1886,41 +1886,41 @@ importers: ../../packages/typespec-service-csharp: dependencies: '@typespec/versioning': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/versioning change-case: specifier: ~5.3.0 version: 5.3.0 devDependencies: '@azure-tools/typespec-autorest': - specifier: workspace:~0.37.2 + specifier: workspace:~0.38.0 version: link:../typespec-autorest '@azure-tools/typespec-azure-core': - specifier: workspace:~0.37.2 + specifier: workspace:~0.38.0 version: link:../typespec-azure-core '@types/node': specifier: ~18.11.9 version: 18.11.19 '@typespec/compiler': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/compiler '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/eslint-config-typespec '@typespec/eslint-plugin': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/eslint-plugin-typespec '@typespec/http': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/http '@typespec/library-linter': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/library-linter '@typespec/openapi': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/openapi '@typespec/rest': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/rest '@typespec/tspd': specifier: workspace:~0.46.0 @@ -1965,7 +1965,7 @@ importers: specifier: ^3.0.0 version: 3.0.0(@types/react@18.2.45)(react@18.2.0) '@typespec/playground': - specifier: workspace:~0.1.0-alpha.4 + specifier: workspace:~0.1.0-alpha.5 version: link:../../core/packages/playground '@typespec/website': specifier: workspace:~1.0.0 @@ -1990,16 +1990,16 @@ importers: version: 18.2.0(react@18.2.0) devDependencies: '@azure-tools/typespec-azure-core': - specifier: workspace:~0.37.2 + specifier: workspace:~0.38.0 version: link:../typespec-azure-core '@azure-tools/typespec-azure-playground-website': specifier: workspace:~1.0.0 version: link:../typespec-azure-playground-website '@azure-tools/typespec-azure-resource-manager': - specifier: workspace:~0.37.1 + specifier: workspace:~0.38.0 version: link:../typespec-azure-resource-manager '@azure-tools/typespec-client-generator-core': - specifier: workspace:~0.37.0 + specifier: workspace:~0.38.0 version: link:../typespec-client-generator-core '@azure-tools/typespec-service-csharp': specifier: workspace:~0.32.0 @@ -2020,7 +2020,7 @@ importers: specifier: ~18.2.22 version: 18.2.45 '@typespec/eslint-config-typespec': - specifier: workspace:~0.51.0 + specifier: workspace:~0.52.0 version: link:../../core/packages/eslint-config-typespec '@typespec/tspd': specifier: workspace:~0.46.0 diff --git a/common/config/rush/version-policies.json b/common/config/rush/version-policies.json index f46761a193..893edf4388 100644 --- a/common/config/rush/version-policies.json +++ b/common/config/rush/version-policies.json @@ -12,7 +12,7 @@ { "definitionName": "lockStepVersion", "policyName": "typespec-azure", - "version": "0.37.0", + "version": "0.38.0", "nextBump": "minor" }, { diff --git a/core b/core index f31fae0e48..e542ce8991 160000 --- a/core +++ b/core @@ -1 +1 @@ -Subproject commit f31fae0e483bfc17d6733c4433c7fe3f81a7f938 +Subproject commit e542ce8991c3f6d33b280fc94a7bcebc4ffc25f3 diff --git a/eng/scripts/check-for-changed-files.js b/eng/scripts/check-for-changed-files.js index fa1d51bdfc..e79e75191c 100644 --- a/eng/scripts/check-for-changed-files.js +++ b/eng/scripts/check-for-changed-files.js @@ -1,4 +1,3 @@ -import { runOrExit } from "../../core/packages/internal-build-utils/dist/src/common.js"; import { checkForChangedFiles, coreRepoRoot, repoRoot } from "./helpers.js"; if ( @@ -17,7 +16,7 @@ In the future, remember to alert coworkers to avoid merging additional changes w Close this PR, run prepare-publish again.` ); } - await runOrExit("git", ["diff"], { cwd: coreRepoRoot }); - await runOrExit("git", ["diff"], { cwd: repoRoot }); + run("git", ["diff"], { cwd: coreRepoRoot }); + run("git", ["diff"], { cwd: repoRoot }); process.exit(1); } diff --git a/eng/scripts/prepare-publish.js b/eng/scripts/prepare-publish.js index 2a0b7f1e5a..a647ba1c11 100644 --- a/eng/scripts/prepare-publish.js +++ b/eng/scripts/prepare-publish.js @@ -20,7 +20,9 @@ const Major = 3; * DO NOT LEAVE TO FALSE */ const production = true; + let branch; + if (production) { // Create and checkout branches branch = `publish/${Date.now().toString(36)}`; @@ -123,6 +125,12 @@ function typespecAzureRun(command, ...args) { run(command, args, { cwd: repoRoot }); } +function typespecAzureRunWithOptions(options, command, ...args) { + console.log(); + console.log("## typespec-azure ##"); + run(command, args, { cwd: repoRoot, ...options }); +} + function typespecRunWithRetries(tries, command, ...args) { try { console.log(); @@ -212,7 +220,11 @@ function bumpCrossSubmoduleDependencies() { async function rebuildAndRegenSamplesToBumpTemplateVersions() { typespecAzureRunWithRetries(3, "rush", "update"); - typespecAzureRun("rush", "rebuild"); + typespecAzureRunWithOptions( + { env: { ...process.env, TYPESPEC_SKIP_DOCUSAURUS_BUILD: true } }, + "rush", + "rebuild" + ); typespecAzureRun("rush", "regen-samples"); if (checkForChangedFiles(repoRoot, undefined, { silent: true }) && production) { typespecAzureRun("git", "add", "-A"); diff --git a/packages/e2e-tests/package.json b/packages/e2e-tests/package.json index cbb8bf549d..3bb15a33a6 100644 --- a/packages/e2e-tests/package.json +++ b/packages/e2e-tests/package.json @@ -25,7 +25,7 @@ "build": "" }, "devDependencies": { - "@typespec/compiler": "workspace:~0.51.0", + "@typespec/compiler": "workspace:~0.52.0", "typescript": "~5.3.3", "dotenv": "~16.3.1" } diff --git a/packages/samples/package.json b/packages/samples/package.json index eb16dc8fe7..94be4e9837 100644 --- a/packages/samples/package.json +++ b/packages/samples/package.json @@ -38,20 +38,20 @@ "!dist/test/**" ], "dependencies": { - "@typespec/versioning": "workspace:~0.51.0", - "@typespec/compiler": "workspace:~0.51.0", - "@typespec/openapi": "workspace:~0.51.0", - "@typespec/openapi3": "workspace:~0.51.1", - "@typespec/http": "workspace:~0.51.0", - "@typespec/rest": "workspace:~0.51.0", - "@azure-tools/typespec-azure-core": "workspace:~0.37.2", - "@azure-tools/typespec-autorest": "workspace:~0.37.2", - "@azure-tools/typespec-azure-resource-manager": "workspace:~0.37.1", - "@azure-tools/typespec-client-generator-core": "workspace:~0.37.0" + "@typespec/versioning": "workspace:~0.52.0", + "@typespec/compiler": "workspace:~0.52.0", + "@typespec/openapi": "workspace:~0.52.0", + "@typespec/openapi3": "workspace:~0.52.0", + "@typespec/http": "workspace:~0.52.0", + "@typespec/rest": "workspace:~0.52.0", + "@azure-tools/typespec-azure-core": "workspace:~0.38.0", + "@azure-tools/typespec-autorest": "workspace:~0.38.0", + "@azure-tools/typespec-azure-resource-manager": "workspace:~0.38.0", + "@azure-tools/typespec-client-generator-core": "workspace:~0.38.0" }, "devDependencies": { - "@typespec/internal-build-utils": "workspace:~0.51.0", - "@typespec/eslint-config-typespec": "workspace:~0.51.0", + "@typespec/internal-build-utils": "workspace:~0.52.0", + "@typespec/eslint-config-typespec": "workspace:~0.52.0", "@typespec/samples": "workspace:~1.0.0", "@types/node": "~18.11.9", "cross-env": "~7.0.3", diff --git a/packages/typespec-autorest/CHANGELOG.json b/packages/typespec-autorest/CHANGELOG.json index da6a8bbbdc..6f720e8440 100644 --- a/packages/typespec-autorest/CHANGELOG.json +++ b/packages/typespec-autorest/CHANGELOG.json @@ -1,6 +1,26 @@ { "name": "@azure-tools/typespec-autorest", "entries": [ + { + "version": "0.38.0", + "tag": "@azure-tools/typespec-autorest_v0.38.0", + "date": "Wed, 24 Jan 2024 05:47:18 GMT", + "comments": { + "none": [ + { + "comment": "Add support for `@encodedName` decorator" + }, + { + "comment": "Update dependencies" + } + ], + "minor": [ + { + "comment": "Update dependencies." + } + ] + } + }, { "version": "0.37.2", "tag": "@azure-tools/typespec-autorest_v0.37.2", diff --git a/packages/typespec-autorest/CHANGELOG.md b/packages/typespec-autorest/CHANGELOG.md index 22ab989293..134a5750bc 100644 --- a/packages/typespec-autorest/CHANGELOG.md +++ b/packages/typespec-autorest/CHANGELOG.md @@ -1,6 +1,18 @@ # Change Log - @azure-tools/typespec-autorest -This log was last generated on Thu, 14 Dec 2023 01:19:27 GMT and should not be manually modified. +This log was last generated on Wed, 24 Jan 2024 05:47:18 GMT and should not be manually modified. + +## 0.38.0 +Wed, 24 Jan 2024 05:47:18 GMT + +### Minor changes + +- Update dependencies. + +### Updates + +- Add support for `@encodedName` decorator +- Update dependencies ## 0.37.2 Thu, 14 Dec 2023 01:19:27 GMT diff --git a/packages/typespec-autorest/package.json b/packages/typespec-autorest/package.json index fd86b0fb0e..3050c17c00 100644 --- a/packages/typespec-autorest/package.json +++ b/packages/typespec-autorest/package.json @@ -1,6 +1,6 @@ { "name": "@azure-tools/typespec-autorest", - "version": "0.37.2", + "version": "0.38.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting openapi from the TypeSpec REST protocol binding", "homepage": "https://azure.github.io/typespec-azure", @@ -54,25 +54,25 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.51.0", - "@azure-tools/typespec-azure-core": "~0.37.2", - "@typespec/http": "workspace:~0.51.0", - "@typespec/rest": "workspace:~0.51.0", - "@typespec/openapi": "workspace:~0.51.0", - "@typespec/versioning": "workspace:~0.51.0" + "@typespec/compiler": "workspace:~0.52.0", + "@azure-tools/typespec-azure-core": "~0.38.0", + "@typespec/http": "workspace:~0.52.0", + "@typespec/rest": "workspace:~0.52.0", + "@typespec/openapi": "workspace:~0.52.0", + "@typespec/versioning": "workspace:~0.52.0" }, "devDependencies": { - "@typespec/compiler": "workspace:~0.51.0", - "@typespec/json-schema": "workspace:~0.51.0", - "@azure-tools/typespec-azure-core": "workspace:~0.37.2", - "@typespec/http": "workspace:~0.51.0", - "@typespec/rest": "workspace:~0.51.0", - "@typespec/openapi": "workspace:~0.51.0", + "@typespec/compiler": "workspace:~0.52.0", + "@typespec/json-schema": "workspace:~0.52.0", + "@azure-tools/typespec-azure-core": "workspace:~0.38.0", + "@typespec/http": "workspace:~0.52.0", + "@typespec/rest": "workspace:~0.52.0", + "@typespec/openapi": "workspace:~0.52.0", "@types/node": "~18.11.9", - "@typespec/versioning": "workspace:~0.51.0", - "@typespec/eslint-config-typespec": "workspace:~0.51.0", - "@typespec/library-linter": "workspace:~0.51.0", - "@typespec/eslint-plugin": "workspace:~0.51.0", + "@typespec/versioning": "workspace:~0.52.0", + "@typespec/eslint-config-typespec": "workspace:~0.52.0", + "@typespec/library-linter": "workspace:~0.52.0", + "@typespec/eslint-plugin": "workspace:~0.52.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.55.0", "vitest": "^1.2.0", diff --git a/packages/typespec-azure-core/CHANGELOG.json b/packages/typespec-azure-core/CHANGELOG.json index b0fc298cfe..ab612ba489 100644 --- a/packages/typespec-azure-core/CHANGELOG.json +++ b/packages/typespec-azure-core/CHANGELOG.json @@ -1,6 +1,29 @@ { "name": "@azure-tools/typespec-azure-core", "entries": [ + { + "version": "0.38.0", + "tag": "@azure-tools/typespec-azure-core_v0.38.0", + "date": "Wed, 24 Jan 2024 05:47:19 GMT", + "comments": { + "none": [ + { + "comment": "Relaxing camelCase linting rule to allow a single non-alphabetical char. Also added standard filterParameter" + }, + { + "comment": "Renamed template parameters for clarity and consistency." + }, + { + "comment": "Update dependencies" + } + ], + "minor": [ + { + "comment": "Update dependencies." + } + ] + } + }, { "version": "0.37.2", "tag": "@azure-tools/typespec-azure-core_v0.37.2", diff --git a/packages/typespec-azure-core/CHANGELOG.md b/packages/typespec-azure-core/CHANGELOG.md index 72dfd595b6..7d4743d19b 100644 --- a/packages/typespec-azure-core/CHANGELOG.md +++ b/packages/typespec-azure-core/CHANGELOG.md @@ -1,6 +1,19 @@ # Change Log - @azure-tools/typespec-azure-core -This log was last generated on Wed, 20 Dec 2023 05:29:22 GMT and should not be manually modified. +This log was last generated on Wed, 24 Jan 2024 05:47:19 GMT and should not be manually modified. + +## 0.38.0 +Wed, 24 Jan 2024 05:47:19 GMT + +### Minor changes + +- Update dependencies. + +### Updates + +- Relaxing camelCase linting rule to allow a single non-alphabetical char. Also added standard filterParameter +- Renamed template parameters for clarity and consistency. +- Update dependencies ## 0.37.2 Wed, 20 Dec 2023 05:29:22 GMT diff --git a/packages/typespec-azure-core/package.json b/packages/typespec-azure-core/package.json index cd7f19fd02..c4a38a3586 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.37.2", + "version": "0.38.0", "author": "Microsoft Corporation", "description": "TypeSpec Azure Core library", "homepage": "https://azure.github.io/typespec-azure", @@ -52,20 +52,20 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.51.0", - "@typespec/http": "workspace:~0.51.0", - "@typespec/rest": "workspace:~0.51.0" + "@typespec/compiler": "workspace:~0.52.0", + "@typespec/http": "workspace:~0.52.0", + "@typespec/rest": "workspace:~0.52.0" }, "devDependencies": { - "@typespec/compiler": "workspace:~0.51.0", - "@typespec/http": "workspace:~0.51.0", - "@typespec/rest": "workspace:~0.51.0", - "@typespec/eslint-config-typespec": "workspace:~0.51.0", - "@typespec/library-linter": "workspace:~0.51.0", - "@typespec/eslint-plugin": "workspace:~0.51.0", - "@typespec/openapi": "workspace:~0.51.0", + "@typespec/compiler": "workspace:~0.52.0", + "@typespec/http": "workspace:~0.52.0", + "@typespec/rest": "workspace:~0.52.0", + "@typespec/eslint-config-typespec": "workspace:~0.52.0", + "@typespec/library-linter": "workspace:~0.52.0", + "@typespec/eslint-plugin": "workspace:~0.52.0", + "@typespec/openapi": "workspace:~0.52.0", "@typespec/tspd": "workspace:~0.46.0", - "@typespec/versioning": "workspace:~0.51.0", + "@typespec/versioning": "workspace:~0.52.0", "@types/node": "~18.11.9", "eslint": "^8.55.0", "vitest": "^1.2.0", diff --git a/packages/typespec-azure-playground-website/package.json b/packages/typespec-azure-playground-website/package.json index 604503c564..c1109ff373 100644 --- a/packages/typespec-azure-playground-website/package.json +++ b/packages/typespec-azure-playground-website/package.json @@ -50,16 +50,16 @@ "!dist/test/**" ], "dependencies": { - "@typespec/versioning": "workspace:~0.51.0", - "@typespec/compiler": "workspace:~0.51.0", - "@typespec/rest": "workspace:~0.51.0", - "@typespec/http": "workspace:~0.51.0", - "@typespec/openapi": "workspace:~0.51.0", - "@typespec/openapi3": "workspace:~0.51.1", - "@azure-tools/typespec-autorest": "workspace:~0.37.2", - "@azure-tools/typespec-azure-core": "workspace:~0.37.2", - "@azure-tools/typespec-azure-resource-manager": "workspace:~0.37.1", - "@azure-tools/typespec-client-generator-core": "workspace:~0.37.0", + "@typespec/versioning": "workspace:~0.52.0", + "@typespec/compiler": "workspace:~0.52.0", + "@typespec/rest": "workspace:~0.52.0", + "@typespec/http": "workspace:~0.52.0", + "@typespec/openapi": "workspace:~0.52.0", + "@typespec/openapi3": "workspace:~0.52.0", + "@azure-tools/typespec-autorest": "workspace:~0.38.0", + "@azure-tools/typespec-azure-core": "workspace:~0.38.0", + "@azure-tools/typespec-azure-resource-manager": "workspace:~0.38.0", + "@azure-tools/typespec-client-generator-core": "workspace:~0.38.0", "@vitejs/plugin-react": "~4.2.1", "@emotion/react": "^11.11.1", "es-module-shims": "~1.8.0", @@ -71,9 +71,9 @@ "devDependencies": { "@types/node": "~18.11.9", "@types/react-dom": "~18.2.7", - "@typespec/eslint-config-typespec": "workspace:~0.51.0", - "@typespec/bundler": "workspace:~0.1.0-alpha.4", - "@typespec/playground": "workspace:~0.1.0-alpha.4", + "@typespec/eslint-config-typespec": "workspace:~0.52.0", + "@typespec/bundler": "workspace:~0.1.0-alpha.5", + "@typespec/playground": "workspace:~0.1.0-alpha.5", "@playwright/test": "^1.39.0", "eslint": "^8.55.0", "rimraf": "~5.0.1", diff --git a/packages/typespec-azure-resource-manager/CHANGELOG.json b/packages/typespec-azure-resource-manager/CHANGELOG.json index f3ec40a30c..f9ee103a36 100644 --- a/packages/typespec-azure-resource-manager/CHANGELOG.json +++ b/packages/typespec-azure-resource-manager/CHANGELOG.json @@ -1,6 +1,29 @@ { "name": "@azure-tools/typespec-azure-resource-manager", "entries": [ + { + "version": "0.38.0", + "tag": "@azure-tools/typespec-azure-resource-manager_v0.38.0", + "date": "Wed, 24 Jan 2024 05:47:19 GMT", + "comments": { + "none": [ + { + "comment": "Fix: Resolve selected arm common version when used on version enum members" + }, + { + "comment": "Renamed template parameters for clarity and consistency." + }, + { + "comment": "Update dependencies" + } + ], + "minor": [ + { + "comment": "Update dependencies." + } + ] + } + }, { "version": "0.37.1", "tag": "@azure-tools/typespec-azure-resource-manager_v0.37.1", diff --git a/packages/typespec-azure-resource-manager/CHANGELOG.md b/packages/typespec-azure-resource-manager/CHANGELOG.md index 32eb88538e..04b846f077 100644 --- a/packages/typespec-azure-resource-manager/CHANGELOG.md +++ b/packages/typespec-azure-resource-manager/CHANGELOG.md @@ -1,6 +1,19 @@ # Change Log - @azure-tools/typespec-azure-resource-manager -This log was last generated on Wed, 20 Dec 2023 05:29:22 GMT and should not be manually modified. +This log was last generated on Wed, 24 Jan 2024 05:47:19 GMT and should not be manually modified. + +## 0.38.0 +Wed, 24 Jan 2024 05:47:19 GMT + +### Minor changes + +- Update dependencies. + +### Updates + +- Fix: Resolve selected arm common version when used on version enum members +- Renamed template parameters for clarity and consistency. +- Update dependencies ## 0.37.1 Wed, 20 Dec 2023 05:29:22 GMT diff --git a/packages/typespec-azure-resource-manager/package.json b/packages/typespec-azure-resource-manager/package.json index 5bd037ed10..0c8dddba89 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.37.1", + "version": "0.38.0", "author": "Microsoft Corporation", "description": "TypeSpec Azure Resource Manager library", "homepage": "https://azure.github.io/typespec-azure", @@ -52,26 +52,26 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.51.0", - "@azure-tools/typespec-azure-core": "~0.37.2", - "@azure-tools/typespec-autorest": "~0.37.2", - "@typespec/openapi": "workspace:~0.51.0", - "@typespec/rest": "workspace:~0.51.0", - "@typespec/http": "workspace:~0.51.0", - "@typespec/versioning": "workspace:~0.51.0" + "@typespec/compiler": "workspace:~0.52.0", + "@azure-tools/typespec-azure-core": "~0.38.0", + "@azure-tools/typespec-autorest": "~0.38.0", + "@typespec/openapi": "workspace:~0.52.0", + "@typespec/rest": "workspace:~0.52.0", + "@typespec/http": "workspace:~0.52.0", + "@typespec/versioning": "workspace:~0.52.0" }, "devDependencies": { - "@typespec/compiler": "workspace:~0.51.0", - "@typespec/openapi": "workspace:~0.51.0", - "@azure-tools/typespec-azure-core": "workspace:~0.37.2", - "@azure-tools/typespec-autorest": "workspace:~0.37.2", - "@typespec/rest": "workspace:~0.51.0", - "@typespec/http": "workspace:~0.51.0", - "@typespec/versioning": "workspace:~0.51.0", + "@typespec/compiler": "workspace:~0.52.0", + "@typespec/openapi": "workspace:~0.52.0", + "@azure-tools/typespec-azure-core": "workspace:~0.38.0", + "@azure-tools/typespec-autorest": "workspace:~0.38.0", + "@typespec/rest": "workspace:~0.52.0", + "@typespec/http": "workspace:~0.52.0", + "@typespec/versioning": "workspace:~0.52.0", "@types/node": "~18.11.9", - "@typespec/eslint-config-typespec": "workspace:~0.51.0", - "@typespec/library-linter": "workspace:~0.51.0", - "@typespec/eslint-plugin": "workspace:~0.51.0", + "@typespec/eslint-config-typespec": "workspace:~0.52.0", + "@typespec/library-linter": "workspace:~0.52.0", + "@typespec/eslint-plugin": "workspace:~0.52.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.55.0", "vitest": "^1.2.0", diff --git a/packages/typespec-client-generator-core/CHANGELOG.json b/packages/typespec-client-generator-core/CHANGELOG.json index 60c05a9378..cac6c701e1 100644 --- a/packages/typespec-client-generator-core/CHANGELOG.json +++ b/packages/typespec-client-generator-core/CHANGELOG.json @@ -1,6 +1,47 @@ { "name": "@azure-tools/typespec-client-generator-core", "entries": [ + { + "version": "0.38.0", + "tag": "@azure-tools/typespec-client-generator-core_v0.38.0", + "date": "Wed, 24 Jan 2024 05:47:19 GMT", + "comments": { + "none": [ + { + "comment": "Add type info for additional properties in model type." + }, + { + "comment": "add decorator @clientName" + }, + { + "comment": "Fix missing models when client hierarchy and naming issue for enum with projected name." + }, + { + "comment": "Renamed template parameters for clarity and consistency." + }, + { + "comment": "add support for encodedName" + }, + { + "comment": "feat(decorator): add `@flattenProperty`" + }, + { + "comment": "remove dynamic testing to support vitest plugin" + }, + { + "comment": "add tests for unions of literals and types" + }, + { + "comment": "Update dependencies" + } + ], + "minor": [ + { + "comment": "Update dependencies." + } + ] + } + }, { "version": "0.37.0", "tag": "@azure-tools/typespec-client-generator-core_v0.37.0", diff --git a/packages/typespec-client-generator-core/CHANGELOG.md b/packages/typespec-client-generator-core/CHANGELOG.md index e78dff79c5..6e9fa7576e 100644 --- a/packages/typespec-client-generator-core/CHANGELOG.md +++ b/packages/typespec-client-generator-core/CHANGELOG.md @@ -1,6 +1,25 @@ # Change Log - @azure-tools/typespec-client-generator-core -This log was last generated on Wed, 06 Dec 2023 19:47:28 GMT and should not be manually modified. +This log was last generated on Wed, 24 Jan 2024 05:47:19 GMT and should not be manually modified. + +## 0.38.0 +Wed, 24 Jan 2024 05:47:19 GMT + +### Minor changes + +- Update dependencies. + +### Updates + +- Add type info for additional properties in model type. +- add decorator @clientName +- Fix missing models when client hierarchy and naming issue for enum with projected name. +- Renamed template parameters for clarity and consistency. +- add support for encodedName +- feat(decorator): add `@flattenProperty` +- remove dynamic testing to support vitest plugin +- add tests for unions of literals and types +- Update dependencies ## 0.37.0 Wed, 06 Dec 2023 19:47:28 GMT diff --git a/packages/typespec-client-generator-core/package.json b/packages/typespec-client-generator-core/package.json index 83d5c6a029..b6d63250c5 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.37.0", + "version": "0.38.0", "author": "Microsoft Corporation", "description": "TypeSpec Data Plane Generation library", "homepage": "https://azure.github.io/typespec-azure", @@ -57,21 +57,21 @@ "change-case": "~5.3.0" }, "peerDependencies": { - "@typespec/compiler": "workspace:~0.51.0", - "@typespec/http": "workspace:~0.51.0", - "@typespec/rest": "workspace:~0.51.0", - "@typespec/versioning": "workspace:~0.51.0" + "@typespec/compiler": "workspace:~0.52.0", + "@typespec/http": "workspace:~0.52.0", + "@typespec/rest": "workspace:~0.52.0", + "@typespec/versioning": "workspace:~0.52.0" }, "devDependencies": { - "@typespec/compiler": "workspace:~0.51.0", - "@typespec/http": "workspace:~0.51.0", - "@typespec/rest": "workspace:~0.51.0", - "@typespec/eslint-config-typespec": "workspace:~0.51.0", - "@typespec/library-linter": "workspace:~0.51.0", - "@typespec/eslint-plugin": "workspace:~0.51.0", - "@typespec/versioning": "workspace:~0.51.0", - "@azure-tools/typespec-azure-core": "workspace:~0.37.2", - "@typespec/prettier-plugin-typespec": "workspace:~0.51.0", + "@typespec/compiler": "workspace:~0.52.0", + "@typespec/http": "workspace:~0.52.0", + "@typespec/rest": "workspace:~0.52.0", + "@typespec/eslint-config-typespec": "workspace:~0.52.0", + "@typespec/library-linter": "workspace:~0.52.0", + "@typespec/eslint-plugin": "workspace:~0.52.0", + "@typespec/versioning": "workspace:~0.52.0", + "@azure-tools/typespec-azure-core": "workspace:~0.38.0", + "@typespec/prettier-plugin-typespec": "workspace:~0.52.0", "@typespec/tspd": "workspace:~0.46.0", "@types/node": "~18.11.9", "eslint": "^8.55.0", diff --git a/packages/typespec-service-csharp/package.json b/packages/typespec-service-csharp/package.json index 11e2d1c819..ab7583a54d 100644 --- a/packages/typespec-service-csharp/package.json +++ b/packages/typespec-service-csharp/package.json @@ -45,27 +45,27 @@ "!dist/test/**" ], "peerDependencies": { - "@typespec/compiler": "workspace:~0.51.0", - "@typespec/rest": "workspace:~0.51.0", - "@typespec/http": "workspace:~0.51.0", - "@typespec/versioning": "workspace:~0.51.0", - "@azure-tools/typespec-autorest": "~0.37.2", - "@azure-tools/typespec-azure-core": "~0.37.2" + "@typespec/compiler": "workspace:~0.52.0", + "@typespec/rest": "workspace:~0.52.0", + "@typespec/http": "workspace:~0.52.0", + "@typespec/versioning": "workspace:~0.52.0", + "@azure-tools/typespec-autorest": "~0.38.0", + "@azure-tools/typespec-azure-core": "~0.38.0" }, "dependencies": { "change-case": "~5.3.0" }, "devDependencies": { - "@typespec/compiler": "workspace:~0.51.0", - "@azure-tools/typespec-autorest": "workspace:~0.37.2", - "@typespec/openapi": "workspace:~0.51.0", - "@typespec/rest": "workspace:~0.51.0", - "@typespec/http": "workspace:~0.51.0", - "@azure-tools/typespec-azure-core": "workspace:~0.37.2", + "@typespec/compiler": "workspace:~0.52.0", + "@azure-tools/typespec-autorest": "workspace:~0.38.0", + "@typespec/openapi": "workspace:~0.52.0", + "@typespec/rest": "workspace:~0.52.0", + "@typespec/http": "workspace:~0.52.0", + "@azure-tools/typespec-azure-core": "workspace:~0.38.0", "@types/node": "~18.11.9", - "@typespec/eslint-config-typespec": "workspace:~0.51.0", - "@typespec/library-linter": "workspace:~0.51.0", - "@typespec/eslint-plugin": "workspace:~0.51.0", + "@typespec/eslint-config-typespec": "workspace:~0.52.0", + "@typespec/library-linter": "workspace:~0.52.0", + "@typespec/eslint-plugin": "workspace:~0.52.0", "@typespec/tspd": "workspace:~0.46.0", "eslint": "^8.55.0", "c8": "~8.0.1", diff --git a/packages/website/package.json b/packages/website/package.json index 5f9c30ae4c..b5dfce24e3 100644 --- a/packages/website/package.json +++ b/packages/website/package.json @@ -23,7 +23,7 @@ "@docusaurus/theme-common": "~3.0.0", "@fluentui/react-components": "~9.42.0", "@mdx-js/react": "^3.0.0", - "@typespec/playground": "workspace:~0.1.0-alpha.4", + "@typespec/playground": "workspace:~0.1.0-alpha.5", "@typespec/website": "workspace:~1.0.0", "clsx": "^2.0.0", "es-module-shims": "~1.8.0", @@ -33,17 +33,17 @@ "react": "~18.2.0" }, "devDependencies": { - "@azure-tools/typespec-azure-core": "workspace:~0.37.2", + "@azure-tools/typespec-azure-core": "workspace:~0.38.0", "@azure-tools/typespec-azure-playground-website": "workspace:~1.0.0", - "@azure-tools/typespec-azure-resource-manager": "workspace:~0.37.1", - "@azure-tools/typespec-client-generator-core": "workspace:~0.37.0", + "@azure-tools/typespec-azure-resource-manager": "workspace:~0.38.0", + "@azure-tools/typespec-client-generator-core": "workspace:~0.38.0", "@azure-tools/typespec-service-csharp": "workspace:~0.32.0", "@docusaurus/module-type-aliases": "^3.0.0", "@docusaurus/tsconfig": "^3.0.0", "@docusaurus/types": "^3.0.0", "@types/node": "~18.11.9", "@types/react": "~18.2.22", - "@typespec/eslint-config-typespec": "workspace:~0.51.0", + "@typespec/eslint-config-typespec": "workspace:~0.52.0", "@typespec/tspd": "workspace:~0.46.0", "dotenv": "~16.3.1", "eslint": "^8.55.0", diff --git a/packages/website/playground-versions.json b/packages/website/playground-versions.json index 180ff98f1f..48adfe5744 100644 --- a/packages/website/playground-versions.json +++ b/packages/website/playground-versions.json @@ -1,4 +1,5 @@ [ + "0.38.x", "0.37.x", "0.36.x", "0.35.x" diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/index.md index 24fda37b7c..7b7b09f052 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/index.md @@ -3,17 +3,15 @@ jsApi: true title: "[P] JS Api" --- -## Exports - -### Interfaces +## Interfaces - [CSharpServiceEmitterOptions](interfaces/CSharpServiceEmitterOptions.md) -### Variables +## Variables - [$lib](variables/$lib.md) -### Functions +## Functions - [$onEmit](functions/$onEmit.md) - [getTracer](functions/getTracer.md) diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/interfaces/CSharpServiceEmitterOptions.md b/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/interfaces/CSharpServiceEmitterOptions.md index 7cf224cd13..c1ce1f8290 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/interfaces/CSharpServiceEmitterOptions.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/interfaces/CSharpServiceEmitterOptions.md @@ -7,4 +7,4 @@ title: "[I] CSharpServiceEmitterOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `skip-format`? | `boolean` | Skip formatting of output. Default is false (generated c-sharp files are formatted) | +| `skip-format?` | `boolean` | Skip formatting of output. Default is false (generated c-sharp files are formatted) | diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/variables/$lib.md index 1b4520756b..5d2a691304 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/variables/$lib.md @@ -4,5 +4,18 @@ title: "[V] $lib" --- ```ts -const $lib: TypeSpecLibrary; +const $lib: TypeSpecLibrary; ``` + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `invalid-identifier` | `Object` | - | +| `invalid-identifier.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `missing-type-parent` | `Object` | - | +| `missing-type-parent.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `no-numeric` | `Object` | - | +| `no-numeric.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `unrecognized-scalar` | `Object` | - | +| `unrecognized-scalar.default` | `CallableMessage`<[`string`]\> | - | diff --git a/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step00.md b/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step00.md index f6bed911a1..ed2e78860d 100644 --- a/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step00.md +++ b/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step00.md @@ -3,3 +3,26 @@ ## Installing IDE Tools If you use Visual Studio or Visual Studio code, the TypeSpec extensions are an important tool in providing a first class experience for writing, editing, and reviewing TypeSpec. See [Installing the VS and VS Code Extensions](https://microsoft.github.io/typespec/introduction/installation#install-the-vs-and-vscode-extensions) for details. + +## Creating a Service + +The Azure Resource Manager Service Project will create a very basic TypeSpec file in `main.tsp`: + +```typespec +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-autorest"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +``` + +These lines import the libraries you will need to build your first service. + +**Add the following lines** to bring the models, operations, and decorators you will need into the specification: + +```typespec +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Resource.Manager; +``` diff --git a/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step05.md b/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step05.md index 5ecc944f74..e15746921b 100644 --- a/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step05.md +++ b/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step05.md @@ -17,7 +17,6 @@ Here's a complete example `main.tsp` file based on all of the snippets in this R ```typespec import "@typespec/rest"; import "@typespec/versioning"; -import "@azure-tools/typespec-providerhub"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; diff --git a/packages/website/versioned_docs/version-latest/howtos/DataPlane Generation - DPG/02client.mdx b/packages/website/versioned_docs/version-latest/howtos/DataPlane Generation - DPG/02client.mdx index 07c6eed7fb..4349842d8a 100644 --- a/packages/website/versioned_docs/version-latest/howtos/DataPlane Generation - DPG/02client.mdx +++ b/packages/website/versioned_docs/version-latest/howtos/DataPlane Generation - DPG/02client.mdx @@ -299,7 +299,7 @@ import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; -@@projectedName(PetStore, "client", "PetStoreGreatClient"); +@@clientName(PetStore, "PetStoreGreatClient"); ``` diff --git a/packages/website/versioned_docs/version-latest/howtos/DataPlane Generation - DPG/04renaming.mdx b/packages/website/versioned_docs/version-latest/howtos/DataPlane Generation - DPG/04renaming.mdx index 234886ec45..700316d813 100644 --- a/packages/website/versioned_docs/version-latest/howtos/DataPlane Generation - DPG/04renaming.mdx +++ b/packages/website/versioned_docs/version-latest/howtos/DataPlane Generation - DPG/04renaming.mdx @@ -93,10 +93,10 @@ import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; -@@projectedName(InputModel, "client", "InputOptions"); // Use InputOptions as a base name in clients -@@projectedName(InputModel, "csharp", "ParameterOptions"); // Prefer a different name for C# only +@@clientName(InputModel, "InputOptions"); // Use InputOptions as a base name in clients +@@clientName(InputModel, "ParameterOptions", "csharp"); // Prefer a different name for C# only -@@projectedName(InputModel.name, "python", "input_name"); // Python may need a different to be idiomatic +@@clientName(InputModel.name, "input_name", "python"); // Python may need a different to be idiomatic ``` @@ -143,8 +143,8 @@ import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; -@@projectedName(GetModel, "client", "ReadModel"); // Use InputOptions as a base name in clients -@@projectedName(GetModel, "python", "GetComputedModel"); // Note that Python will still snake_case it +@@clientName(GetModel, "ReadModel"); // Use InputOptions as a base name in clients +@@clientName(GetModel, "GetComputedModel", "python"); // Note that Python will still snake_case it ``` @@ -183,27 +183,22 @@ FIXME ### Order of Operations -For consistency when generating code, the order in which projections are applied is important. Code emitters should apply projections in the following order. +For consistency when generating code, the order in which overrides are applied is important. Code emitters should apply overrides in the following order. #### Over-the-Wire JSON Names For determining the final name of a TypeSpec entity when sent over-the-wire in JSON: -1. Run the `#target("json")` projection -2. Run the `#customTarget("json")` projection, if it exists -3. Apply the `@projectedName` decorator using the `getProjectedName` helper method. +1. If the `@encodedName` decorator exists, use this value +2. Use the original name in the spec #### Client SDK Names For determining the final name of a TypeSpec entity when used in a client SDK (e.g. Python): -1. Determine the name based on the client target: - 1. Run the `#target("client")` projection - 1. Run the `#customTarget("client")` projection, if it exists - 1. Apply the `@projectedName` decorator using the `getProjectedName` helper method. -1. Determine the name based on the language target: - 1. Run the `#target("python")` projection - 1. Run the `#customTarget("python")` projection, if it exists - 1. Apply the `@projectedName` decorator using the `getProjectedName` helper method. -1. If the language target name is different from the client target name, use the language target name. Otherwise, use the client name. -1. For names based on language target projections, do not alter the casing. For names based on the client target projections, apply casing heuristics appropriate for the language (for example, snake case, Pascal case, etc.). +1. Check if there's a scoped `@clientName` decorator for your emitter +2. Check if there's a `@clientName` decorator at all +3. Check the friendly name +4. Use the original name in the spec + +**Note: If the object name is from `@clientName` decorator, do not apply your language's casing rules on it. If it's not, apply your language's heuristics (i.e. for Python, apply snake casing)** diff --git a/packages/website/versioned_docs/version-latest/howtos/DataPlane Generation - DPG/05union.mdx b/packages/website/versioned_docs/version-latest/howtos/DataPlane Generation - DPG/05union.mdx index ed9bfd1af1..e28345d469 100644 --- a/packages/website/versioned_docs/version-latest/howtos/DataPlane Generation - DPG/05union.mdx +++ b/packages/website/versioned_docs/version-latest/howtos/DataPlane Generation - DPG/05union.mdx @@ -128,8 +128,7 @@ FIXME ### Merge `@sharedRoute` operations into one. -If your shared routes are actually one unique semantic operation, you may want to configure codegen to use a unique name. This is simply done by projecting -the same name on both operations. +If your shared routes are actually one unique semantic operation, you may want to configure codegen to use a unique name. This is simply done by renaming both operations to the same name using `@clientName` @@ -148,8 +147,8 @@ import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; -@@projectedName(a, "client", "Foo"); -@@projectedName(b, "client", "Foo"); +@@clientName(a, "Foo"); +@@clientName(b, "Foo"); ``` diff --git a/packages/website/versioned_docs/version-latest/howtos/migrate-swagger/_category_.json b/packages/website/versioned_docs/version-latest/howtos/migrate-swagger/_category_.json new file mode 100644 index 0000000000..ece7d1e09f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/howtos/migrate-swagger/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "Convert swagger to TypeSpec", + "link": { + "type": "generated-index" + } +} diff --git a/packages/website/versioned_docs/version-latest/howtos/migrate-swagger/get-started.md b/packages/website/versioned_docs/version-latest/howtos/migrate-swagger/get-started.md new file mode 100644 index 0000000000..187e9f2fd3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/howtos/migrate-swagger/get-started.md @@ -0,0 +1,37 @@ +# Migrate Azure API spec from swagger to TypeSpec + +We have created a swagger to TypeSpec conversion tool to help take on the bulk of the manual conversion labor. It can handle both data-plane and management-plane swaggers. The produced TypeSpec relies on the Azure.Core and Azure.Resource.Manager libraries. + +**_Important!_** Because TypeSpec is more expressive than Swagger and with the help of evolving Azure libraries, this tool should only be used as an aid in the conversion/migration process, not as the sole tool to produce final version of TypeSpec specs without human inspection, correction and optimization. + +## Steps of running the tool + +- Ensure `powershell` is installed. +- Ensure `autorest` tool is installed. [Installation guide](https://github.com/Azure/autorest/blob/main/docs/install/readme.md) +- Download conversion script [here](https://aka.ms/azsdk/openapi-to-typespec-script). +- Running the conversion tool. + +```powershell +./convert.ps1 [path to readme.md] [path to output folder] + +# OR specify parameter by name +./convert.ps1 -swaggerConfigFile [path to readme.md] -outputFolder [path to output folder] +``` + +- Review generated TypeSpec +- Layout [the TypeSpec project folders appropriately](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/typespec-structure-guidelines.md). +- Leverage standard `tspconfig.yaml` ([Template projects](https://github.com/microsoft/typespec/tree/main/eng/feeds)) and make appropriate output file name changes. +- Ensure it compiles successfully locally and then submit a PR +- Review CI checks such as breaking changes and other failures. + +## How to Get Help + +- Ask questions in the [TypeSpec Discussions Channel](https://teams.microsoft.com/l/channel/19%3a906c1efbbec54dc8949ac736633e6bdf%40thread.skype/TypeSpec%2520Discussion%2520%25F0%259F%2590%25AE?groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47) +- Attend TypeSpec office hours. The office hours is listed on top tabs on the discussion channel. +- File issues in the [typespec-azure github repo](https://github.com/azure/typespec-azure/issues) + - For bugs, please include: + - A high-level description of the bug + - Expected and Actual Results + - Repro steps, including any TypeSpec code that you used + - Any error messages you saw, including stack traces. For issues with VS or VS Code tooling see [Troubleshooting VSCode Tooling and Filing Issues](#troubleshooting-vscode-tooling-and-filing-issues) +- Schedule review meetings with TypeSpec team. diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/data-types.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/data-types.md index 1023f5acfb..e09bd0aab3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/data-types.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/data-types.md @@ -69,14 +69,14 @@ model Azure.Core.ConditionalRequestHeaders A vector embedding frequently used in similarity search. ```typespec -model Azure.Core.EmbeddingVector +model Azure.Core.EmbeddingVector ``` #### Template Parameters -| Name | Description | -| ----- | -------------------------------------- | -| TType | The data type of the embedding vector. | +| Name | Description | +| ------- | ----------------------------------------- | +| Element | The element type of the embedding vector. | ### `EtagProperty` {#Azure.Core.EtagProperty} @@ -103,6 +103,14 @@ Provides the standard 'expand' query parameter for list operations. model Azure.Core.ExpandQueryParameter ``` +### `FilterParameter` {#Azure.Core.FilterParameter} + +Provides the standard 'filter' query parameter for list operations + +```typespec +model Azure.Core.FilterParameter +``` + ### `FilterQueryParameter` {#Azure.Core.FilterQueryParameter} Provides the standard 'filter' query parameter for list operations. @@ -132,14 +140,22 @@ model Azure.Core.OrderByQueryParameter Describes a page of resource object. ```typespec -model Azure.Core.Page +model Azure.Core.Page ``` #### Template Parameters -| Name | Description | -| --------- | ------------------ | -| TResource | The resource type. | +| Name | Description | +| -------- | ------------------ | +| Resource | The resource type. | + +### `PollingOptions` {#Azure.Core.PollingOptions} + +Generic polling options for LRO operations. + +```typespec +model Azure.Core.PollingOptions +``` ### `RepeatabilityRequestHeaders` {#Azure.Core.RepeatabilityRequestHeaders} @@ -170,42 +186,42 @@ model Azure.Core.RequestIdResponseHeader Defines a property as a request parameter. ```typespec -model Azure.Core.RequestParameter +model Azure.Core.RequestParameter ``` #### Template Parameters | Name | Description | | ---- | ------------------- | -| T | The parameter name. | +| Name | The parameter name. | ### `ResourceOperationStatus` {#Azure.Core.ResourceOperationStatus} ```typespec -model Azure.Core.ResourceOperationStatus +model Azure.Core.ResourceOperationStatus ``` #### Template Parameters -| Name | Description | -| ------------- | ------------------------------------------------------------------------------------------------- | -| TResource | The resource type. | -| TStatusResult | Model describing the status result object. If not specified, the default is the resource type. | -| TStatusError | Model describing the status error object. If not specified, the default is the Foundations.Error. | +| Name | Description | +| ------------ | ------------------------------------------------------------------------------------------------- | +| Resource | The resource type. | +| StatusResult | Model describing the status result object. If not specified, the default is the resource type. | +| StatusError | Model describing the status error object. If not specified, the default is the Foundations.Error. | ### `ResponseProperty` {#Azure.Core.ResponseProperty} Defines a property as a response header. ```typespec -model Azure.Core.ResponseProperty +model Azure.Core.ResponseProperty ``` #### Template Parameters | Name | Description | | ---- | ---------------- | -| T | The header name. | +| Name | The header name. | ### `SelectQueryParameter` {#Azure.Core.SelectQueryParameter} @@ -231,6 +247,30 @@ Provides the most common query parameters for list operations. model Azure.Core.StandardListQueryParameters ``` +### `StatusMonitorOptions` {#Azure.Core.StatusMonitorOptions} + +Options for Lro status monitors. + +```typespec +model Azure.Core.StatusMonitorOptions +``` + +### `StatusMonitorPollingOptions` {#Azure.Core.StatusMonitorPollingOptions} + +Options for overriding a polling endpoint that uses a StatusMonitor + +```typespec +model Azure.Core.StatusMonitorPollingOptions +``` + +#### Template Parameters + +| Name | Description | +| ------------- | ---------------------------------------------------------------- | +| PollingModel | The model that is returned when polling should continue. | +| FinalResult | The model that is returned when polling terminates successfully. | +| FinalProperty | The property of the status monitor that contains results. | + ### `TopQueryParameter` {#Azure.Core.TopQueryParameter} Provides the standard 'top' query parameter for list operations. @@ -247,6 +287,22 @@ Supported versions of Azure.Core TypeSpec building blocks. enum Azure.Core.Versions ``` +### `PollingOptionKind` {#Azure.Core.PollingOptionKind} + +The available kinds of polling options + +```typespec +union Azure.Core.PollingOptionKind +``` + +### `RepeatabilityResult` {#Azure.Core.RepeatabilityResult} + +Repeatability Result header options + +```typespec +union Azure.Core.RepeatabilityResult +``` + ### `eTag` {#Azure.Core.eTag} The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource. @@ -327,32 +383,32 @@ model Azure.Core.Foundations.ApiVersionParameter A model containing the collection keys of the provided resource's parent resource. ```typespec -model Azure.Core.Foundations.CollectionKeysOf +model Azure.Core.Foundations.CollectionKeysOf ``` #### Template Parameters -| Name | Description | -| --------- | ------------------------- | -| TResource | The type of the resource. | +| Name | Description | +| -------- | ------------------------- | +| Resource | The type of the resource. | ### `CreateableAndUpdateableProperties` {#Azure.Core.Foundations.CreateableAndUpdateableProperties} Collection of properties from a resource that are visible to create or update scopes. ```typespec -model Azure.Core.Foundations.CreateableAndUpdateableProperties +model Azure.Core.Foundations.CreateableAndUpdateableProperties ``` #### Template Parameters -| Name | Description | -| --------- | ------------------------- | -| TResource | The type of the resource. | +| Name | Description | +| -------- | ------------------------- | +| Resource | The type of the resource. | ### `CustomizationFields` {#Azure.Core.Foundations.CustomizationFields} -The expected shape of model types passed to the TCustom parameter of operation signatures. +The expected shape of model types passed to the Custom parameter of operation signatures. ```typespec model Azure.Core.Foundations.CustomizationFields @@ -363,43 +419,43 @@ model Azure.Core.Foundations.CustomizationFields A model describing a customized page of resources. ```typespec -model Azure.Core.Foundations.CustomPage +model Azure.Core.Foundations.CustomPage ``` #### Template Parameters -| Name | Description | -| --------- | ------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits which apply to the page. | +| Name | Description | +| -------- | ------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits which apply to the page. | ### `CustomParameters` {#Azure.Core.Foundations.CustomParameters} A model describing a set of custom request parameters. ```typespec -model Azure.Core.Foundations.CustomParameters +model Azure.Core.Foundations.CustomParameters ``` #### Template Parameters -| Name | Description | -| ------- | ----------------------------------------------- | -| TCustom | An object describing custom request parameters. | +| Name | Description | +| ------ | ----------------------------------------------- | +| Custom | An object describing custom request parameters. | ### `CustomResponseFields` {#Azure.Core.Foundations.CustomResponseFields} A model describing a set of custom response properties. ```typespec -model Azure.Core.Foundations.CustomResponseFields +model Azure.Core.Foundations.CustomResponseFields ``` #### Template Parameters -| Name | Description | -| ------- | ------------------------------------------------ | -| TCustom | An object describing custom response properties. | +| Name | Description | +| ------ | ------------------------------------------------ | +| Custom | An object describing custom response properties. | ### `Error` {#Azure.Core.Foundations.Error} @@ -422,14 +478,14 @@ model Azure.Core.Foundations.ErrorResponse A response containing error details. ```typespec -model Azure.Core.Foundations.ErrorResponseBase +model Azure.Core.Foundations.ErrorResponseBase ``` #### Template Parameters -| Name | Description | -| ------ | ----------------------------- | -| TError | The type of the error object. | +| Name | Description | +| ----- | ----------------------------- | +| Error | The type of the error object. | ### `InnerError` {#Azure.Core.Foundations.InnerError} @@ -444,127 +500,127 @@ model Azure.Core.Foundations.InnerError A model containing the keys of the provided resource. ```typespec -model Azure.Core.Foundations.ItemKeysOf +model Azure.Core.Foundations.ItemKeysOf ``` #### Template Parameters -| Name | Description | -| --------- | ------------------------- | -| TResource | The type of the resource. | +| Name | Description | +| -------- | ------------------------- | +| Resource | The type of the resource. | ### `LocationOfCreatedResourceResponse` {#Azure.Core.Foundations.LocationOfCreatedResourceResponse} Response describing the location of a created resource. ```typespec -model Azure.Core.Foundations.LocationOfCreatedResourceResponse +model Azure.Core.Foundations.LocationOfCreatedResourceResponse ``` #### Template Parameters -| Name | Description | -| ---- | --------------------------------- | -| T | The type of the created resource. | +| Name | Description | +| -------- | ----------- | +| Resource | | ### `LocationOfCreatedResourceWithServiceProvidedNameResponse` {#Azure.Core.Foundations.LocationOfCreatedResourceWithServiceProvidedNameResponse} Response describing the location of a resource created with a service-provided name. ```typespec -model Azure.Core.Foundations.LocationOfCreatedResourceWithServiceProvidedNameResponse +model Azure.Core.Foundations.LocationOfCreatedResourceWithServiceProvidedNameResponse ``` #### Template Parameters -| Name | Description | -| ---- | --------------------------------- | -| T | The type of the created resource. | +| Name | Description | +| -------- | ----------- | +| Resource | | ### `LongRunningStatusLocation` {#Azure.Core.Foundations.LongRunningStatusLocation} Metadata for long running operation status monitor locations. ```typespec -model Azure.Core.Foundations.LongRunningStatusLocation +model Azure.Core.Foundations.LongRunningStatusLocation ``` #### Template Parameters -| Name | Description | -| ------------- | ---------------------------------------- | -| TStatusResult | The type of the operation status result. | +| Name | Description | +| ------------ | ---------------------------------------- | +| StatusResult | The type of the operation status result. | ### `OperationStatus` {#Azure.Core.Foundations.OperationStatus} Provides status details for long running operations. ```typespec -model Azure.Core.Foundations.OperationStatus +model Azure.Core.Foundations.OperationStatus ``` #### Template Parameters -| Name | Description | -| ------------- | ----------------------------------------------------------------------------------- | -| TStatusResult | The type of the operation status result. | -| TStatusError | The type of the operation status error. If not provided, the default error is used. | +| Name | Description | +| ------------ | ----------------------------------------------------------------------------------- | +| StatusResult | The type of the operation status result. | +| StatusError | The type of the operation status error. If not provided, the default error is used. | ### `ResourceBody` {#Azure.Core.Foundations.ResourceBody} Conveys the resource instance to an operation as a request body. ```typespec -model Azure.Core.Foundations.ResourceBody +model Azure.Core.Foundations.ResourceBody ``` #### Template Parameters -| Name | Description | -| ---- | ---------------------------------- | -| T | The type of the resource instance. | +| Name | Description | +| -------- | ---------------------------------- | +| Resource | The type of the resource instance. | ### `ResourceCreateOrReplaceModel` {#Azure.Core.Foundations.ResourceCreateOrReplaceModel} Version of a model for a create or replace operation which only includes updateable properties. ```typespec -model Azure.Core.Foundations.ResourceCreateOrReplaceModel +model Azure.Core.Foundations.ResourceCreateOrReplaceModel ``` #### Template Parameters -| Name | Description | -| --------- | ------------------------- | -| TResource | The type of the resource. | +| Name | Description | +| -------- | ------------------------- | +| Resource | The type of the resource. | ### `ResourceCreateOrUpdateModel` {#Azure.Core.Foundations.ResourceCreateOrUpdateModel} Version of a model for a create or update operation which only includes updateable properties. ```typespec -model Azure.Core.Foundations.ResourceCreateOrUpdateModel +model Azure.Core.Foundations.ResourceCreateOrUpdateModel ``` #### Template Parameters -| Name | Description | -| --------- | ------------------------- | -| TResource | The type of the resource. | +| Name | Description | +| -------- | ------------------------- | +| Resource | The type of the resource. | ### `ResourceUpdateModel` {#Azure.Core.Foundations.ResourceUpdateModel} Version of a model for an update operation which only includes updateable properties. ```typespec -model Azure.Core.Foundations.ResourceUpdateModel +model Azure.Core.Foundations.ResourceUpdateModel ``` #### Template Parameters -| Name | Description | -| --------- | ------------------------- | -| TResource | The type of the resource. | +| Name | Description | +| -------- | ------------------------- | +| Resource | The type of the resource. | ### `RetryAfterHeader` {#Azure.Core.Foundations.RetryAfterHeader} @@ -589,14 +645,14 @@ enum Azure.Core.Foundations.OperationState Declares a trait that is applied as a query parameter for list operations. ```typespec -model Azure.Core.Traits.ListQueryParametersTrait +model Azure.Core.Traits.ListQueryParametersTrait ``` #### Template Parameters -| Name | Description | -| ------- | --------------------------------------- | -| TParams | Object describing the query parameters. | +| Name | Description | +| ---------- | --------------------------------------- | +| Parameters | Object describing the query parameters. | ### `NoClientRequestId` {#Azure.Core.Traits.NoClientRequestId} @@ -627,29 +683,29 @@ model Azure.Core.Traits.NoRepeatableRequests Declares a trait that is applied as a query parameter. ```typespec -model Azure.Core.Traits.QueryParametersTrait +model Azure.Core.Traits.QueryParametersTrait ``` #### Template Parameters -| Name | Description | -| -------- | ---------------------------------------------- | -| TParams | The name of the query parameter. | -| Contexts | The contexts in which the trait is applicable. | +| Name | Description | +| ---------- | ---------------------------------------------- | +| Parameters | The name of the query parameter. | +| Contexts | The contexts in which the trait is applicable. | ### `RequestHeadersTrait` {#Azure.Core.Traits.RequestHeadersTrait} Declares a trait that is applied as a request header parameter. ```typespec -model Azure.Core.Traits.RequestHeadersTrait +model Azure.Core.Traits.RequestHeadersTrait ``` #### Template Parameters | Name | Description | | -------- | ------------------------------------------------ | -| THeaders | Object describing the request header parameters. | +| Headers | Object describing the request header parameters. | | Contexts | The contexts in which the trait is applicable. | ### `ResponseHeadersTrait` {#Azure.Core.Traits.ResponseHeadersTrait} @@ -657,14 +713,14 @@ model Azure.Core.Traits.RequestHeadersTrait Declares a trait that is applied as a response header parameter. ```typespec -model Azure.Core.Traits.ResponseHeadersTrait +model Azure.Core.Traits.ResponseHeadersTrait ``` #### Template Parameters | Name | Description | | -------- | ------------------------------------------------- | -| THeaders | Object describing the response header parameters. | +| Headers | Object describing the response header parameters. | | Contexts | The contexts in which the trait is applicable. | ### `SupportsClientRequestId` {#Azure.Core.Traits.SupportsClientRequestId} @@ -672,42 +728,42 @@ model Azure.Core.Traits.ResponseHeadersTrait Provides clientRequestId headers for requests and responses. ```typespec -model Azure.Core.Traits.SupportsClientRequestId +model Azure.Core.Traits.SupportsClientRequestId ``` #### Template Parameters -| Name | Description | -| ------------- | ------------------------------------------------------------------------------------------------------------------ | -| TVersionAdded | The version when the trait was added to the specification.
Leave this empty if the trait is always supported. | +| Name | Description | +| ------------ | ------------------------------------------------------------------------------------------------------------------ | +| VersionAdded | The version when the trait was added to the specification.
Leave this empty if the trait is always supported. | ### `SupportsConditionalRequests` {#Azure.Core.Traits.SupportsConditionalRequests} Provides conditional request headers for requests and ETag headers for responses. ```typespec -model Azure.Core.Traits.SupportsConditionalRequests +model Azure.Core.Traits.SupportsConditionalRequests ``` #### Template Parameters -| Name | Description | -| ------------- | ------------------------------------------------------------------------------------------------------------------ | -| TVersionAdded | The version when the trait was added to the specification.
Leave this empty if the trait is always supported. | +| Name | Description | +| ------------ | ------------------------------------------------------------------------------------------------------------------ | +| VersionAdded | The version when the trait was added to the specification.
Leave this empty if the trait is always supported. | ### `SupportsRepeatableRequests` {#Azure.Core.Traits.SupportsRepeatableRequests} Provides repeatable request headers for requests and responses. ```typespec -model Azure.Core.Traits.SupportsRepeatableRequests +model Azure.Core.Traits.SupportsRepeatableRequests ``` #### Template Parameters -| Name | Description | -| ------------- | ------------------------------------------------------------------------------------------------------------------ | -| TVersionAdded | The version when the trait was added to the specification.
Leave this empty if the trait is always supported. | +| Name | Description | +| ------------ | ------------------------------------------------------------------------------------------------------------------ | +| VersionAdded | The version when the trait was added to the specification.
Leave this empty if the trait is always supported. | ### `TraitOverride` {#Azure.Core.Traits.TraitOverride} @@ -728,14 +784,14 @@ model Azure.Core.Traits.TraitOverride Declares a version parameter trait. ```typespec -model Azure.Core.Traits.VersionParameterTrait +model Azure.Core.Traits.VersionParameterTrait ``` #### Template Parameters -| Name | Description | -| ----------------- | ---------------------------------- | -| TVersionParameter | The type of the version parameter. | +| Name | Description | +| ---------------- | ---------------------------------- | +| VersionParameter | The type of the version parameter. | ### `TraitContext` {#Azure.Core.Traits.TraitContext} diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/decorators.md index 3dc862576b..1a5226d6f7 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/decorators.md @@ -13,7 +13,7 @@ toc_max_heading_level: 3 Identifies a ModelProperty as containing the final location for the operation result. ```typespec -@Azure.Core.finalLocation +@Azure.Core.finalLocation(finalResult?: Model | void) ``` #### Target @@ -22,7 +22,9 @@ Identifies a ModelProperty as containing the final location for the operation re #### Parameters -None +| Name | Type | Description | +| ----------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| finalResult | `union Model \| void` | Sets the expected return value for the final result. Overrides
any value provided in the decorated property, if the property uses ResourceLocation. | ### `@finalOperation` {#@Azure.Core.finalOperation} @@ -38,10 +40,10 @@ Identifies that an operation is the final operation for an LRO. #### Parameters -| Name | Type | Description | -| --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------- | -| linkedOperation | `Operation` | The linked Operation | -| parameters | `model {}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | +| Name | Type | Description | +| --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | +| linkedOperation | `Operation` | The linked Operation | +| parameters | `model {}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | ### `@fixed` {#@Azure.Core.fixed} @@ -211,10 +213,10 @@ Identifies that an operation is used to retrieve the next page for paged operati #### Parameters -| Name | Type | Description | -| --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------- | -| linkedOperation | `Operation` | The linked Operation | -| parameters | `model {}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | +| Name | Type | Description | +| --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | +| linkedOperation | `Operation` | The linked Operation | +| parameters | `model {}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | ### `@operationLink` {#@Azure.Core.operationLink} @@ -230,11 +232,11 @@ Identifies an operation that is linked to the target operation. #### Parameters -| Name | Type | Description | -| --------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------- | -| linkedOperation | `Operation` | The linked Operation | -| linkType | `valueof scalar string` | A string indicating the role of the linked operation | -| parameters | `model {}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | +| Name | Type | Description | +| --------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| linkedOperation | `Operation` | The linked Operation | +| linkType | `valueof scalar string` | A string indicating the role of the linked operation | +| parameters | `model {}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | ### `@pagedResult` {#@Azure.Core.pagedResult} @@ -257,7 +259,7 @@ None Identifies a model property as containing the location to poll for operation state. ```typespec -@Azure.Core.pollingLocation +@Azure.Core.pollingLocation(options?: Azure.Core.PollingOptions) ``` #### Target @@ -266,7 +268,9 @@ Identifies a model property as containing the location to poll for operation sta #### Parameters -None +| Name | Type | Description | +| ------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| options | `model Azure.Core.PollingOptions` | PollingOptions for the poller pointed to by this link. Overrides
settings derived from property value it is decorating, if the value of the
property is ResourceLocation | ### `@pollingOperation` {#@Azure.Core.pollingOperation} @@ -282,10 +286,10 @@ Identifies that an operation is a polling operation for an LRO. #### Parameters -| Name | Type | Description | -| --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------- | -| linkedOperation | `Operation` | The linked Operation | -| parameters | `model {}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | +| Name | Type | Description | +| --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | +| linkedOperation | `Operation` | The linked Operation | +| parameters | `model {}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | ### `@pollingOperationParameter` {#@Azure.Core.pollingOperationParameter} diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/index.mdx b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/index.mdx index ad9d93cd80..7a229a0923 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/index.mdx +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/index.mdx @@ -91,10 +91,12 @@ npm install --save-peer @azure-tools/typespec-azure-core - [`EtagProperty`](./data-types.md#Azure.Core.EtagProperty) - [`EtagResponseEnvelope`](./data-types.md#Azure.Core.EtagResponseEnvelope) - [`ExpandQueryParameter`](./data-types.md#Azure.Core.ExpandQueryParameter) +- [`FilterParameter`](./data-types.md#Azure.Core.FilterParameter) - [`FilterQueryParameter`](./data-types.md#Azure.Core.FilterQueryParameter) - [`MaxPageSizeQueryParameter`](./data-types.md#Azure.Core.MaxPageSizeQueryParameter) - [`OrderByQueryParameter`](./data-types.md#Azure.Core.OrderByQueryParameter) - [`Page`](./data-types.md#Azure.Core.Page) +- [`PollingOptions`](./data-types.md#Azure.Core.PollingOptions) - [`RepeatabilityRequestHeaders`](./data-types.md#Azure.Core.RepeatabilityRequestHeaders) - [`RepeatabilityResponseHeaders`](./data-types.md#Azure.Core.RepeatabilityResponseHeaders) - [`RequestIdResponseHeader`](./data-types.md#Azure.Core.RequestIdResponseHeader) @@ -104,6 +106,8 @@ npm install --save-peer @azure-tools/typespec-azure-core - [`SelectQueryParameter`](./data-types.md#Azure.Core.SelectQueryParameter) - [`SkipQueryParameter`](./data-types.md#Azure.Core.SkipQueryParameter) - [`StandardListQueryParameters`](./data-types.md#Azure.Core.StandardListQueryParameters) +- [`StatusMonitorOptions`](./data-types.md#Azure.Core.StatusMonitorOptions) +- [`StatusMonitorPollingOptions`](./data-types.md#Azure.Core.StatusMonitorPollingOptions) - [`TopQueryParameter`](./data-types.md#Azure.Core.TopQueryParameter) ## Azure.Core.Foundations diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/interfaces.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/interfaces.md index 32382e76e8..f163f82fd9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/interfaces.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/interfaces.md @@ -13,7 +13,7 @@ toc_max_heading_level: 3 Interface containing common resource operations. ```typespec -interface Azure.Core.ResourceOperations +interface Azure.Core.ResourceOperations ``` #### Template Parameters @@ -21,276 +21,276 @@ interface Azure.Core.ResourceOperations | Name | Description | | --------------- | --------------------------------------------------------------------------------------- | | InterfaceTraits | Traits applicable to the operations. | -| TErrorResponse | Error response of the operations. If not specified, the default error response is used. | +| ErrorResponse | Error response of the operations. If not specified, the default error response is used. | #### `ResourceOperations.ResourceCreateOrReplace` {#Azure.Core.ResourceOperations.ResourceCreateOrReplace} Create or replace operation template. ```typespec -op Azure.Core.ResourceOperations.ResourceCreateOrReplace(apiVersion: string, resource: TResource): (anonymous model) | (anonymous model) | TErrorResponse +op Azure.Core.ResourceOperations.ResourceCreateOrReplace(apiVersion: string, resource: Resource): (anonymous model) | (anonymous model) | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| --------- | ---------------------------------------------- | -| TResource | Resource type. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| -------- | ---------------------------------------------- | +| Resource | Resource type. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.LongRunningResourceCreateOrReplace` {#Azure.Core.ResourceOperations.LongRunningResourceCreateOrReplace} Long-running resource create or replace operation template. ```typespec -op Azure.Core.ResourceOperations.LongRunningResourceCreateOrReplace(apiVersion: string, resource: TResource): (anonymous model) | (anonymous model) | TErrorResponse +op Azure.Core.ResourceOperations.LongRunningResourceCreateOrReplace(apiVersion: string, resource: Resource): (anonymous model) | (anonymous model) | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| --------- | ---------------------------------------------- | -| TResource | Resource type. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| -------- | ---------------------------------------------- | +| Resource | Resource type. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.ResourceCreateOrUpdate` {#Azure.Core.ResourceOperations.ResourceCreateOrUpdate} Create or update operation template. ```typespec -op Azure.Core.ResourceOperations.ResourceCreateOrUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: TResource): (anonymous model) | (anonymous model) | TErrorResponse +op Azure.Core.ResourceOperations.ResourceCreateOrUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | (anonymous model) | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| --------- | ---------------------------------------------- | -| TResource | Resource type. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| -------- | ---------------------------------------------- | +| Resource | Resource type. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.LongRunningResourceCreateOrUpdate` {#Azure.Core.ResourceOperations.LongRunningResourceCreateOrUpdate} Long-running resource create or update operation template. ```typespec -op Azure.Core.ResourceOperations.LongRunningResourceCreateOrUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: TResource): (anonymous model) | (anonymous model) | TErrorResponse +op Azure.Core.ResourceOperations.LongRunningResourceCreateOrUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | (anonymous model) | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| --------- | ---------------------------------------------- | -| TResource | Resource type. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| -------- | ---------------------------------------------- | +| Resource | Resource type. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.ResourceUpdate` {#Azure.Core.ResourceOperations.ResourceUpdate} Resource update operation template. ```typespec -op Azure.Core.ResourceOperations.ResourceUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: TResource): (anonymous model) | TErrorResponse +op Azure.Core.ResourceOperations.ResourceUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| --------- | ---------------------------------------------- | -| TResource | Resource type. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| -------- | ---------------------------------------------- | +| Resource | Resource type. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.ResourceCreateWithServiceProvidedName` {#Azure.Core.ResourceOperations.ResourceCreateWithServiceProvidedName} Resource create with service-provided name operation template. ```typespec -op Azure.Core.ResourceOperations.ResourceCreateWithServiceProvidedName(apiVersion: string, resource: TResource): Azure.Core.(anonymous model) | TErrorResponse +op Azure.Core.ResourceOperations.ResourceCreateWithServiceProvidedName(apiVersion: string, resource: Resource): Azure.Core.(anonymous model) | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| --------- | ---------------------------------------------- | -| TResource | Resource type. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| -------- | ---------------------------------------------- | +| Resource | Resource type. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.LongRunningResourceCreateWithServiceProvidedName` {#Azure.Core.ResourceOperations.LongRunningResourceCreateWithServiceProvidedName} Long-running resource create with service-provided name operation template. ```typespec -op Azure.Core.ResourceOperations.LongRunningResourceCreateWithServiceProvidedName(apiVersion: string, resource: TResource): Azure.Core.(anonymous model) | TErrorResponse +op Azure.Core.ResourceOperations.LongRunningResourceCreateWithServiceProvidedName(apiVersion: string, resource: Resource): Azure.Core.(anonymous model) | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| --------- | ---------------------------------------------- | -| TResource | Resource type. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| -------- | ---------------------------------------------- | +| Resource | Resource type. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.ResourceRead` {#Azure.Core.ResourceOperations.ResourceRead} Resource read operation template. ```typespec -op Azure.Core.ResourceOperations.ResourceRead(apiVersion: string): {} | TErrorResponse +op Azure.Core.ResourceOperations.ResourceRead(apiVersion: string): {} | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| --------- | ---------------------------------------------- | -| TResource | Resource type. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| -------- | ---------------------------------------------- | +| Resource | Resource type. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.ResourceDelete` {#Azure.Core.ResourceOperations.ResourceDelete} Resource delete operation template. ```typespec -op Azure.Core.ResourceOperations.ResourceDelete(apiVersion: string): Azure.Core.(anonymous model) | TErrorResponse +op Azure.Core.ResourceOperations.ResourceDelete(apiVersion: string): Azure.Core.(anonymous model) | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| --------- | ---------------------------------------------- | -| TResource | Resource type. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| -------- | ---------------------------------------------- | +| Resource | Resource type. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.LongRunningResourceDelete` {#Azure.Core.ResourceOperations.LongRunningResourceDelete} Long-running resource delete operation template. ```typespec -op Azure.Core.ResourceOperations.LongRunningResourceDelete(apiVersion: string): (anonymous model) | TErrorResponse +op Azure.Core.ResourceOperations.LongRunningResourceDelete(apiVersion: string): (anonymous model) | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| --------- | ---------------------------------------------- | -| TResource | Resource type. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| -------- | ---------------------------------------------- | +| Resource | Resource type. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.ResourceList` {#Azure.Core.ResourceOperations.ResourceList} Resource list operation template. ```typespec -op Azure.Core.ResourceOperations.ResourceList(apiVersion: string): Azure.Core.Foundations.CustomPage | TErrorResponse +op Azure.Core.ResourceOperations.ResourceList(apiVersion: string): Azure.Core.Foundations.CustomPage | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| --------- | ---------------------------------------------- | -| TResource | Resource type. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| -------- | ---------------------------------------------- | +| Resource | Resource type. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.ResourceAction` {#Azure.Core.ResourceOperations.ResourceAction} Resource action operation template. ```typespec -op Azure.Core.ResourceOperations.ResourceAction(apiVersion: string): {} | TErrorResponse +op Azure.Core.ResourceOperations.ResourceAction(apiVersion: string): {} | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| --------- | -------------------------------------------------- | -| TResource | Resource type. | -| TParams | Object describing the parameters of the operation. | -| TResponse | Object describing the response of the operation. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| ---------- | -------------------------------------------------- | +| Resource | Resource type. | +| Parameters | Object describing the parameters of the operation. | +| Response | Object describing the response of the operation. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.ResourceCollectionAction` {#Azure.Core.ResourceOperations.ResourceCollectionAction} Resource collection action operation template. ```typespec -op Azure.Core.ResourceOperations.ResourceCollectionAction(apiVersion: string): {} | TErrorResponse +op Azure.Core.ResourceOperations.ResourceCollectionAction(apiVersion: string): {} | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| --------- | -------------------------------------------------- | -| TResource | Resource type. | -| TParams | Object describing the parameters of the operation. | -| TResponse | Object describing the response of the operation. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| ---------- | -------------------------------------------------- | +| Resource | Resource type. | +| Parameters | Object describing the parameters of the operation. | +| Response | Object describing the response of the operation. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.LongRunningResourceAction` {#Azure.Core.ResourceOperations.LongRunningResourceAction} Long-running resource action operation template. ```typespec -op Azure.Core.ResourceOperations.LongRunningResourceAction(apiVersion: string): Azure.Core.(anonymous model) | TErrorResponse +op Azure.Core.ResourceOperations.LongRunningResourceAction(apiVersion: string): Azure.Core.(anonymous model) | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| ------------- | ----------------------------------------------------- | -| TResource | Resource type. | -| TParams | Object describing the parameters of the operation. | -| TStatusResult | Object describing the status result of the operation. | -| TStatusError | Object describing the status error of the operation. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| ------------ | ----------------------------------------------------- | +| Resource | Resource type. | +| Parameters | Object describing the parameters of the operation. | +| StatusResult | Object describing the status result of the operation. | +| StatusError | Object describing the status error of the operation. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.LongRunningResourceCollectionAction` {#Azure.Core.ResourceOperations.LongRunningResourceCollectionAction} Long-running resource collection action operation template. ```typespec -op Azure.Core.ResourceOperations.LongRunningResourceCollectionAction(apiVersion: string): Azure.Core.(anonymous model) | TErrorResponse +op Azure.Core.ResourceOperations.LongRunningResourceCollectionAction(apiVersion: string): Azure.Core.(anonymous model) | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| ------------- | ----------------------------------------------------- | -| TResource | Resource type. | -| TParams | Object describing the parameters of the operation. | -| TStatusResult | Object describing the status result of the operation. | -| TStatusError | Object describing the status error of the operation. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| ------------ | ----------------------------------------------------- | +| Resource | Resource type. | +| Parameters | Object describing the parameters of the operation. | +| StatusResult | Object describing the status result of the operation. | +| StatusError | Object describing the status error of the operation. | +| Traits | Object describing the traits of the operation. | #### `ResourceOperations.GetResourceOperationStatus` {#Azure.Core.ResourceOperations.GetResourceOperationStatus} Resource operation status operation template. ```typespec -op Azure.Core.ResourceOperations.GetResourceOperationStatus(apiVersion: string, operationId: string): Azure.Core.ResourceOperationStatus | TErrorResponse +op Azure.Core.ResourceOperations.GetResourceOperationStatus(apiVersion: string, operationId: string): Azure.Core.ResourceOperationStatus | ErrorResponse ``` ##### Template Parameters -| Name | Description | -| ------------- | ----------------------------------------------------- | -| TResource | Resource type. | -| TStatusResult | Object describing the status result of the operation. | -| TStatusError | Object describing the status error of the operation. | -| Traits | Object describing the traits of the operation. | +| Name | Description | +| ------------ | ----------------------------------------------------- | +| Resource | Resource type. | +| StatusResult | Object describing the status result of the operation. | +| StatusError | Object describing the status error of the operation. | +| Traits | Object describing the traits of the operation. | ### `GetResourceOperationStatus` {#Azure.Core.GetResourceOperationStatus} Operation signature to retrieve a resource operation status. ```typespec -op Azure.Core.GetResourceOperationStatus(apiVersion: string, operationId: string): Azure.Core.ResourceOperationStatus | Azure.Core.Foundations.ErrorResponse +op Azure.Core.GetResourceOperationStatus(apiVersion: string, operationId: string): Azure.Core.ResourceOperationStatus | Azure.Core.Foundations.ErrorResponse ``` #### Template Parameters -| Name | Description | -| ------------- | ----------------------------------------------------------------------------------------------------- | -| TResource | The type of the resource. | -| TStatusResult | Object describing the result of the status operation. | -| TStatusError | Object describing the error of the status operation. If not provided, the default error type is used. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| ------------ | ----------------------------------------------------------------------------------------------------- | +| Resource | The type of the resource. | +| StatusResult | Object describing the result of the status operation. | +| StatusError | Object describing the error of the status operation. If not provided, the default error type is used. | +| Traits | Traits to apply to the operation. | ### `LongRunningResourceAction` {#Azure.Core.LongRunningResourceAction} @@ -306,13 +306,13 @@ op Azure.Core.LongRunningResourceAction(apiVersion: string): Azure.Core.(anonymo #### Template Parameters -| Name | Description | -| ------------- | ----------------------------------------------------------------------------------------------------- | -| TResource | The type of the resource. | -| TParams | Object describing the request parameters. | -| TStatusResult | Object describing the result of the status operation. | -| TStatusError | Object describing the error of the status operation. If not provided, the default error type is used. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| ------------ | ----------------------------------------------------------------------------------------------------- | +| Resource | The type of the resource. | +| Parameters | Object describing the request parameters. | +| StatusResult | Object describing the result of the status operation. | +| StatusError | Object describing the error of the status operation. If not provided, the default error type is used. | +| Traits | Traits to apply to the operation. | ### `LongRunningResourceCollectionAction` {#Azure.Core.LongRunningResourceCollectionAction} @@ -328,13 +328,13 @@ op Azure.Core.LongRunningResourceCollectionAction(apiVersion: string): Azure.Cor #### Template Parameters -| Name | Description | -| ------------- | ----------------------------------------------------------------------------------------------------- | -| TResource | The type of the resource. | -| TParams | Object describing the request parameters. | -| TStatusResult | Object describing the result of the status operation. | -| TStatusError | Object describing the error of the status operation. If not provided, the default error type is used. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| ------------ | ----------------------------------------------------------------------------------------------------- | +| Resource | The type of the resource. | +| Parameters | Object describing the request parameters. | +| StatusResult | Object describing the result of the status operation. | +| StatusError | Object describing the error of the status operation. If not provided, the default error type is used. | +| Traits | Traits to apply to the operation. | ### `LongRunningResourceCreateOrReplace` {#Azure.Core.LongRunningResourceCreateOrReplace} @@ -345,15 +345,15 @@ See https://azure.github.io/typespec-azure/docs/getstarted/azure-core/step05#def Long-running operation signature to create or replace a resource. ```typespec -op Azure.Core.LongRunningResourceCreateOrReplace(apiVersion: string, resource: TResource): (anonymous model) | (anonymous model) | Azure.Core.Foundations.ErrorResponse +op Azure.Core.LongRunningResourceCreateOrReplace(apiVersion: string, resource: Resource): (anonymous model) | (anonymous model) | Azure.Core.Foundations.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------- | --------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| -------- | --------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits to apply to the operation. | ### `LongRunningResourceCreateOrUpdate` {#Azure.Core.LongRunningResourceCreateOrUpdate} @@ -364,15 +364,15 @@ See https://azure.github.io/typespec-azure/docs/getstarted/azure-core/step05#def Long-running operation signature to create or update a resource. ```typespec -op Azure.Core.LongRunningResourceCreateOrUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: TResource): (anonymous model) | (anonymous model) | Azure.Core.Foundations.ErrorResponse +op Azure.Core.LongRunningResourceCreateOrUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | (anonymous model) | Azure.Core.Foundations.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------- | --------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| -------- | --------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits to apply to the operation. | ### `LongRunningResourceCreateWithServiceProvidedName` {#Azure.Core.LongRunningResourceCreateWithServiceProvidedName} @@ -383,15 +383,15 @@ See https://azure.github.io/typespec-azure/docs/getstarted/azure-core/step05#def Long-running operation signature to create a resource with a service-provided name. ```typespec -op Azure.Core.LongRunningResourceCreateWithServiceProvidedName(apiVersion: string, resource: TResource): Azure.Core.(anonymous model) | Azure.Core.Foundations.ErrorResponse +op Azure.Core.LongRunningResourceCreateWithServiceProvidedName(apiVersion: string, resource: Resource): Azure.Core.(anonymous model) | Azure.Core.Foundations.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------- | --------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| -------- | --------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits to apply to the operation. | ### `LongRunningResourceDelete` {#Azure.Core.LongRunningResourceDelete} @@ -407,30 +407,30 @@ op Azure.Core.LongRunningResourceDelete(apiVersion: string): (anonymous model) | #### Template Parameters -| Name | Description | -| --------- | --------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| -------- | --------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits to apply to the operation. | ### `LongRunningRpcOperation` {#Azure.Core.LongRunningRpcOperation} A long-running remote procedure call (RPC) operation. ```typespec -op Azure.Core.LongRunningRpcOperation(apiVersion: string): Azure.Core.(anonymous model) | TErrorResponse +op Azure.Core.LongRunningRpcOperation(apiVersion: string): Azure.Core.(anonymous model) | ErrorResponse ``` #### Template Parameters -| Name | Description | -| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| TParams | Object describing the parameters of the operation. | -| TResponse | Object describing the response of the operation. | -| TStatusResult | Object describing the status result of the operation. | -| TStatusError | Error response of the status operation. If not specified, the default error response is used. | -| Traits | Object describing the traits of the operation. | -| TErrorResponse | Error response of the operation. If not specified, the default error response is used. | -| TraitContexts | Trait contexts applicable to the operation. Defaults to `TraitContext.Undefined` which means that only traits that always apply will appear. Can specify multiple using the \| operator. | +| Name | Description | +| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Parameters | Object describing the parameters of the operation. | +| Response | Object describing the response of the operation. | +| StatusResult | Object describing the status result of the operation. | +| StatusError | Error response of the status operation. If not specified, the default error response is used. | +| Traits | Object describing the traits of the operation. | +| ErrorResponse | Error response of the operation. If not specified, the default error response is used. | +| TraitContexts | Trait contexts applicable to the operation. Defaults to `TraitContext.Undefined` which means that only traits that always apply will appear. Can specify multiple using the \| operator. | ### `ResourceAction` {#Azure.Core.ResourceAction} @@ -446,12 +446,12 @@ op Azure.Core.ResourceAction(apiVersion: string): {} | Azure.Core.Foundations.Er #### Template Parameters -| Name | Description | -| --------- | ------------------------------------------ | -| TResource | The type of the resource. | -| TParams | Object describing the request parameters. | -| TResponse | Object describing the response parameters. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| ---------- | ------------------------------------------ | +| Resource | The type of the resource. | +| Parameters | Object describing the request parameters. | +| Response | Object describing the response parameters. | +| Traits | Traits to apply to the operation. | ### `ResourceCollectionAction` {#Azure.Core.ResourceCollectionAction} @@ -467,12 +467,12 @@ op Azure.Core.ResourceCollectionAction(apiVersion: string): {} | Azure.Core.Foun #### Template Parameters -| Name | Description | -| --------- | ------------------------------------------ | -| TResource | The type of the resource. | -| TParams | Object describing the request parameters. | -| TResponse | Object describing the response parameters. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| ---------- | ------------------------------------------ | +| Resource | The type of the resource. | +| Parameters | Object describing the request parameters. | +| Response | Object describing the response parameters. | +| Traits | Traits to apply to the operation. | ### `ResourceCreateOrReplace` {#Azure.Core.ResourceCreateOrReplace} @@ -483,15 +483,15 @@ See https://azure.github.io/typespec-azure/docs/getstarted/azure-core/step05#def Operation signature to create or replace a resource. ```typespec -op Azure.Core.ResourceCreateOrReplace(apiVersion: string, resource: TResource): (anonymous model) | (anonymous model) | Azure.Core.Foundations.ErrorResponse +op Azure.Core.ResourceCreateOrReplace(apiVersion: string, resource: Resource): (anonymous model) | (anonymous model) | Azure.Core.Foundations.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------- | --------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| -------- | --------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits to apply to the operation. | ### `ResourceCreateOrUpdate` {#Azure.Core.ResourceCreateOrUpdate} @@ -502,15 +502,15 @@ See https://azure.github.io/typespec-azure/docs/getstarted/azure-core/step05#def Operation signature to create or update a resource. ```typespec -op Azure.Core.ResourceCreateOrUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: TResource): (anonymous model) | (anonymous model) | Azure.Core.Foundations.ErrorResponse +op Azure.Core.ResourceCreateOrUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | (anonymous model) | Azure.Core.Foundations.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------- | --------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| -------- | --------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits to apply to the operation. | ### `ResourceCreateWithServiceProvidedName` {#Azure.Core.ResourceCreateWithServiceProvidedName} @@ -521,15 +521,15 @@ See https://azure.github.io/typespec-azure/docs/getstarted/azure-core/step05#def Operation signature to synchronously create a resource with a service-provided name. ```typespec -op Azure.Core.ResourceCreateWithServiceProvidedName(apiVersion: string, resource: TResource): Azure.Core.(anonymous model) | Azure.Core.Foundations.ErrorResponse +op Azure.Core.ResourceCreateWithServiceProvidedName(apiVersion: string, resource: Resource): Azure.Core.(anonymous model) | Azure.Core.Foundations.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------- | --------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| -------- | --------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits to apply to the operation. | ### `ResourceDelete` {#Azure.Core.ResourceDelete} @@ -545,10 +545,10 @@ op Azure.Core.ResourceDelete(apiVersion: string): Azure.Core.(anonymous model) | #### Template Parameters -| Name | Description | -| --------- | --------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| -------- | --------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits to apply to the operation. | ### `ResourceList` {#Azure.Core.ResourceList} @@ -559,15 +559,15 @@ See https://azure.github.io/typespec-azure/docs/getstarted/azure-core/step05#def Operation signature to list resources in a paginated way. ```typespec -op Azure.Core.ResourceList(apiVersion: string): Azure.Core.Foundations.CustomPage | Azure.Core.Foundations.ErrorResponse +op Azure.Core.ResourceList(apiVersion: string): Azure.Core.Foundations.CustomPage | Azure.Core.Foundations.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------- | --------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| -------- | --------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits to apply to the operation. | ### `ResourceRead` {#Azure.Core.ResourceRead} @@ -583,10 +583,10 @@ op Azure.Core.ResourceRead(apiVersion: string): {} | Azure.Core.Foundations.Erro #### Template Parameters -| Name | Description | -| --------- | --------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| -------- | --------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits to apply to the operation. | ### `ResourceUpdate` {#Azure.Core.ResourceUpdate} @@ -596,33 +596,33 @@ See https://azure.github.io/typespec-azure/docs/getstarted/azure-core/step05#def Operation signature to update a resource. ```typespec -op Azure.Core.ResourceUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: TResource): (anonymous model) | Azure.Core.Foundations.ErrorResponse +op Azure.Core.ResourceUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | Azure.Core.Foundations.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------- | --------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits to apply to the operation. | +| Name | Description | +| -------- | --------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits to apply to the operation. | ### `RpcOperation` {#Azure.Core.RpcOperation} A remote procedure call (RPC) operation. ```typespec -op Azure.Core.RpcOperation(apiVersion: string): {} | TErrorResponse +op Azure.Core.RpcOperation(apiVersion: string): {} | ErrorResponse ``` #### Template Parameters -| Name | Description | -| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| TParams | Object describing the parameters of the operation. | -| TResponse | Object describing the response of the operation. | -| Traits | Object describing the traits of the operation. | -| TErrorResponse | Error response of the operation. If not specified, the default error response is used. | -| TraitContexts | Trait contexts applicable to the operation. Defaults to `TraitContext.Undefined` which means that only traits that always apply will appear. Can specify multiple using the \| operator. | +| Name | Description | +| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Parameters | Object describing the parameters of the operation. | +| Response | Object describing the response of the operation. | +| Traits | Object describing the traits of the operation. | +| ErrorResponse | Error response of the operation. If not specified, the default error response is used. | +| TraitContexts | Trait contexts applicable to the operation. Defaults to `TraitContext.Undefined` which means that only traits that always apply will appear. Can specify multiple using the \| operator. | ## Azure.Core.Foundations @@ -631,135 +631,135 @@ op Azure.Core.RpcOperation(apiVersion: string): {} | TErrorResponse Operation that returns the status of another operation. ```typespec -op Azure.Core.Foundations.GetOperationStatus(apiVersion: string, operationId: string): Azure.Core.Foundations.OperationStatus | TErrorResponse +op Azure.Core.Foundations.GetOperationStatus(apiVersion: string, operationId: string): Azure.Core.Foundations.OperationStatus | ErrorResponse ``` #### Template Parameters -| Name | Description | -| -------------- | ---------------------------------------------------------------------------------------------- | -| TParams | Object describing the request parameters of the operation. | -| TStatusResult | The type of the operation status result. | -| TStatusError | The type of the operation status error. | -| Traits | Traits which apply to the operation. | -| TErrorResponse | The type of the error response. If not provided, the default error response type will be used. | +| Name | Description | +| ------------- | ---------------------------------------------------------------------------------------------- | +| Parameters | Object describing the request parameters of the operation. | +| StatusResult | The type of the operation status result. | +| StatusError | The type of the operation status error. | +| Traits | Traits which apply to the operation. | +| ErrorResponse | The type of the error response. If not provided, the default error response type will be used. | ### `LongRunningOperation` {#Azure.Core.Foundations.LongRunningOperation} Long-running operation. ```typespec -op Azure.Core.Foundations.LongRunningOperation(apiVersion: string): Azure.Core.Foundations.(anonymous model) | TErrorResponse +op Azure.Core.Foundations.LongRunningOperation(apiVersion: string): Azure.Core.Foundations.(anonymous model) | ErrorResponse ``` #### Template Parameters -| Name | Description | -| -------------- | -------------------------------------------------------------------------------------------------------------------- | -| TParams | Object describing the request parameters of the operation. | -| TResponse | Object describing the response properties of the operation. If not provided, the AcceptedResponse type will be used. | -| Traits | Traits which apply to the operation. | -| TErrorResponse | The type of the error response. If not provided, the default error response type will be used. | +| Name | Description | +| ------------- | -------------------------------------------------------------------------------------------------------------------- | +| Parameters | Object describing the request parameters of the operation. | +| Response | Object describing the response properties of the operation. If not provided, the AcceptedResponse type will be used. | +| Traits | Traits which apply to the operation. | +| ErrorResponse | The type of the error response. If not provided, the default error response type will be used. | ### `LongRunningResourceUpdate` {#Azure.Core.Foundations.LongRunningResourceUpdate} Long-running operation that updates a resource. ```typespec -op Azure.Core.Foundations.LongRunningResourceUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: TResource): (anonymous model) | TErrorResponse +op Azure.Core.Foundations.LongRunningResourceUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | ErrorResponse ``` #### Template Parameters -| Name | Description | -| -------------- | ---------------------------------------------------------------------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits which apply to the operation. | -| TErrorResponse | The type of the error response. If not provided, the default error response type will be used. | +| Name | Description | +| ------------- | ---------------------------------------------------------------------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits which apply to the operation. | +| ErrorResponse | The type of the error response. If not provided, the default error response type will be used. | ### `NonPagedResourceList` {#Azure.Core.Foundations.NonPagedResourceList} Operation that lists resources in a non-paginated way. ```typespec -op Azure.Core.Foundations.NonPagedResourceList(apiVersion: string): Azure.Core.Foundations.(anonymous model) | TErrorResponse +op Azure.Core.Foundations.NonPagedResourceList(apiVersion: string): Azure.Core.Foundations.(anonymous model) | ErrorResponse ``` #### Template Parameters -| Name | Description | -| -------------- | ---------------------------------------------------------------------------------------------- | -| TResource | The type of the resource. | -| Traits | Traits which apply to the operation. | -| TErrorResponse | The type of the error response. If not provided, the default error response type will be used. | +| Name | Description | +| ------------- | ---------------------------------------------------------------------------------------------- | +| Resource | The type of the resource. | +| Traits | Traits which apply to the operation. | +| ErrorResponse | The type of the error response. If not provided, the default error response type will be used. | ### `Operation` {#Azure.Core.Foundations.Operation} The most basic operation. ```typespec -op Azure.Core.Foundations.Operation(apiVersion: string): TResponse | TErrorResponse +op Azure.Core.Foundations.Operation(apiVersion: string): Response | ErrorResponse ``` #### Template Parameters -| Name | Description | -| -------------- | ---------------------------------------------------------------------------------------------- | -| TParams | Object describing the request parameters of the operation. | -| TResponse | Object describing the response properties of the operation. | -| Traits | Traits which apply to the operation. | -| TErrorResponse | The type of the error response. If not provided, the default error response type will be used. | +| Name | Description | +| ------------- | ---------------------------------------------------------------------------------------------- | +| Parameters | Object describing the request parameters of the operation. | +| Response | Object describing the response properties of the operation. | +| Traits | Traits which apply to the operation. | +| ErrorResponse | The type of the error response. If not provided, the default error response type will be used. | ### `ResourceCollectionOperation` {#Azure.Core.Foundations.ResourceCollectionOperation} Operation that applies to a collection of resources. ```typespec -op Azure.Core.Foundations.ResourceCollectionOperation(apiVersion: string): TResponse | TErrorResponse +op Azure.Core.Foundations.ResourceCollectionOperation(apiVersion: string): Response | ErrorResponse ``` #### Template Parameters -| Name | Description | -| -------------- | ---------------------------------------------------------------------------------------------- | -| TResource | The type of the resource. | -| TParams | Object describing the request parameters of the operation. | -| TResponse | Object describing the response properties of the operation. | -| Traits | Traits which apply to the operation. | -| TErrorResponse | The type of the error response. If not provided, the default error response type will be used. | +| Name | Description | +| ------------- | ---------------------------------------------------------------------------------------------- | +| Resource | The type of the resource. | +| Parameters | Object describing the request parameters of the operation. | +| Response | Object describing the response properties of the operation. | +| Traits | Traits which apply to the operation. | +| ErrorResponse | The type of the error response. If not provided, the default error response type will be used. | ### `ResourceList` {#Azure.Core.Foundations.ResourceList} Operation that lists resources in a paginated way. ```typespec -op Azure.Core.Foundations.ResourceList(apiVersion: string): TResponse | TErrorResponse +op Azure.Core.Foundations.ResourceList(apiVersion: string): Response | ErrorResponse ``` #### Template Parameters -| Name | Description | -| -------------- | ---------------------------------------------------------------------------------------------- | -| TResource | The type of the resource. | -| TParams | Object describing the request parameters of the operation. | -| TResponse | Object describing the response properties of the operation. | -| Traits | Traits which apply to the operation. | -| TErrorResponse | The type of the error response. If not provided, the default error response type will be used. | +| Name | Description | +| ------------- | ---------------------------------------------------------------------------------------------- | +| Resource | The type of the resource. | +| Parameters | Object describing the request parameters of the operation. | +| Response | Object describing the response properties of the operation. | +| Traits | Traits which apply to the operation. | +| ErrorResponse | The type of the error response. If not provided, the default error response type will be used. | ### `ResourceOperation` {#Azure.Core.Foundations.ResourceOperation} The most basic operation that applies to a resource. ```typespec -op Azure.Core.Foundations.ResourceOperation(apiVersion: string): TResponse | TErrorResponse +op Azure.Core.Foundations.ResourceOperation(apiVersion: string): Response | ErrorResponse ``` #### Template Parameters -| Name | Description | -| -------------- | ---------------------------------------------------------------------------------------------- | -| TResource | The type of the resource. | -| TParams | Object describing the request parameters of the operation. | -| TResponse | Object describing the response properties of the operation. | -| Traits | Traits which apply to the operation. | -| TErrorResponse | The type of the error response. If not provided, the default error response type will be used. | +| Name | Description | +| ------------- | ---------------------------------------------------------------------------------------------- | +| Resource | The type of the resource. | +| Parameters | Object describing the request parameters of the operation. | +| Response | Object describing the response properties of the operation. | +| Traits | Traits which apply to the operation. | +| ErrorResponse | The type of the error response. If not provided, the default error response type will be used. | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/FinalStateValue.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/FinalStateValue.md index 09e1377dc9..0a50d5d4ce 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/FinalStateValue.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/FinalStateValue.md @@ -14,6 +14,5 @@ long-running-operation-options.final-state-via field | `customLink` | `"custom-link"` | Poll on a header or field other than those above | | `customOperationReference` | `"custom-operation-reference"` | Call a polling operation using the data in LroMetadata | | `location` | `"location"` | Poll the location header | -| `noResult` | `"no-result"` | Operation should return no result | | `operationLocation` | `"operation-location"` | poll the Operation-Location header | | `originalUri` | `"original-uri"` | poll (GET) the same uri as the original operation | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/pollingOptionsKind.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/pollingOptionsKind.md new file mode 100644 index 0000000000..981a88f4bd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/pollingOptionsKind.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[E] pollingOptionsKind" + +--- +## Enumeration Members + +| Member | Value | +| :------ | :------ | +| `StatusMonitor` | `"statusMonitor"` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$finalLocation.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$finalLocation.md index 6ea7fc5214..60307ac013 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$finalLocation.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$finalLocation.md @@ -4,7 +4,10 @@ title: "[F] $finalLocation" --- ```ts -$finalLocation(context, entity): void +$finalLocation( + context, + entity, + finalResult?): void ``` ## Parameters @@ -13,6 +16,7 @@ $finalLocation(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `ModelProperty` | +| `finalResult`? | `Model` \| `IntrinsicType` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$pollingLocation.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$pollingLocation.md index d6201e6f0e..e075df4ec9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$pollingLocation.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$pollingLocation.md @@ -4,7 +4,10 @@ title: "[F] $pollingLocation" --- ```ts -$pollingLocation(context, entity): void +$pollingLocation( + context, + entity, + options?): void ``` ## Parameters @@ -13,6 +16,7 @@ $pollingLocation(context, entity): void | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `ModelProperty` | +| `options`? | `Model` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/getFinalLocationValue.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/getFinalLocationValue.md new file mode 100644 index 0000000000..1ae86da80b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/getFinalLocationValue.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getFinalLocationValue" + +--- +```ts +getFinalLocationValue(program, entity): Model | IntrinsicType | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `entity` | `ModelProperty` | + +## Returns + +`Model` \| `IntrinsicType` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/getPollingLocationInfo.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/getPollingLocationInfo.md new file mode 100644 index 0000000000..c4e004ad5c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/getPollingLocationInfo.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[F] getPollingLocationInfo" + +--- +```ts +getPollingLocationInfo(program, target): PollingLocationInfo | undefined +``` + +Gets polling information stored with a field that contains a link to an Lro polling endpoint + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `program` | `Program` | The program to check | +| `target` | `ModelProperty` | The ModelProperty to check for polling info | + +## Returns + +[`PollingLocationInfo`](../type-aliases/PollingLocationInfo.md) \| `undefined` 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 91e2d8cf5b..0336e65131 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 @@ -3,13 +3,12 @@ jsApi: true title: "[P] JS Api" --- -## Exports - -### Enumerations +## Enumerations - [FinalStateValue](enumerations/FinalStateValue.md) +- [pollingOptionsKind](enumerations/pollingOptionsKind.md) -### Interfaces +## Interfaces - [EmbeddingVectorMetadata](interfaces/EmbeddingVectorMetadata.md) - [FinalOperationLink](interfaces/FinalOperationLink.md) @@ -21,33 +20,38 @@ title: "[P] JS Api" - [ModelPropertyTerminationStatus](interfaces/ModelPropertyTerminationStatus.md) - [NextOperationLink](interfaces/NextOperationLink.md) - [NextOperationReference](interfaces/NextOperationReference.md) +- [NoPollingSuccessProperty](interfaces/NoPollingSuccessProperty.md) - [OperationLink](interfaces/OperationLink.md) - [OperationLinkMetadata](interfaces/OperationLinkMetadata.md) - [OperationReference](interfaces/OperationReference.md) - [PagedResultMetadata](interfaces/PagedResultMetadata.md) - [ParameterSource](interfaces/ParameterSource.md) +- [PollingLocationBase](interfaces/PollingLocationBase.md) - [PollingOperationStep](interfaces/PollingOperationStep.md) - [PollingSuccessNoResult](interfaces/PollingSuccessNoResult.md) - [PollingSuccessProperty](interfaces/PollingSuccessProperty.md) +- [StatusMonitorPollingLocationInfo](interfaces/StatusMonitorPollingLocationInfo.md) -### Type Aliases +## Type Aliases - [FinalOperationStep](type-aliases/FinalOperationStep.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 +## Variables - [$lib](variables/$lib.md) +- [$linter](variables/$linter.md) - [FinalOperationKey](variables/FinalOperationKey.md) - [PollingOperationKey](variables/PollingOperationKey.md) - [namespace](variables/namespace.md) - [preventRestLibraryInterfaces](variables/preventRestLibraryInterfaces.md) - [useStandardOperations](variables/useStandardOperations.md) -### Functions +## Functions - [$addTraitProperties](functions/$addTraitProperties.md) - [$applyTraitOverride](functions/$applyTraitOverride.md) @@ -93,6 +97,7 @@ title: "[P] JS Api" - [filterResponseModels](functions/filterResponseModels.md) - [getAllProperties](functions/getAllProperties.md) - [getAsEmbeddingVector](functions/getAsEmbeddingVector.md) +- [getFinalLocationValue](functions/getFinalLocationValue.md) - [getHttpMetadata](functions/getHttpMetadata.md) - [getItems](functions/getItems.md) - [getLongRunningStates](functions/getLongRunningStates.md) @@ -105,6 +110,7 @@ title: "[P] JS Api" - [getOperationLinks](functions/getOperationLinks.md) - [getOperationResponse](functions/getOperationResponse.md) - [getPagedResult](functions/getPagedResult.md) +- [getPollingLocationInfo](functions/getPollingLocationInfo.md) - [getPollingOperationParameter](functions/getPollingOperationParameter.md) - [getRequestParameter](functions/getRequestParameter.md) - [getResponseProperty](functions/getResponseProperty.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationLink.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationLink.md index 98347a5f9d..71d5ee19c0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationLink.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationLink.md @@ -14,5 +14,5 @@ For long-running operations, the resource link to the final result | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `kind` | `"finalOperationLink"` | - | - | -| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | +| `responseModel` | `Model` \| `IntrinsicType` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | | `target` | [`OperationLink`](OperationLink.md) | if a link must be followed to get the result after polling completes, contains information about how to get the uri from the STatusMonitor | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationReference.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationReference.md index 25fb5a7aa7..c6db688c8c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationReference.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationReference.md @@ -14,5 +14,5 @@ For long-running operations, the operation link to the final result | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `kind` | `"finalOperationReference"` | - | - | -| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | +| `responseModel` | `Model` \| `IntrinsicType` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | | `target` | [`OperationReference`](OperationReference.md) | if another operation must be called to get the result after polling completes, contains information about how to call this operation | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/HttpTerminationStatus.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/HttpTerminationStatus.md index dc738cb184..0ae1de8bf8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/HttpTerminationStatus.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/HttpTerminationStatus.md @@ -3,7 +3,7 @@ jsApi: true title: "[I] HttpTerminationStatus" --- -Definition of a StatusMonitor that uses http status rather then status code +Definition of a StatusMonitor that uses http status rather then status code. ## Properties diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LogicalOperationStep.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LogicalOperationStep.md index c7f6a7799b..6967603988 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LogicalOperationStep.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LogicalOperationStep.md @@ -14,10 +14,11 @@ A step in a logical operation that involves multiple calls - [`FinalOperationLink`](FinalOperationLink.md) - [`FinalOperationReference`](FinalOperationReference.md) - [`PollingSuccessProperty`](PollingSuccessProperty.md) +- [`NoPollingSuccessProperty`](NoPollingSuccessProperty.md) - [`PollingSuccessNoResult`](PollingSuccessNoResult.md) ## Properties | Property | Type | Description | | :------ | :------ | :------ | -| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | +| `responseModel` | `Model` \| `IntrinsicType` | The TypeSpec type that is returned by following a link or calling a lined operation | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LroMetadata.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LroMetadata.md index 937bbc07d2..c86ffc387c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LroMetadata.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LroMetadata.md @@ -11,13 +11,13 @@ For standard Lro Patterns, only the 'logicalResult' and 'finalStateVia' will be | Property | Type | Description | | :------ | :------ | :------ | | `envelopeResult` | `Model` | The TypeSpec type of the object that contains the final result | -| `finalEnvelopeResult`? | `Model` \| `"void"` | The TypeSpec type of the object that contains the 'finalResult'. | -| `finalResult`? | `Model` \| `"void"` | The model representing important data returned on a success - clients will want to return this model. If undefined,
then clients would want to return nothing. | -| `finalResultPath`? | `string` | The path to the field in the 'finalEnvelopeResult' that contains the 'finalResult'. | +| `finalEnvelopeResult?` | `Model` \| `"void"` | The TypeSpec type of the object that contains the 'finalResult'. | +| `finalResult?` | `Model` \| `"void"` | The model representing important data returned on a success - clients will want to return this model. If undefined,
then clients would want to return nothing. | +| `finalResultPath?` | `string` | The path to the field in the 'finalEnvelopeResult' that contains the 'finalResult'. | | `finalStateVia` | [`FinalStateValue`](../enumerations/FinalStateValue.md) | An enumeration summarizing how a poller should reach a terminal state | -| `finalStep`? | [`FinalOperationStep`](../type-aliases/FinalOperationStep.md) | If another operation call is required after polling ends to get the results of the operation, a link to that 'final' operation | -| `logicalPath`? | `string` | The path to the field in the status monitor that contains results. If undefined, then there is no results field in the status monitor | +| `finalStep?` | [`FinalOperationStep`](../type-aliases/FinalOperationStep.md) | If another operation call is required after polling ends to get the results of the operation, a link to that 'final' operation | +| `logicalPath?` | `string` | The path to the field in the status monitor that contains results. If undefined, then there is no results field in the status monitor | | `logicalResult` | `Model` | The model representing important data returned on a success - clients will want to return this model | | `operation` | `Operation` | The operation that was processed | | `pollingInfo` | [`PollingOperationStep`](PollingOperationStep.md) | Specific information about how to process the status monitor, including the location of status, success, and error fields, and the terminal states for polling | -| `statusMonitorStep`? | [`NextOperationLink`](NextOperationLink.md) \| [`NextOperationReference`](NextOperationReference.md) | Specific information on how to reach the StatusMonitor, this is either instructions for constructing a call to the status monitor operation {NextOperationReference} ,
or the response property containing the url that points to the Statue Monitor {NextOperationLink} | +| `statusMonitorStep?` | [`NextOperationLink`](NextOperationLink.md) \| [`NextOperationReference`](NextOperationReference.md) | Specific information on how to reach the StatusMonitor, this is either instructions for constructing a call to the status monitor operation {NextOperationReference} ,
or the response property containing the url that points to the Statue Monitor {NextOperationLink} | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationLink.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationLink.md index 234692c22e..afb1ee4bb6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationLink.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationLink.md @@ -14,5 +14,5 @@ A resource link to the next operation | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `kind` | `"nextOperationLink"` | - | - | -| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | +| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | | `target` | [`OperationLink`](OperationLink.md) | information on how to get the uri to the status monitor | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationReference.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationReference.md index 95127bfa3b..664a71b4ac 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationReference.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationReference.md @@ -14,5 +14,5 @@ An operation link to the next operation | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `kind` | `"nextOperationReference"` | - | - | -| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | +| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | | `target` | [`OperationReference`](OperationReference.md) | Information on how to call the STatusMonitor operation | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NoPollingSuccessProperty.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NoPollingSuccessProperty.md new file mode 100644 index 0000000000..936f41a379 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NoPollingSuccessProperty.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[I] NoPollingSuccessProperty" + +--- +Custom polling +A step in a logical operation that involves multiple calls + +## Extends + +- [`LogicalOperationStep`](LogicalOperationStep.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `kind` | `"noPollingResult"` | - | - | +| `responseModel` | `IntrinsicType` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationLink.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationLink.md index 83628b407c..b2f8c6cb99 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationLink.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationLink.md @@ -11,5 +11,5 @@ Represents a property or header that provides a Uri linking to another operation | Property | Type | Description | | :------ | :------ | :------ | | `kind` | `"link"` | - | -| `location` | `"ResponseBody"` \| `"ResponseHeader"` | Indicates whether the link is in the response header or response body | +| `location` | `"ResponseBody"` \| `"ResponseHeader"` \| `"Self"` | Indicates whether the link is in the response header or response body | | `property` | `ModelProperty` | The property that contains the link | 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 c2b7e7f55f..f6df0cbad7 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 @@ -7,9 +7,9 @@ title: "[I] OperationLinkMetadata" | Property | Type | Description | | :------ | :------ | :------ | -| `link`? | [`OperationLink`](OperationLink.md) | - | +| `link?` | [`OperationLink`](OperationLink.md) | - | | `linkType` | `string` | - | | `linkedOperation` | `Operation` | - | -| `parameterMap`? | `Map`<`string`, `PropertyMap`\> | - | -| `parameters`? | `Type` | - | -| `result`? | `ResultInfo` | - | +| `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 bd2b48548b..115feac7a9 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 @@ -13,5 +13,5 @@ original operation to the parameters of the linked operation | :------ | :------ | :------ | | `kind` | `"reference"` | - | | `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`\> | - | +| `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-core/reference/js-api/interfaces/PagedResultMetadata.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PagedResultMetadata.md index 5ec73b881d..70581b3b8b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PagedResultMetadata.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PagedResultMetadata.md @@ -7,11 +7,11 @@ title: "[I] PagedResultMetadata" | Property | Type | Description | | :------ | :------ | :------ | -| `itemsPath`? | `string` | **Deprecated**

use itemsSegments | -| `itemsProperty`? | `ModelProperty` | - | -| `itemsSegments`? | `string`[] | Path to the items property. | +| ~~`itemsPath?`~~ | `string` | **Deprecated**
use itemsSegments | +| `itemsProperty?` | `ModelProperty` | - | +| `itemsSegments?` | `string`[] | Path to the items property. | | `modelType` | `Model` | - | -| `nextLinkOperation`? | `Operation` | - | -| `nextLinkPath`? | `string` | **Deprecated**

use nextLinkSegments | -| `nextLinkProperty`? | `ModelProperty` | - | -| `nextLinkSegments`? | `string`[] | Path to the next link property. | +| `nextLinkOperation?` | `Operation` | - | +| ~~`nextLinkPath?`~~ | `string` | **Deprecated**
use nextLinkSegments | +| `nextLinkProperty?` | `ModelProperty` | - | +| `nextLinkSegments?` | `string`[] | Path to the next link property. | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingLocationBase.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingLocationBase.md new file mode 100644 index 0000000000..2e89dc7160 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingLocationBase.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[I] PollingLocationBase" + +--- +The abstract type for polling control information + +## Extended By + +- [`StatusMonitorPollingLocationInfo`](StatusMonitorPollingLocationInfo.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `finalResult?` | `Model` \| `IntrinsicType` | The type of the final result after polling completes | +| `kind` | `StatusMonitor` | The kind of polling being done | +| `pollingModel?` | `Model` \| `IntrinsicType` | The type of the poller | +| `target` | `ModelProperty` | The model property containing the polling link | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingOperationStep.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingOperationStep.md index e8367805c2..db8396c6a8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingOperationStep.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingOperationStep.md @@ -14,8 +14,8 @@ how to end polling | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `errorProperty`? | `ModelProperty` | Property of the status monitor that contains operation errors in case of failure (if any) | - | +| `errorProperty?` | `ModelProperty` | Property of the status monitor that contains operation errors in case of failure (if any) | - | | `kind` | `"pollingOperationStep"` | - | - | -| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | -| `resultProperty`? | `ModelProperty` | Property of the status monitor that contains the logical operation result (if any) | - | +| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | +| `resultProperty?` | `ModelProperty` | Property of the status monitor that contains the logical operation result (if any) | - | | `terminationStatus` | [`TerminationStatus`](../type-aliases/TerminationStatus.md) | Information on how to determine when the operation reaches a terminal state (most often, this is the terminal values that may be returned in the status field) | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessNoResult.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessNoResult.md index 14fa46e80c..20ba3b18d8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessNoResult.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessNoResult.md @@ -15,5 +15,5 @@ the operation has no logical final result when polling completes. | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `kind` | `"pollingSuccessNoResult"` | - | - | -| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | +| `responseModel` | `Model` \| `IntrinsicType` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | | `target` | `null` | There is no target | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessProperty.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessProperty.md index 7a3c176b63..3efed2f1be 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessProperty.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessProperty.md @@ -15,6 +15,6 @@ property of the StatusMonitor that contains the success response | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `kind` | `"pollingSuccessProperty"` | - | - | -| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | -| `sourceProperty` | `ModelProperty` | The property in the response that contained a url to the status monitor | - | +| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | +| `sourceProperty` | `undefined` \| `ModelProperty` | The property in the response that contained a url to the status monitor | - | | `target` | `ModelProperty` | The property containing the results of success | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/StatusMonitorPollingLocationInfo.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/StatusMonitorPollingLocationInfo.md new file mode 100644 index 0000000000..26df094041 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/StatusMonitorPollingLocationInfo.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[I] StatusMonitorPollingLocationInfo" + +--- +Collected data for status monitor polling links + +## Extends + +- [`PollingLocationBase`](PollingLocationBase.md) + +## Properties + +| Property | Type | Description | Inheritance | +| :------ | :------ | :------ | :------ | +| `finalResult?` | `Model` \| `IntrinsicType` | The type of the final result after polling completes | [`PollingLocationBase.finalResult`](PollingLocationBase.md) | +| `info` | `StatusMonitorMetadata` | The status monitor detailed data for control of polling. | - | +| `kind` | `StatusMonitor` | The kind of status monitor | [`PollingLocationBase.kind`](PollingLocationBase.md) | +| `pollingModel?` | `Model` \| `IntrinsicType` | The type of the poller | [`PollingLocationBase.pollingModel`](PollingLocationBase.md) | +| `target` | `ModelProperty` | The model property containing the polling link | [`PollingLocationBase.target`](PollingLocationBase.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/type-aliases/FinalOperationStep.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/type-aliases/FinalOperationStep.md index 349549561e..f3d074c151 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/type-aliases/FinalOperationStep.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/type-aliases/FinalOperationStep.md @@ -4,7 +4,7 @@ title: "[T] FinalOperationStep" --- ```ts -type FinalOperationStep: FinalOperationLink | FinalOperationReference | PollingSuccessProperty; +type FinalOperationStep: FinalOperationLink | FinalOperationReference | PollingSuccessProperty | NoPollingSuccessProperty; ``` For long-running operations, a description of the final step for diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/type-aliases/PollingLocationInfo.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/type-aliases/PollingLocationInfo.md new file mode 100644 index 0000000000..6700f4a1a5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/type-aliases/PollingLocationInfo.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[T] PollingLocationInfo" + +--- +```ts +type PollingLocationInfo: StatusMonitorPollingLocationInfo; +``` + +Extra information about polling control stored with a polling link diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/$lib.md index 3da9627f33..de9553c8cf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/$lib.md @@ -4,5 +4,80 @@ title: "[V] $lib" --- ```ts -const $lib: TypeSpecLibrary>; +const $lib: TypeSpecLibrary, never>; ``` + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `bad-record-type` | `Object` | - | +| `bad-record-type.extendUnknown` | `CallableMessage`<[`string`, `string`, `string`, `string`]\> | - | +| `bad-record-type.recordWithProperties` | `CallableMessage`<[`string`, `string`, `string`]\> | - | +| `client-request-id-trait-missing` | `Object` | - | +| `client-request-id-trait-missing.default` | `CallableMessage`<[]\> | - | +| `conditional-requests-trait-missing` | `Object` | - | +| `conditional-requests-trait-missing.default` | `CallableMessage`<[]\> | - | +| `expected-success-response` | `Object` | - | +| `expected-success-response.default` | `string` | - | +| `expected-trait-diagnostic-missing` | `Object` | - | +| `expected-trait-diagnostic-missing.default` | `string` | - | +| `expected-trait-missing` | `Object` | - | +| `expected-trait-missing.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `invalid-final-operation` | `Object` | - | +| `invalid-final-operation.default` | `string` | - | +| `invalid-parameter` | `Object` | - | +| `invalid-parameter.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `invalid-resource-type` | `Object` | - | +| `invalid-resource-type.missingKey` | `CallableMessage`<[`string`]\> | - | +| `invalid-resource-type.missingSegment` | `CallableMessage`<[`string`]\> | - | +| `invalid-trait-context` | `Object` | - | +| `invalid-trait-context.default` | `string` | - | +| `invalid-trait-property-count` | `Object` | - | +| `invalid-trait-property-count.default` | `CallableMessage`<[`string`]\> | - | +| `invalid-trait-property-type` | `Object` | - | +| `invalid-trait-property-type.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `lro-polling-data-missing-from-operation-response` | `Object` | - | +| `lro-polling-data-missing-from-operation-response.default` | `string` | - | +| `lro-status-missing` | `Object` | - | +| `lro-status-missing.default` | `CallableMessage`<[`string`]\> | - | +| `lro-status-monitor-invalid-result-property` | `Object` | - | +| `lro-status-monitor-invalid-result-property.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `lro-status-property-invalid-type` | `Object` | - | +| `lro-status-property-invalid-type.default` | `string` | - | +| `lro-status-union-non-string` | `Object` | - | +| `lro-status-union-non-string.default` | `CallableMessage`<[`string`]\> | - | +| `no-object` | `Object` | - | +| `no-object.default` | `string` | - | +| `operation-link-parameter-invalid` | `Object` | - | +| `operation-link-parameter-invalid.default` | `string` | - | +| `operation-link-parameter-invalid-target` | `Object` | - | +| `operation-link-parameter-invalid-target.default` | `CallableMessage`<[`string`]\> | - | +| `polling-operation-no-lro-failure` | `Object` | - | +| `polling-operation-no-lro-failure.default` | `string` | - | +| `polling-operation-no-lro-success` | `Object` | - | +| `polling-operation-no-lro-success.default` | `string` | - | +| `polling-operation-no-ref-or-link` | `Object` | - | +| `polling-operation-no-ref-or-link.default` | `string` | - | +| `polling-operation-no-status-monitor` | `Object` | - | +| `polling-operation-no-status-monitor.default` | `string` | - | +| `polling-operation-return-model` | `Object` | - | +| `polling-operation-return-model.default` | `string` | - | +| `repeatable-requests-trait-missing` | `Object` | - | +| `repeatable-requests-trait-missing.default` | `CallableMessage`<[]\> | - | +| `request-parameter-invalid` | `Object` | - | +| `request-parameter-invalid.default` | `CallableMessage`<[`string`]\> | - | +| `response-property-invalid` | `Object` | - | +| `response-property-invalid.default` | `CallableMessage`<[`string`]\> | - | +| `rpc-operation-needs-route` | `Object` | - | +| `rpc-operation-needs-route.default` | `string` | - | +| `trait-property-without-location` | `Object` | - | +| `trait-property-without-location.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `union-enums-circular` | `Object` | - | +| `union-enums-circular.default` | `string` | - | +| `union-enums-invalid-kind` | `Object` | - | +| `union-enums-invalid-kind.default` | `CallableMessage`<[`string`]\> | - | +| `union-enums-multiple-kind` | `Object` | - | +| `union-enums-multiple-kind.default` | `CallableMessage`<[`string`]\> | - | +| `verb-conflict` | `Object` | - | +| `verb-conflict.default` | `CallableMessage`<[`string`, `string`, `string`]\> | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/$linter.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/$linter.md new file mode 100644 index 0000000000..f8b4fc46f3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/$linter.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] $linter" + +--- +```ts +const $linter: LinterDefinition; +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/preventRestLibraryInterfaces.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/preventRestLibraryInterfaces.md index e859b0c53d..9e03d17f54 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/preventRestLibraryInterfaces.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/preventRestLibraryInterfaces.md @@ -4,5 +4,5 @@ title: "[V] preventRestLibraryInterfaces" --- ```ts -const preventRestLibraryInterfaces: LinterRuleDefinition<"no-rest-library-interfaces", object>; +const preventRestLibraryInterfaces: LinterRuleDefinition<"no-rest-library-interfaces", Object>; ``` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/useStandardOperations.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/useStandardOperations.md index d7b4d21eb1..c00185a2af 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/useStandardOperations.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/useStandardOperations.md @@ -4,5 +4,5 @@ title: "[V] useStandardOperations" --- ```ts -const useStandardOperations: LinterRuleDefinition<"use-standard-operations", object>; +const useStandardOperations: LinterRuleDefinition<"use-standard-operations", Object>; ``` 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 6348831357..db1b56dc28 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 @@ -18,52 +18,87 @@ model Azure.ResourceManager.ApiVersionParameter ### `ArmAcceptedLroResponse` {#Azure.ResourceManager.ArmAcceptedLroResponse} -The standard ARM response for asynchronous PATCH, POST, and DELETE operations - ```typespec -model Azure.ResourceManager.ArmAcceptedLroResponse +model Azure.ResourceManager.ArmAcceptedLroResponse ``` #### Template Parameters -| Name | Description | -| -------- | ---------------------------------------------------------------------------------- | -| TMessage | The description of the response status (defaults to `Resource operation accepted`) | +| Name | Description | +| ----------- | ---------------------------------------------------------------------------------- | +| Description | The description of the response status (defaults to `Resource operation accepted`) | +| LroHeaders | Optional. The lro headers that appear in the Accepted response | ### `ArmAcceptedResponse` {#Azure.ResourceManager.ArmAcceptedResponse} -The standard ACCEPTED response +```typespec +model Azure.ResourceManager.ArmAcceptedResponse +``` + +#### Template Parameters + +| Name | Description | +| ------- | ---------------------------------------------------------------------------------- | +| Message | The description of the response status (defaults to `Resource operation accepted`) | + +### `ArmAsyncOperationHeader` {#Azure.ResourceManager.ArmAsyncOperationHeader} + +The standard header for asynchronous operation polling + +```typespec +model Azure.ResourceManager.ArmAsyncOperationHeader +``` + +#### Template Parameters + +| Name | Description | +| ------------- | ------------------------------------------------- | +| StatusMonitor | The status monitor type for lro polling | +| UrlValue | The value type of the Azure-AsyncOperation header | + +### `ArmCombinedLroHeaders` {#Azure.ResourceManager.ArmCombinedLroHeaders} + +Provide Both Azure-AsyncOperation and Location headers ```typespec -model Azure.ResourceManager.ArmAcceptedResponse +model Azure.ResourceManager.ArmCombinedLroHeaders ``` #### Template Parameters -| Name | Description | -| -------- | ---------------------------------------------------------------------------------- | -| TMessage | The description of the response status (defaults to `Resource operation accepted`) | +| Name | Description | +| --------------- | --------------------------------------------------------------------------------- | +| StatusMonitor | The type of the polling StatusMonitor when following the Azure-AsyncOperation url | +| FinalResult | The type of the logical result when following the location header | +| PollingUrlValue | The value type of the link to the status monitor | +| FinalUrlValue | The value type fo the link to the final result | ### `ArmCreatedResponse` {#Azure.ResourceManager.ArmCreatedResponse} The ARM 201 response for a resource ```typespec -model Azure.ResourceManager.ArmCreatedResponse +model Azure.ResourceManager.ArmCreatedResponse ``` #### Template Parameters -| Name | Description | -| ---- | --------------------------------- | -| T | The contents of the response body | +| Name | Description | +| ------------ | --------------------------------- | +| ResponseBody | The contents of the response body | ### `ArmDeleteAcceptedLroResponse` {#Azure.ResourceManager.ArmDeleteAcceptedLroResponse} ```typespec -model Azure.ResourceManager.ArmDeleteAcceptedLroResponse +model Azure.ResourceManager.ArmDeleteAcceptedLroResponse ``` +#### Template Parameters + +| Name | Description | +| ---------- | --------------------------------------------------------------------- | +| LroHeaders | Optional. Allows overriding the Lro headers returned in the response. | + ### `ArmDeleteAcceptedResponse` {#Azure.ResourceManager.ArmDeleteAcceptedResponse} ```typespec @@ -84,75 +119,101 @@ The response for synchronous delete of a resource model Azure.ResourceManager.ArmDeletedResponse ``` +### `ArmLroLocationHeader` {#Azure.ResourceManager.ArmLroLocationHeader} + +The default header for lro PUT and DELETE polling + +```typespec +model Azure.ResourceManager.ArmLroLocationHeader +``` + +#### Template Parameters + +| Name | Description | +| ----------------- | --------------------------------------------------------------- | +| LroPollingOptions | The polling options when polling the url in the location header | +| FinalResult | The ultimate final result of the logical operation | +| UrlValue | The value type for the location header | + ### `ArmNoContentResponse` {#Azure.ResourceManager.ArmNoContentResponse} Standard ARM NoContent (204) response ```typespec -model Azure.ResourceManager.ArmNoContentResponse +model Azure.ResourceManager.ArmNoContentResponse ``` #### Template Parameters -| Name | Description | -| -------- | --------------------------------------------------------------------------------------- | -| TMessage | The description of the response status (defaults to `Operation completed successfully`) | +| Name | Description | +| ------- | --------------------------------------------------------------------------------------- | +| Message | The description of the response status (defaults to `Operation completed successfully`) | -### `ArmResourceCreatedResponse` {#Azure.ResourceManager.ArmResourceCreatedResponse} +### `ArmOperationStatus` {#Azure.ResourceManager.ArmOperationStatus} -Resource create operation succeeded +Standard ARM operation status response ```typespec -model Azure.ResourceManager.ArmResourceCreatedResponse +model Azure.ResourceManager.ArmOperationStatus ``` #### Template Parameters -| Name | Description | -| --------- | -------------------------- | -| TResource | The resource being updated | +| Name | Description | +| ------------ | ---------------------------------------------- | +| Properties | Optional resource-specific properties | +| StatusValues | The set of allowed values for operation status | -### `ArmResourceCreatedSyncResponse` {#Azure.ResourceManager.ArmResourceCreatedSyncResponse} +### `ArmResourceCreatedResponse` {#Azure.ResourceManager.ArmResourceCreatedResponse} -Resource synchronous create operation succeeded +```typespec +model Azure.ResourceManager.ArmResourceCreatedResponse +``` + +#### Template Parameters + +| Name | Description | +| ---------- | ---------------------------------------------------------- | +| Resource | The resource being updated | +| LroHeaders | Optional. The lro headers returned with a Created response | + +### `ArmResourceCreatedSyncResponse` {#Azure.ResourceManager.ArmResourceCreatedSyncResponse} ```typespec -model Azure.ResourceManager.ArmResourceCreatedSyncResponse +model Azure.ResourceManager.ArmResourceCreatedSyncResponse ``` #### Template Parameters -| Name | Description | -| --------- | -------------------------- | -| TResource | The resource being updated | +| Name | Description | +| -------- | -------------------------- | +| Resource | The resource being updated | ### `ArmResourceUpdatedResponse` {#Azure.ResourceManager.ArmResourceUpdatedResponse} -Resource update operation succeeded - ```typespec -model Azure.ResourceManager.ArmResourceUpdatedResponse +model Azure.ResourceManager.ArmResourceUpdatedResponse ``` #### Template Parameters -| Name | Description | -| --------- | -------------------------- | -| TResource | The resource being updated | +| Name | Description | +| -------- | -------------------------- | +| Resource | The resource being updated | ### `ArmResponse` {#Azure.ResourceManager.ArmResponse} The ARM synchronous OK response ```typespec -model Azure.ResourceManager.ArmResponse +model Azure.ResourceManager.ArmResponse ``` #### Template Parameters -| Name | Description | -| ---- | --------------------------------- | -| T | The contents of the response body | +| Name | Description | +| ------------ | --------------------------------- | +| ResponseBody | The contents of the response body | ### `CustomerManagedKeyEncryption` {#Azure.ResourceManager.CustomerManagedKeyEncryption} @@ -236,37 +297,46 @@ Concrete extension resource types can be created by aliasing this type using a s See more details on [different ARM resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type) ```typespec -model Azure.ResourceManager.ExtensionResource +model Azure.ResourceManager.ExtensionResource ``` #### Template Parameters -| Name | Description | -| ----------- | --------------------------------------------------------------------- | -| TProperties | A model containing the provider-specific properties for this resource | +| Name | Description | +| ---------- | --------------------------------------------------------------------- | +| Properties | A model containing the provider-specific properties for this resource | ### `KeysOf` {#Azure.ResourceManager.KeysOf} Extracts the key (path) parameters from a resource and its parents ```typespec -model Azure.ResourceManager.KeysOf +model Azure.ResourceManager.KeysOf ``` #### Template Parameters -| Name | Description | -| --------- | --------------------------------------- | -| TResource | The resource to extract properties from | +| Name | Description | +| -------- | --------------------------------------- | +| Resource | The resource to extract properties from | ### `LocationParameter` {#Azure.ResourceManager.LocationParameter} +DEPRECATED - DO NOT USE The default location parameter type. ```typespec model Azure.ResourceManager.LocationParameter ``` +### `LocationResourceParameter` {#Azure.ResourceManager.LocationResourceParameter} + +The default location parameter type. + +```typespec +model Azure.ResourceManager.LocationResourceParameter +``` + ### `ManagedBy` {#Azure.ResourceManager.ManagedBy} Model used only to spread in the standard `managedBy` envelope property for a resource @@ -306,14 +376,14 @@ model Azure.ResourceManager.ManagedSystemAssignedIdentity Extracts the key (path) parameters from the parent(s) of the given resource ```typespec -model Azure.ResourceManager.ParentKeysOf +model Azure.ResourceManager.ParentKeysOf ``` #### Template Parameters -| Name | Description | -| --------- | --------------------------------------- | -| TResource | The resource to extract properties from | +| Name | Description | +| -------- | --------------------------------------- | +| Resource | The resource to extract properties from | ### `PrivateEndpoint` {#Azure.ResourceManager.PrivateEndpoint} @@ -336,14 +406,14 @@ model Azure.ResourceManager.PrivateEndpointConnection The name of the private endpoint connection associated with the Azure resource. ```typespec -model Azure.ResourceManager.PrivateEndpointConnectionParameter +model Azure.ResourceManager.PrivateEndpointConnectionParameter ``` #### Template Parameters -| Name | Description | -| -------- | ----------------------------------------------------------------------------------------------- | -| TSegment | The resource type name for private endpoint connections (default is privateEndpointConnections) | +| Name | Description | +| ------- | ----------------------------------------------------------------------------------------------- | +| Segment | The resource type name for private endpoint connections (default is privateEndpointConnections) | ### `PrivateEndpointConnectionProperties` {#Azure.ResourceManager.PrivateEndpointConnectionProperties} @@ -380,14 +450,14 @@ model Azure.ResourceManager.PrivateLinkResourceListResult The name of the private link associated with the Azure resource. ```typespec -model Azure.ResourceManager.PrivateLinkResourceParameter +model Azure.ResourceManager.PrivateLinkResourceParameter ``` #### Template Parameters -| Name | Description | -| -------- | -------------------------------------------------------------------------- | -| TSegment | The resource type name for private links (default is privateLinkResources) | +| Name | Description | +| ------- | -------------------------------------------------------------------------- | +| Segment | The resource type name for private links (default is privateLinkResources) | ### `PrivateLinkResourceProperties` {#Azure.ResourceManager.PrivateLinkResourceProperties} @@ -410,14 +480,14 @@ model Azure.ResourceManager.PrivateLinkServiceConnectionState Model describing the provider namespace. ```typespec -model Azure.ResourceManager.ProviderNamespace +model Azure.ResourceManager.ProviderNamespace ``` #### Template Parameters -| Name | Description | -| --------- | --------------------------------------- | -| TResource | The resource provided by the namespace. | +| Name | Description | +| -------- | --------------------------------------- | +| Resource | The resource provided by the namespace. | ### `ProxyResource` {#Azure.ResourceManager.ProxyResource} @@ -426,14 +496,14 @@ Concrete proxy resource types can be created by aliasing this type using a speci See more details on [different ARM resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type) ```typespec -model Azure.ResourceManager.ProxyResource +model Azure.ResourceManager.ProxyResource ``` #### Template Parameters -| Name | Description | -| ----------- | --------------------------------------------------------------------- | -| TProperties | A model containing the provider-specific properties for this resource | +| Name | Description | +| ---------- | --------------------------------------------------------------------- | +| Properties | A model containing the provider-specific properties for this resource | ### `ResourceGroupParameter` {#Azure.ResourceManager.ResourceGroupParameter} @@ -458,15 +528,15 @@ The dynamic parameters of a resource instance - pass in the proper base type to where the resource is based. The default is in a resource group ```typespec -model Azure.ResourceManager.ResourceInstanceParameters +model Azure.ResourceManager.ResourceInstanceParameters ``` #### Template Parameters -| Name | Description | -| --------------- | -------------------------------------------------------- | -| TResource | The resource to get parameters for | -| TBaseParameters | The parameters representing the base Uri of the resource | +| Name | Description | +| -------------- | -------------------------------------------------------- | +| Resource | The resource to get parameters for | +| BaseParameters | The parameters representing the base Uri of the resource | ### `ResourceKind` {#Azure.ResourceManager.ResourceKind} @@ -490,14 +560,14 @@ model Foo is TrackedResource { Paged response containing resources ```typespec -model Azure.ResourceManager.ResourceListResult +model Azure.ResourceManager.ResourceListResult ``` #### Template Parameters -| Name | Description | -| --------- | -------------------------------------------------------------------------- | -| TResource | The type of the values returned in the paged response (must be a resource) | +| Name | Description | +| -------- | -------------------------------------------------------------------------- | +| Resource | The type of the values returned in the paged response (must be a resource) | ### `ResourceParentParameters` {#Azure.ResourceManager.ResourceParentParameters} @@ -505,15 +575,15 @@ The dynamic parameters of a list call for a resource instance - pass in the prop where the list should take place. The default is in a resource group ```typespec -model Azure.ResourceManager.ResourceParentParameters +model Azure.ResourceManager.ResourceParentParameters ``` #### Template Parameters -| Name | Description | -| --------------- | -------------------------------------------------------- | -| TResource | The resource to get parameters for | -| TBaseParameters | The parameters representing the base Uri of the resource | +| Name | Description | +| -------------- | -------------------------------------------------------- | +| Resource | The resource to get parameters for | +| BaseParameters | The parameters representing the base Uri of the resource | ### `ResourcePlan` {#Azure.ResourceManager.ResourcePlan} @@ -565,6 +635,18 @@ The default subscriptionId parameter type. model Azure.ResourceManager.SubscriptionIdParameter ``` +### `SubscriptionLocationResource` {#Azure.ResourceManager.SubscriptionLocationResource} + +```typespec +model Azure.ResourceManager.SubscriptionLocationResource +``` + +### `TenantLocationResource` {#Azure.ResourceManager.TenantLocationResource} + +```typespec +model Azure.ResourceManager.TenantLocationResource +``` + ### `TrackedResource` {#Azure.ResourceManager.TrackedResource} Concrete tracked resource types can be created by aliasing this type using a specific property type. @@ -572,14 +654,14 @@ Concrete tracked resource types can be created by aliasing this type using a spe See more details on [different ARM resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type) ```typespec -model Azure.ResourceManager.TrackedResource +model Azure.ResourceManager.TrackedResource ``` #### Template Parameters -| Name | Description | -| ----------- | --------------------------------------------------------------------- | -| TProperties | A model containing the provider-specific properties for this resource | +| Name | Description | +| ---------- | --------------------------------------------------------------------- | +| Properties | A model containing the provider-specific properties for this resource | ### `InfrastructureEncryption` {#Azure.ResourceManager.InfrastructureEncryption} @@ -701,30 +783,24 @@ Base model that defines common properties for all ARM resources. model Azure.ResourceManager.Foundations.ArmResource ``` -### `ArmTagsProperty` {#Azure.ResourceManager.Foundations.ArmTagsProperty} +### `ArmResourceBase` {#Azure.ResourceManager.Foundations.ArmResourceBase} -Standard type definition for ARM Tags property. - -It is included in the TrackedResource template definition. +Base class used for type definitions ```typespec -model Azure.ResourceManager.Foundations.ArmTagsProperty +model Azure.ResourceManager.Foundations.ArmResourceBase ``` -### `BaseParameters` {#Azure.ResourceManager.Foundations.BaseParameters} +### `ArmTagsProperty` {#Azure.ResourceManager.Foundations.ArmTagsProperty} -Base parameters for a resource. +Standard type definition for ARM Tags property. + +It is included in the TrackedResource template definition. ```typespec -model Azure.ResourceManager.Foundations.BaseParameters +model Azure.ResourceManager.Foundations.ArmTagsProperty ``` -#### Template Parameters - -| Name | Description | -| --------- | ------------------------- | -| TResource | The type of the resource. | - ### `CheckNameAvailabilityRequest` {#Azure.ResourceManager.Foundations.CheckNameAvailabilityRequest} The check availability request body. @@ -741,6 +817,20 @@ The check availability result. model Azure.ResourceManager.Foundations.CheckNameAvailabilityResponse ``` +### `DefaultBaseParameters` {#Azure.ResourceManager.Foundations.DefaultBaseParameters} + +Base parameters for a resource. + +```typespec +model Azure.ResourceManager.Foundations.DefaultBaseParameters +``` + +#### Template Parameters + +| Name | Description | +| -------- | ------------------------- | +| Resource | The type of the resource. | + ### `ErrorAdditionalInfo` {#Azure.ResourceManager.Foundations.ErrorAdditionalInfo} The resource management error additional info. @@ -778,14 +868,14 @@ model Azure.ResourceManager.Foundations.ExtensionResourceBase Parameter model for listing an extension resource ```typespec -model Azure.ResourceManager.Foundations.ExtensionScope +model Azure.ResourceManager.Foundations.ExtensionScope ``` #### Template Parameters -| Name | Description | -| --------- | ------------------------- | -| TResource | The type of the resource. | +| Name | Description | +| -------- | ------------------------- | +| Resource | The type of the resource. | ### `LocationBaseParameters` {#Azure.ResourceManager.Foundations.LocationBaseParameters} @@ -800,14 +890,14 @@ model Azure.ResourceManager.Foundations.LocationBaseParameters Parameter model for listing a resource at the location scope ```typespec -model Azure.ResourceManager.Foundations.LocationScope +model Azure.ResourceManager.Foundations.LocationScope ``` #### Template Parameters -| Name | Description | -| --------- | ------------------------- | -| TResource | The type of the resource. | +| Name | Description | +| -------- | ------------------------- | +| Resource | The type of the resource. | ### `ManagedIdentityProperties` {#Azure.ResourceManager.Foundations.ManagedIdentityProperties} @@ -878,15 +968,15 @@ model Azure.ResourceManager.Foundations.ProxyResourceBase The type used for update operations of the resource. ```typespec -model Azure.ResourceManager.Foundations.ProxyResourceUpdateModel +model Azure.ResourceManager.Foundations.ProxyResourceUpdateModel ``` #### Template Parameters -| Name | Description | -| ----------- | --------------------------- | -| TResource | The type of the resource. | -| TProperties | The type of the properties. | +| Name | Description | +| ---------- | --------------------------- | +| Resource | The type of the resource. | +| Properties | The type of the properties. | ### `ResourceGroupBaseParameters` {#Azure.ResourceManager.Foundations.ResourceGroupBaseParameters} @@ -901,14 +991,14 @@ model Azure.ResourceManager.Foundations.ResourceGroupBaseParameters Parameter model for listing a resource at the resource group scope ```typespec -model Azure.ResourceManager.Foundations.ResourceGroupScope +model Azure.ResourceManager.Foundations.ResourceGroupScope ``` #### Template Parameters -| Name | Description | -| --------- | ------------------------- | -| TResource | The type of the resource. | +| Name | Description | +| -------- | ------------------------- | +| Resource | The type of the resource. | ### `ResourcePlanType` {#Azure.ResourceManager.Foundations.ResourcePlanType} @@ -932,15 +1022,15 @@ Defines a model type used to create named resource update models e.g. `model MyResourceUpdate is ResourceUpdate {}` ```typespec -model Azure.ResourceManager.Foundations.ResourceUpdateModel +model Azure.ResourceManager.Foundations.ResourceUpdateModel ``` #### Template Parameters -| Name | Description | -| ----------- | --------------------------- | -| TResource | The type of the resource. | -| TProperties | The type of the properties. | +| Name | Description | +| ---------- | --------------------------- | +| Resource | The type of the resource. | +| Properties | The type of the properties. | ### `ResourceUpdateModelProperties` {#Azure.ResourceManager.Foundations.ResourceUpdateModelProperties} @@ -948,15 +1038,15 @@ Defines a properties type used to create named resource update models. This type is not used directly, it is referenced by ResourceUpdateModel. ```typespec -model Azure.ResourceManager.Foundations.ResourceUpdateModelProperties +model Azure.ResourceManager.Foundations.ResourceUpdateModelProperties ``` #### Template Parameters -| Name | Description | -| ----------- | --------------------------- | -| TResource | The type of the resource. | -| TProperties | The type of the properties. | +| Name | Description | +| ---------- | --------------------------- | +| Resource | The type of the resource. | +| Properties | The type of the properties. | ### `SubscriptionBaseParameters` {#Azure.ResourceManager.Foundations.SubscriptionBaseParameters} @@ -971,14 +1061,14 @@ model Azure.ResourceManager.Foundations.SubscriptionBaseParameters Parameter model for listing a resource at the subscription scope ```typespec -model Azure.ResourceManager.Foundations.SubscriptionScope +model Azure.ResourceManager.Foundations.SubscriptionScope ``` #### Template Parameters -| Name | Description | -| --------- | ------------------------- | -| TResource | The type of the resource. | +| Name | Description | +| -------- | ------------------------- | +| Resource | The type of the resource. | ### `SystemData` {#Azure.ResourceManager.Foundations.SystemData} @@ -993,14 +1083,14 @@ model Azure.ResourceManager.Foundations.SystemData The type used for updating tags in resources. ```typespec -model Azure.ResourceManager.Foundations.TagsUpdateModel +model Azure.ResourceManager.Foundations.TagsUpdateModel ``` #### Template Parameters -| Name | Description | -| --------- | ------------------------- | -| TResource | The type of the resource. | +| Name | Description | +| -------- | ------------------------- | +| Resource | The type of the resource. | ### `TenantBaseParameters` {#Azure.ResourceManager.Foundations.TenantBaseParameters} @@ -1015,14 +1105,14 @@ model Azure.ResourceManager.Foundations.TenantBaseParameters Parameter model for listing a resource at the tenant scope ```typespec -model Azure.ResourceManager.Foundations.TenantScope +model Azure.ResourceManager.Foundations.TenantScope ``` #### Template Parameters -| Name | Description | -| --------- | ------------------------- | -| TResource | The type of the resource. | +| Name | Description | +| -------- | ------------------------- | +| Resource | The type of the resource. | ### `TrackedResourceBase` {#Azure.ResourceManager.Foundations.TrackedResourceBase} 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 4b82579494..359f551362 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 @@ -92,6 +92,7 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager - [`ArmResourceActionNoContentSync`](./interfaces.md#Azure.ResourceManager.ArmResourceActionNoContentSync) - [`ArmResourceActionNoResponseContentAsync`](./interfaces.md#Azure.ResourceManager.ArmResourceActionNoResponseContentAsync) - [`ArmResourceActionSync`](./interfaces.md#Azure.ResourceManager.ArmResourceActionSync) +- [`ArmResourceCreateOrReplaceAsync`](./interfaces.md#Azure.ResourceManager.ArmResourceCreateOrReplaceAsync) - [`ArmResourceCreateOrReplaceSync`](./interfaces.md#Azure.ResourceManager.ArmResourceCreateOrReplaceSync) - [`ArmResourceCreateOrUpdateAsync`](./interfaces.md#Azure.ResourceManager.ArmResourceCreateOrUpdateAsync) - [`ArmResourceCreateOrUpdateSync`](./interfaces.md#Azure.ResourceManager.ArmResourceCreateOrUpdateSync) @@ -101,7 +102,11 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager - [`ArmResourceDeleteWithoutOkAsync`](./interfaces.md#Azure.ResourceManager.ArmResourceDeleteWithoutOkAsync) - [`ArmResourceListAtScope`](./interfaces.md#Azure.ResourceManager.ArmResourceListAtScope) - [`ArmResourceListByParent`](./interfaces.md#Azure.ResourceManager.ArmResourceListByParent) +- [`ArmResourcePatchAsync`](./interfaces.md#Azure.ResourceManager.ArmResourcePatchAsync) +- [`ArmResourcePatchSync`](./interfaces.md#Azure.ResourceManager.ArmResourcePatchSync) - [`ArmResourceRead`](./interfaces.md#Azure.ResourceManager.ArmResourceRead) +- [`ArmTagsPatchAsync`](./interfaces.md#Azure.ResourceManager.ArmTagsPatchAsync) +- [`ArmTagsPatchSync`](./interfaces.md#Azure.ResourceManager.ArmTagsPatchSync) - [`checkGlobalNameAvailability`](./interfaces.md#Azure.ResourceManager.checkGlobalNameAvailability) - [`checkLocalNameAvailability`](./interfaces.md#Azure.ResourceManager.checkLocalNameAvailability) @@ -110,12 +115,16 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager - [`ApiVersionParameter`](./data-types.md#Azure.ResourceManager.ApiVersionParameter) - [`ArmAcceptedLroResponse`](./data-types.md#Azure.ResourceManager.ArmAcceptedLroResponse) - [`ArmAcceptedResponse`](./data-types.md#Azure.ResourceManager.ArmAcceptedResponse) +- [`ArmAsyncOperationHeader`](./data-types.md#Azure.ResourceManager.ArmAsyncOperationHeader) +- [`ArmCombinedLroHeaders`](./data-types.md#Azure.ResourceManager.ArmCombinedLroHeaders) - [`ArmCreatedResponse`](./data-types.md#Azure.ResourceManager.ArmCreatedResponse) - [`ArmDeleteAcceptedLroResponse`](./data-types.md#Azure.ResourceManager.ArmDeleteAcceptedLroResponse) - [`ArmDeleteAcceptedResponse`](./data-types.md#Azure.ResourceManager.ArmDeleteAcceptedResponse) - [`ArmDeletedNoContentResponse`](./data-types.md#Azure.ResourceManager.ArmDeletedNoContentResponse) - [`ArmDeletedResponse`](./data-types.md#Azure.ResourceManager.ArmDeletedResponse) +- [`ArmLroLocationHeader`](./data-types.md#Azure.ResourceManager.ArmLroLocationHeader) - [`ArmNoContentResponse`](./data-types.md#Azure.ResourceManager.ArmNoContentResponse) +- [`ArmOperationStatus`](./data-types.md#Azure.ResourceManager.ArmOperationStatus) - [`ArmResourceCreatedResponse`](./data-types.md#Azure.ResourceManager.ArmResourceCreatedResponse) - [`ArmResourceCreatedSyncResponse`](./data-types.md#Azure.ResourceManager.ArmResourceCreatedSyncResponse) - [`ArmResourceUpdatedResponse`](./data-types.md#Azure.ResourceManager.ArmResourceUpdatedResponse) @@ -129,6 +138,7 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager - [`ExtensionResource`](./data-types.md#Azure.ResourceManager.ExtensionResource) - [`KeysOf`](./data-types.md#Azure.ResourceManager.KeysOf) - [`LocationParameter`](./data-types.md#Azure.ResourceManager.LocationParameter) +- [`LocationResourceParameter`](./data-types.md#Azure.ResourceManager.LocationResourceParameter) - [`ManagedBy`](./data-types.md#Azure.ResourceManager.ManagedBy) - [`ManagedServiceIdentity`](./data-types.md#Azure.ResourceManager.ManagedServiceIdentity) - [`ManagedSystemAssignedIdentity`](./data-types.md#Azure.ResourceManager.ManagedSystemAssignedIdentity) @@ -155,6 +165,8 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager - [`ResourceSku`](./data-types.md#Azure.ResourceManager.ResourceSku) - [`ResourceUriParameter`](./data-types.md#Azure.ResourceManager.ResourceUriParameter) - [`SubscriptionIdParameter`](./data-types.md#Azure.ResourceManager.SubscriptionIdParameter) +- [`SubscriptionLocationResource`](./data-types.md#Azure.ResourceManager.SubscriptionLocationResource) +- [`TenantLocationResource`](./data-types.md#Azure.ResourceManager.TenantLocationResource) - [`TrackedResource`](./data-types.md#Azure.ResourceManager.TrackedResource) ## Azure.ResourceManager.CommonTypes @@ -168,10 +180,11 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager ### Models - [`ArmResource`](./data-types.md#Azure.ResourceManager.Foundations.ArmResource) +- [`ArmResourceBase`](./data-types.md#Azure.ResourceManager.Foundations.ArmResourceBase) - [`ArmTagsProperty`](./data-types.md#Azure.ResourceManager.Foundations.ArmTagsProperty) -- [`BaseParameters`](./data-types.md#Azure.ResourceManager.Foundations.BaseParameters) - [`CheckNameAvailabilityRequest`](./data-types.md#Azure.ResourceManager.Foundations.CheckNameAvailabilityRequest) - [`CheckNameAvailabilityResponse`](./data-types.md#Azure.ResourceManager.Foundations.CheckNameAvailabilityResponse) +- [`DefaultBaseParameters`](./data-types.md#Azure.ResourceManager.Foundations.DefaultBaseParameters) - [`ErrorAdditionalInfo`](./data-types.md#Azure.ResourceManager.Foundations.ErrorAdditionalInfo) - [`ErrorDetail`](./data-types.md#Azure.ResourceManager.Foundations.ErrorDetail) - [`ExtensionBaseParameters`](./data-types.md#Azure.ResourceManager.Foundations.ExtensionBaseParameters) 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 54082c820c..71de518eca 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 @@ -13,19 +13,19 @@ toc_max_heading_level: 3 A composite interface for resource collections that include a paginated list operation. ```typespec -interface Azure.ResourceManager.ExtensionResourceCollectionOperations +interface Azure.ResourceManager.ExtensionResourceCollectionOperations ``` #### Template Parameters -| Name | Description | -| --------- | ---------------------------------------------- | -| TResource | The ArmResource that provides these operations | +| Name | Description | +| -------- | ---------------------------------------------- | +| Resource | The ArmResource that provides these operations | #### `ExtensionResourceCollectionOperations.list` {#Azure.ResourceManager.ExtensionResourceCollectionOperations.list} ```typespec -op Azure.ResourceManager.ExtensionResourceCollectionOperations.list(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceCollectionOperations.list(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ExtensionResourceInstanceOperations` {#Azure.ResourceManager.ExtensionResourceInstanceOperations} @@ -33,38 +33,38 @@ op Azure.ResourceManager.ExtensionResourceCollectionOperations.list(apiVersion: A composite interface for resources that includes CRUD operations. ```typespec -interface Azure.ResourceManager.ExtensionResourceInstanceOperations +interface Azure.ResourceManager.ExtensionResourceInstanceOperations ``` #### Template Parameters -| Name | Description | -| ----------- | ---------------------------------------------- | -| TResource | The ArmResource that provides these operations | -| TProperties | RP-specific property bag for the resource | +| Name | Description | +| ---------- | ---------------------------------------------- | +| Resource | The ArmResource that provides these operations | +| Properties | RP-specific property bag for the resource | #### `ExtensionResourceInstanceOperations.get` {#Azure.ResourceManager.ExtensionResourceInstanceOperations.get} ```typespec -op Azure.ResourceManager.ExtensionResourceInstanceOperations.get(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceInstanceOperations.get(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceInstanceOperations.createOrUpdate` {#Azure.ResourceManager.ExtensionResourceInstanceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.ExtensionResourceInstanceOperations.createOrUpdate(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced, resource: TResource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceInstanceOperations.createOrUpdate(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceInstanceOperations.update` {#Azure.ResourceManager.ExtensionResourceInstanceOperations.update} ```typespec -op Azure.ResourceManager.ExtensionResourceInstanceOperations.update(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceInstanceOperations.update(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceInstanceOperations.delete` {#Azure.ResourceManager.ExtensionResourceInstanceOperations.delete} ```typespec -op Azure.ResourceManager.ExtensionResourceInstanceOperations.delete(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceInstanceOperations.delete(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` ### `ExtensionResourceOperations` {#Azure.ResourceManager.ExtensionResourceOperations} @@ -72,44 +72,44 @@ op Azure.ResourceManager.ExtensionResourceInstanceOperations.delete(apiVersion: A composite interface for resources that include CRUD and list operations. ```typespec -interface Azure.ResourceManager.ExtensionResourceOperations +interface Azure.ResourceManager.ExtensionResourceOperations ``` #### Template Parameters -| Name | Description | -| ----------- | ---------------------------------------------- | -| TResource | The ArmResource that provides these operations | -| TProperties | RP-specific property bag for the resource | +| Name | Description | +| ---------- | ---------------------------------------------- | +| Resource | The ArmResource that provides these operations | +| Properties | RP-specific property bag for the resource | #### `ExtensionResourceOperations.get` {#Azure.ResourceManager.ExtensionResourceOperations.get} ```typespec -op Azure.ResourceManager.ExtensionResourceOperations.get(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceOperations.get(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceOperations.createOrUpdate` {#Azure.ResourceManager.ExtensionResourceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.ExtensionResourceOperations.createOrUpdate(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced, resource: TResource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceOperations.createOrUpdate(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceOperations.update` {#Azure.ResourceManager.ExtensionResourceOperations.update} ```typespec -op Azure.ResourceManager.ExtensionResourceOperations.update(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceOperations.update(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceOperations.delete` {#Azure.ResourceManager.ExtensionResourceOperations.delete} ```typespec -op Azure.ResourceManager.ExtensionResourceOperations.delete(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceOperations.delete(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceOperations.list` {#Azure.ResourceManager.ExtensionResourceOperations.list} ```typespec -op Azure.ResourceManager.ExtensionResourceOperations.list(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceOperations.list(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `Operations` {#Azure.ResourceManager.Operations} @@ -133,8 +133,8 @@ op Azure.ResourceManager.Operations.list(apiVersion: string, provider: Microsoft ### `ProxyResourceOperations` {#Azure.ResourceManager.ProxyResourceOperations} -A composite interface for Proxy resources that include `ResourceInstanceOperations` -and `ResourceListByParent`. It includes: `GET`, `PUT`, `PATCH`, `DELETE`, ListByParent operations. +A composite interface for Proxy resources that include `ResourceInstanceOperations` +and `ResourceListByParent`. It includes: `GET`, `PUT`, `PATCH`, `DELETE`, ListByParent operations. The actual route depends on the resource model but would have started with `/subscriptions/{id}/resourcegroups/{rg}/providers/Microsoft.XXX/...` @@ -142,38 +142,38 @@ The actual route depends on the resource model but would have started with This is the most common API pattern for Proxy Resources to use. ```typespec -interface Azure.ResourceManager.ProxyResourceOperations +interface Azure.ResourceManager.ProxyResourceOperations ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------ | -| TResource | the ArmResource that provides these operations | -| TBaseParameters | The http parameters that are part of the request | +| Name | Description | +| -------------- | ------------------------------------------------ | +| Resource | the ArmResource that provides these operations | +| BaseParameters | The http parameters that are part of the request | #### `ProxyResourceOperations.get` {#Azure.ResourceManager.ProxyResourceOperations.get} ```typespec -op Azure.ResourceManager.ProxyResourceOperations.get(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ProxyResourceOperations.get(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ProxyResourceOperations.createOrUpdate` {#Azure.ResourceManager.ProxyResourceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.ProxyResourceOperations.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: TResource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ProxyResourceOperations.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `ProxyResourceOperations.delete` {#Azure.ResourceManager.ProxyResourceOperations.delete} ```typespec -op Azure.ResourceManager.ProxyResourceOperations.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ProxyResourceOperations.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### `ProxyResourceOperations.listByResourceGroup` {#Azure.ResourceManager.ProxyResourceOperations.listByResourceGroup} ```typespec -op Azure.ResourceManager.ProxyResourceOperations.listByResourceGroup(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ProxyResourceOperations.listByResourceGroup(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ResourceCollectionOperations` {#Azure.ResourceManager.ResourceCollectionOperations} @@ -181,26 +181,26 @@ op Azure.ResourceManager.ProxyResourceOperations.listByResourceGroup(provider: M A composite interface for resource collections. ```typespec -interface Azure.ResourceManager.ResourceCollectionOperations +interface Azure.ResourceManager.ResourceCollectionOperations ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------ | -| TResource | The ArmResource that provides these operations | -| TBaseParameters | The http parameters that are part of the request | +| Name | Description | +| -------------- | ------------------------------------------------ | +| Resource | The ArmResource that provides these operations | +| BaseParameters | The http parameters that are part of the request | #### `ResourceCollectionOperations.listByResourceGroup` {#Azure.ResourceManager.ResourceCollectionOperations.listByResourceGroup} ```typespec -op Azure.ResourceManager.ResourceCollectionOperations.listByResourceGroup(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceCollectionOperations.listByResourceGroup(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` #### `ResourceCollectionOperations.listBySubscription` {#Azure.ResourceManager.ResourceCollectionOperations.listBySubscription} ```typespec -op Azure.ResourceManager.ResourceCollectionOperations.listBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceCollectionOperations.listBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ResourceCreateAsync` {#Azure.ResourceManager.ResourceCreateAsync} @@ -208,20 +208,20 @@ op Azure.ResourceManager.ResourceCollectionOperations.listBySubscription(apiVers A composite interface for resources that include a long-running create or update operation. ```typespec -interface Azure.ResourceManager.ResourceCreateAsync +interface Azure.ResourceManager.ResourceCreateAsync ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------ | -| TResource | The ArmResource that provides these operations | -| TBaseParameters | The http parameters that are part of the request | +| Name | Description | +| -------------- | ------------------------------------------------ | +| Resource | The ArmResource that provides these operations | +| BaseParameters | The http parameters that are part of the request | #### `ResourceCreateAsync.createOrUpdate` {#Azure.ResourceManager.ResourceCreateAsync.createOrUpdate} ```typespec -op Azure.ResourceManager.ResourceCreateAsync.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: TResource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceCreateAsync.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` ### `ResourceCreateSync` {#Azure.ResourceManager.ResourceCreateSync} @@ -229,39 +229,39 @@ op Azure.ResourceManager.ResourceCreateAsync.createOrUpdate(provider: Microsoft. A composite interface for resources that include a synchronous create or update operation. ```typespec -interface Azure.ResourceManager.ResourceCreateSync +interface Azure.ResourceManager.ResourceCreateSync ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------ | -| TResource | The ArmResource that provides these operations | -| TBaseParameters | The http parameters that are part of the request | +| Name | Description | +| -------------- | ------------------------------------------------ | +| Resource | The ArmResource that provides these operations | +| BaseParameters | The http parameters that are part of the request | #### `ResourceCreateSync.createOrUpdate` {#Azure.ResourceManager.ResourceCreateSync.createOrUpdate} ```typespec -op Azure.ResourceManager.ResourceCreateSync.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: TResource): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceCreateSync.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` ### `ResourceDeleteAsync` {#Azure.ResourceManager.ResourceDeleteAsync} ```typespec -interface Azure.ResourceManager.ResourceDeleteAsync +interface Azure.ResourceManager.ResourceDeleteAsync ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------ | -| TResource | The ArmResource that provides these operations | -| TBaseParameters | The http parameters that are part of the request | +| Name | Description | +| -------------- | ------------------------------------------------ | +| Resource | The ArmResource that provides these operations | +| BaseParameters | The http parameters that are part of the request | #### `ResourceDeleteAsync.delete` {#Azure.ResourceManager.ResourceDeleteAsync.delete} ```typespec -op Azure.ResourceManager.ResourceDeleteAsync.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceDeleteAsync.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` ### `ResourceDeleteSync` {#Azure.ResourceManager.ResourceDeleteSync} @@ -269,15 +269,15 @@ op Azure.ResourceManager.ResourceDeleteAsync.delete(provider: Microsoft.ThisWill A composite interface for resources that include a synchronous delete operation. ```typespec -interface Azure.ResourceManager.ResourceDeleteSync +interface Azure.ResourceManager.ResourceDeleteSync ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------ | -| TResource | The ArmResource that provides these operations | -| TBaseParameters | The http parameters that are part of the request | +| Name | Description | +| -------------- | ------------------------------------------------ | +| Resource | The ArmResource that provides these operations | +| BaseParameters | The http parameters that are part of the request | #### `ResourceDeleteSync.delete` {#Azure.ResourceManager.ResourceDeleteSync.delete} @@ -288,20 +288,20 @@ op Azure.ResourceManager.ResourceDeleteSync.delete(provider: Microsoft.ThisWillB ### `ResourceDeleteWithoutOkAsync` {#Azure.ResourceManager.ResourceDeleteWithoutOkAsync} ```typespec -interface Azure.ResourceManager.ResourceDeleteWithoutOkAsync +interface Azure.ResourceManager.ResourceDeleteWithoutOkAsync ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------ | -| TResource | The ArmResource that provides these operations | -| TBaseParameters | The http parameters that are part of the request | +| Name | Description | +| -------------- | ------------------------------------------------ | +| Resource | The ArmResource that provides these operations | +| BaseParameters | The http parameters that are part of the request | #### `ResourceDeleteWithoutOkAsync.delete` {#Azure.ResourceManager.ResourceDeleteWithoutOkAsync.delete} ```typespec -op Azure.ResourceManager.ResourceDeleteWithoutOkAsync.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeleteAcceptedLroResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceDeleteWithoutOkAsync.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` ### `ResourceInstanceOperations` {#Azure.ResourceManager.ResourceInstanceOperations} @@ -309,40 +309,40 @@ op Azure.ResourceManager.ResourceDeleteWithoutOkAsync.delete(provider: Microsoft A composite interface for resources that have CRUD operations. ```typespec -interface Azure.ResourceManager.ResourceInstanceOperations +interface Azure.ResourceManager.ResourceInstanceOperations ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------ | -| TResource | The ArmResource that provides these operations | -| TProperties | RP-specific property bag for the resource | -| TBaseParameters | The http parameters that are part of the request | -| TPatchModel | The model used for PATCH operations | +| Name | Description | +| -------------- | ------------------------------------------------ | +| Resource | The ArmResource that provides these operations | +| Properties | RP-specific property bag for the resource | +| BaseParameters | The http parameters that are part of the request | +| PatchModel | The model used for PATCH operations | #### `ResourceInstanceOperations.get` {#Azure.ResourceManager.ResourceInstanceOperations.get} ```typespec -op Azure.ResourceManager.ResourceInstanceOperations.get(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceInstanceOperations.get(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceInstanceOperations.createOrUpdate` {#Azure.ResourceManager.ResourceInstanceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.ResourceInstanceOperations.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: TResource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceInstanceOperations.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceInstanceOperations.update` {#Azure.ResourceManager.ResourceInstanceOperations.update} ```typespec -op Azure.ResourceManager.ResourceInstanceOperations.update(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceInstanceOperations.update(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceInstanceOperations.delete` {#Azure.ResourceManager.ResourceInstanceOperations.delete} ```typespec -op Azure.ResourceManager.ResourceInstanceOperations.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceInstanceOperations.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` ### `ResourceListByParent` {#Azure.ResourceManager.ResourceListByParent} @@ -350,22 +350,22 @@ op Azure.ResourceManager.ResourceInstanceOperations.delete(provider: Microsoft.T An interface for resources which can be listed by parent. ```typespec -interface Azure.ResourceManager.ResourceListByParent +interface Azure.ResourceManager.ResourceListByParent ``` #### Template Parameters -| Name | Description | -| ------------------- | ------------------------------------------------ | -| TResource | The ArmResource that provides these operations | -| TBaseParameters | The http parameters that are part of the request | -| TParentName | The name of the parent resource | -| TParentFriendlyName | The friendly name of the parent resource | +| Name | Description | +| ------------------ | ------------------------------------------------ | +| Resource | The ArmResource that provides these operations | +| BaseParameters | The http parameters that are part of the request | +| ParentName | The name of the parent resource | +| ParentFriendlyName | The friendly name of the parent resource | #### `ResourceListByParent.listByParent` {#Azure.ResourceManager.ResourceListByParent.listByParent} ```typespec -op Azure.ResourceManager.ResourceListByParent.listByParent(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceListByParent.listByParent(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ResourceListBySubscription` {#Azure.ResourceManager.ResourceListBySubscription} @@ -373,69 +373,69 @@ op Azure.ResourceManager.ResourceListByParent.listByParent(provider: Microsoft.T An interface for resources with can be listed by subscription. ```typespec -interface Azure.ResourceManager.ResourceListBySubscription +interface Azure.ResourceManager.ResourceListBySubscription ``` #### Template Parameters -| Name | Description | -| --------- | ---------------------------------------------- | -| TResource | The ArmResource that provides these operations | +| Name | Description | +| -------- | ---------------------------------------------- | +| Resource | The ArmResource that provides these operations | #### `ResourceListBySubscription.listBySubscription` {#Azure.ResourceManager.ResourceListBySubscription.listBySubscription} ```typespec -op Azure.ResourceManager.ResourceListBySubscription.listBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceListBySubscription.listBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ResourceOperations` {#Azure.ResourceManager.ResourceOperations} ```typespec -interface Azure.ResourceManager.ResourceOperations +interface Azure.ResourceManager.ResourceOperations ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------ | -| TResource | the ArmResource that provides these operations | -| TProperties | RP-specific property bag for the resource | -| TBaseParameters | The http parameters that are part of the request | +| Name | Description | +| -------------- | ------------------------------------------------ | +| Resource | the ArmResource that provides these operations | +| Properties | RP-specific property bag for the resource | +| BaseParameters | The http parameters that are part of the request | #### `ResourceOperations.get` {#Azure.ResourceManager.ResourceOperations.get} ```typespec -op Azure.ResourceManager.ResourceOperations.get(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceOperations.get(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceOperations.createOrUpdate` {#Azure.ResourceManager.ResourceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.ResourceOperations.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: TResource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceOperations.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceOperations.update` {#Azure.ResourceManager.ResourceOperations.update} ```typespec -op Azure.ResourceManager.ResourceOperations.update(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceOperations.update(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceOperations.delete` {#Azure.ResourceManager.ResourceOperations.delete} ```typespec -op Azure.ResourceManager.ResourceOperations.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceOperations.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceOperations.listByResourceGroup` {#Azure.ResourceManager.ResourceOperations.listByResourceGroup} ```typespec -op Azure.ResourceManager.ResourceOperations.listByResourceGroup(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceOperations.listByResourceGroup(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` #### `ResourceOperations.listBySubscription` {#Azure.ResourceManager.ResourceOperations.listBySubscription} ```typespec -op Azure.ResourceManager.ResourceOperations.listBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceOperations.listBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ResourceRead` {#Azure.ResourceManager.ResourceRead} @@ -443,40 +443,40 @@ op Azure.ResourceManager.ResourceOperations.listBySubscription(apiVersion: strin A composite interface for resources that include a GET operation. ```typespec -interface Azure.ResourceManager.ResourceRead +interface Azure.ResourceManager.ResourceRead ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------ | -| TResource | The ArmResource that provides these operations | -| TBaseParameters | The http parameters that are part of the request | +| Name | Description | +| -------------- | ------------------------------------------------ | +| Resource | The ArmResource that provides these operations | +| BaseParameters | The http parameters that are part of the request | #### `ResourceRead.get` {#Azure.ResourceManager.ResourceRead.get} ```typespec -op Azure.ResourceManager.ResourceRead.get(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceRead.get(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` ### `ResourceUpdateAsync` {#Azure.ResourceManager.ResourceUpdateAsync} ```typespec -interface Azure.ResourceManager.ResourceUpdateAsync +interface Azure.ResourceManager.ResourceUpdateAsync ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------ | -| TResource | The ArmResource that provides these operations | -| TProperties | RP-specific property bag for the resource | -| TBaseParameters | The http parameters that are part of the request | +| Name | Description | +| -------------- | ------------------------------------------------ | +| Resource | The ArmResource that provides these operations | +| Properties | RP-specific property bag for the resource | +| BaseParameters | The http parameters that are part of the request | #### `ResourceUpdateAsync.update` {#Azure.ResourceManager.ResourceUpdateAsync.update} ```typespec -op Azure.ResourceManager.ResourceUpdateAsync.update(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ArmAcceptedLroResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceUpdateAsync.update(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ArmAcceptedLroResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ResourceUpdateSync` {#Azure.ResourceManager.ResourceUpdateSync} @@ -484,27 +484,27 @@ op Azure.ResourceManager.ResourceUpdateAsync.update(provider: Microsoft.ThisWill A composite interface for resources that include a synchronous update operation. ```typespec -interface Azure.ResourceManager.ResourceUpdateSync +interface Azure.ResourceManager.ResourceUpdateSync ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------ | -| TResource | The ArmResource that provides these operations | -| TProperties | RP-specific property bag for the resource | -| TBaseParameters | The http parameters that are part of the request | +| Name | Description | +| -------------- | ------------------------------------------------ | +| Resource | The ArmResource that provides these operations | +| Properties | RP-specific property bag for the resource | +| BaseParameters | The http parameters that are part of the request | #### `ResourceUpdateSync.update` {#Azure.ResourceManager.ResourceUpdateSync.update} ```typespec -op Azure.ResourceManager.ResourceUpdateSync.update(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceUpdateSync.update(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` ### `TenantResourceOperations` {#Azure.ResourceManager.TenantResourceOperations} -A composite interface for Tenant resources that include `ResourceInstanceOperations` -and `ResourceListByParent`. It includes: `GET`, `PUT`, `PATCH`, `DELETE`, ListByParent operations. +A composite interface for Tenant resources that include `ResourceInstanceOperations` +and `ResourceListByParent`. It includes: `GET`, `PUT`, `PATCH`, `DELETE`, ListByParent operations. The routes are always start at root level: `/providers/Microsoft.XXX/...` @@ -512,99 +512,99 @@ The routes are always start at root level: This is the most common API pattern for Tenant Resources to use. ```typespec -interface Azure.ResourceManager.TenantResourceOperations +interface Azure.ResourceManager.TenantResourceOperations ``` #### Template Parameters -| Name | Description | -| ----------- | ---------------------------------------------- | -| TResource | the ArmResource that provides these operations | -| TProperties | RP-specific property bag for the resource | +| Name | Description | +| ---------- | ---------------------------------------------- | +| Resource | the ArmResource that provides these operations | +| Properties | RP-specific property bag for the resource | #### `TenantResourceOperations.get` {#Azure.ResourceManager.TenantResourceOperations.get} ```typespec -op Azure.ResourceManager.TenantResourceOperations.get(apiVersion: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TenantResourceOperations.get(apiVersion: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `TenantResourceOperations.createOrUpdate` {#Azure.ResourceManager.TenantResourceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.TenantResourceOperations.createOrUpdate(apiVersion: string, provider: Microsoft.ThisWillBeReplaced, resource: TResource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TenantResourceOperations.createOrUpdate(apiVersion: string, provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `TenantResourceOperations.update` {#Azure.ResourceManager.TenantResourceOperations.update} ```typespec -op Azure.ResourceManager.TenantResourceOperations.update(apiVersion: string, provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TenantResourceOperations.update(apiVersion: string, provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `TenantResourceOperations.delete` {#Azure.ResourceManager.TenantResourceOperations.delete} ```typespec -op Azure.ResourceManager.TenantResourceOperations.delete(apiVersion: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TenantResourceOperations.delete(apiVersion: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### `TenantResourceOperations.listByTenant` {#Azure.ResourceManager.TenantResourceOperations.listByTenant} ```typespec -op Azure.ResourceManager.TenantResourceOperations.listByTenant(apiVersion: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TenantResourceOperations.listByTenant(apiVersion: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `TrackedResourceOperations` {#Azure.ResourceManager.TrackedResourceOperations} -A composite interface for resources that include `ResourceInstanceOperations` -and `ResourceCollectionOperations`. It includes: `GET`, `PUT`, `PATCH`, `DELETE`, ListByParent, +A composite interface for resources that include `ResourceInstanceOperations` +and `ResourceCollectionOperations`. It includes: `GET`, `PUT`, `PATCH`, `DELETE`, ListByParent, ListBySubscription operations. The actual route depends on the resource model. This is the most common API pattern for Tracked Resources to use. ```typespec -interface Azure.ResourceManager.TrackedResourceOperations +interface Azure.ResourceManager.TrackedResourceOperations ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------ | -| TResource | the ArmResource that provides these operations | -| TProperties | RP-specific property bag for the resource | -| TBaseParameters | The http parameters that are part of the request | +| Name | Description | +| -------------- | ------------------------------------------------ | +| Resource | the ArmResource that provides these operations | +| Properties | RP-specific property bag for the resource | +| BaseParameters | The http parameters that are part of the request | #### `TrackedResourceOperations.get` {#Azure.ResourceManager.TrackedResourceOperations.get} ```typespec -op Azure.ResourceManager.TrackedResourceOperations.get(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TrackedResourceOperations.get(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `TrackedResourceOperations.createOrUpdate` {#Azure.ResourceManager.TrackedResourceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.TrackedResourceOperations.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: TResource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TrackedResourceOperations.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `TrackedResourceOperations.update` {#Azure.ResourceManager.TrackedResourceOperations.update} ```typespec -op Azure.ResourceManager.TrackedResourceOperations.update(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TrackedResourceOperations.update(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `TrackedResourceOperations.delete` {#Azure.ResourceManager.TrackedResourceOperations.delete} ```typespec -op Azure.ResourceManager.TrackedResourceOperations.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TrackedResourceOperations.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### `TrackedResourceOperations.listByResourceGroup` {#Azure.ResourceManager.TrackedResourceOperations.listByResourceGroup} ```typespec -op Azure.ResourceManager.TrackedResourceOperations.listByResourceGroup(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TrackedResourceOperations.listByResourceGroup(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` #### `TrackedResourceOperations.listBySubscription` {#Azure.ResourceManager.TrackedResourceOperations.listBySubscription} ```typespec -op Azure.ResourceManager.TrackedResourceOperations.listBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TrackedResourceOperations.listBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ArmCustomPatchAsync` {#Azure.ResourceManager.ArmCustomPatchAsync} @@ -612,217 +612,231 @@ op Azure.ResourceManager.TrackedResourceOperations.listBySubscription(apiVersion A long-running resource update using a custom PATCH payload (Asynchronous) ```typespec -op Azure.ResourceManager.ArmCustomPatchAsync(provider: Microsoft.ThisWillBeReplaced, properties: TPatchModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ArmAcceptedLroResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmCustomPatchAsync(provider: Microsoft.ThisWillBeReplaced, properties: PatchModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ArmAcceptedLroResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ---------------------------------------------------- | -| TResource | the resource being patched | -| TPatchModel | The input model for the PATCH request | -| TBaseParameters | Optional. Allows overriding the operation parameters | +| Name | Description | +| -------------- | ----------------------------------------------------------------------------- | +| Resource | the resource being patched | +| PatchModel | The input model for the PATCH request | +| BaseParameters | Optional. Allows overriding the operation parameters | +| LroHeaders | Optional. Allows overriding the lro headers returned in the Accepted response | ### `ArmCustomPatchSync` {#Azure.ResourceManager.ArmCustomPatchSync} A resource update using a custom PATCH payload (synchronous) ```typespec -op Azure.ResourceManager.ArmCustomPatchSync(provider: Microsoft.ThisWillBeReplaced, properties: TPatchModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmCustomPatchSync(provider: Microsoft.ThisWillBeReplaced, properties: PatchModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ---------------------------------------------------- | -| TResource | the resource being patched | -| TPatchModel | The input model for the PATCH request | -| TBaseParameters | Optional. Allows overriding the operation parameters | +| Name | Description | +| -------------- | ---------------------------------------------------- | +| Resource | the resource being patched | +| PatchModel | The input model for the PATCH request | +| BaseParameters | Optional. Allows overriding the operation parameters | ### `ArmListBySubscription` {#Azure.ResourceManager.ArmListBySubscription} A resource list operation, at the subscription scope ```typespec -op Azure.ResourceManager.ArmListBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmListBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------- | -------------------------- | -| TResource | the resource being patched | +| Name | Description | +| -------- | -------------------------- | +| Resource | the resource being patched | ### `ArmResourceActionAsync` {#Azure.ResourceManager.ArmResourceActionAsync} -A long-running resource action. - ```typespec -op Azure.ResourceManager.ArmResourceActionAsync(provider: Microsoft.ThisWillBeReplaced, body: TRequest): Azure.ResourceManager.ArmAcceptedLroResponse | TResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceActionAsync(provider: Microsoft.ThisWillBeReplaced, body: Request): Azure.ResourceManager.ArmAcceptedLroResponse | Response | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------------------ | -| TResource | The resource being acted upon | -| TRequest | The request model for the action | -| TResponse | The response model for the action | -| TBaseParameters | Optional. Allows overriding the parameters for the operation | +| Name | Description | +| -------------- | ------------------------------------------------------------------------- | +| Resource | The resource being acted upon | +| Request | The request model for the action | +| Response | The response model for the action | +| BaseParameters | Optional. Allows overriding the parameters for the operation | +| LroHeaders | Optional. Allows overriding the headers returned in the Accepted response | ### `ArmResourceActionAsyncBase` {#Azure.ResourceManager.ArmResourceActionAsyncBase} A long-running resource action. ```typespec -op Azure.ResourceManager.ArmResourceActionAsyncBase(provider: Microsoft.ThisWillBeReplaced, body: TRequest): TResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceActionAsyncBase(provider: Microsoft.ThisWillBeReplaced, body: Request): Response | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------------------ | -| TResource | The resource being acted upon | -| TRequest | The request model for the action | -| TResponse | The response type for the action | -| TBaseParameters | Optional. Allows overriding the parameters for the operation | +| Name | Description | +| -------------- | ------------------------------------------------------------ | +| Resource | The resource being acted upon | +| Request | The request model for the action | +| Response | The response type for the action | +| BaseParameters | Optional. Allows overriding the parameters for the operation | ### `ArmResourceActionNoContentAsync` {#Azure.ResourceManager.ArmResourceActionNoContentAsync} -A long-running resource action that returns no content. DEPRECATED: Use 'ArmResourceActionNoResponseContentAsync' instead - ```typespec -op Azure.ResourceManager.ArmResourceActionNoContentAsync(provider: Microsoft.ThisWillBeReplaced, body: TRequest): Azure.ResourceManager.ArmAcceptedLroResponse | Azure.ResourceManager.ArmNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceActionNoContentAsync(provider: Microsoft.ThisWillBeReplaced, body: Request): Azure.ResourceManager.ArmAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------------------ | -| TResource | The resource being acted upon | -| TRequest | The request model for the action | -| TBaseParameters | Optional. Allows overriding the parameters for the operation | +| Name | Description | +| -------------- | ------------------------------------------------------------------------- | +| Resource | The resource being acted upon | +| Request | The request model for the action | +| BaseParameters | Optional. Allows overriding the parameters for the operation | +| LroHeaders | Optional. Allows overriding the headers returned in the Accepted response | ### `ArmResourceActionNoContentSync` {#Azure.ResourceManager.ArmResourceActionNoContentSync} A synchronous resource action that returns no content. ```typespec -op Azure.ResourceManager.ArmResourceActionNoContentSync(provider: Microsoft.ThisWillBeReplaced, body: TRequest): Azure.ResourceManager.ArmNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceActionNoContentSync(provider: Microsoft.ThisWillBeReplaced, body: Request): Azure.ResourceManager.ArmNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------------------ | -| TResource | The resource being acted upon | -| TRequest | The request model for the action | -| TBaseParameters | Optional. Allows overriding the parameters for the operation | +| Name | Description | +| -------------- | ------------------------------------------------------------ | +| Resource | The resource being acted upon | +| Request | The request model for the action | +| BaseParameters | Optional. Allows overriding the parameters for the operation | ### `ArmResourceActionNoResponseContentAsync` {#Azure.ResourceManager.ArmResourceActionNoResponseContentAsync} -A long-running resource action that returns no content. - ```typespec -op Azure.ResourceManager.ArmResourceActionNoResponseContentAsync(provider: Microsoft.ThisWillBeReplaced, body: TRequest): Azure.ResourceManager.ArmAcceptedLroResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceActionNoResponseContentAsync(provider: Microsoft.ThisWillBeReplaced, body: Request): Azure.ResourceManager.ArmAcceptedLroResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------------------ | -| TResource | The resource being acted upon | -| TRequest | The request model for the action | -| TBaseParameters | Optional. Allows overriding the parameters for the operation | +| Name | Description | +| -------------- | ------------------------------------------------------------ | +| Resource | The resource being acted upon | +| Request | The request model for the action | +| BaseParameters | Optional. Allows overriding the parameters for the operation | +| LroHeaders | | ### `ArmResourceActionSync` {#Azure.ResourceManager.ArmResourceActionSync} A synchronous resource action. ```typespec -op Azure.ResourceManager.ArmResourceActionSync(provider: Microsoft.ThisWillBeReplaced, body: TRequest): TResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceActionSync(provider: Microsoft.ThisWillBeReplaced, body: Request): Response | Azure.ResourceManager.ErrorResponse +``` + +#### Template Parameters + +| Name | Description | +| -------------- | ------------------------------------------------------------ | +| Resource | The resource being acted upon | +| Request | The request model for the action | +| Response | The response model for the action | +| BaseParameters | Optional. Allows overriding the parameters for the operation | + +### `ArmResourceCreateOrReplaceAsync` {#Azure.ResourceManager.ArmResourceCreateOrReplaceAsync} + +```typespec +op Azure.ResourceManager.ArmResourceCreateOrReplaceAsync(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------------------ | -| TResource | The resource being acted upon | -| TRequest | The request model for the action | -| TResponse | The response model for the action | -| TBaseParameters | Optional. Allows overriding the parameters for the operation | +| Name | Description | +| -------------- | ----------- | +| Resource | | +| BaseParameters | | +| LroHeaders | | ### `ArmResourceCreateOrReplaceSync` {#Azure.ResourceManager.ArmResourceCreateOrReplaceSync} Synchronous PUT operation for ARM resources ```typespec -op Azure.ResourceManager.ArmResourceCreateOrReplaceSync(provider: Microsoft.ThisWillBeReplaced, resource: TResource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedSyncResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceCreateOrReplaceSync(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedSyncResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ---------------------------------------------------- | -| TResource | the resource being patched | -| TBaseParameters | Optional. Allows overriding the operation parameters | +| Name | Description | +| -------------- | ---------------------------------------------------- | +| Resource | the resource being patched | +| BaseParameters | Optional. Allows overriding the operation parameters | ### `ArmResourceCreateOrUpdateAsync` {#Azure.ResourceManager.ArmResourceCreateOrUpdateAsync} A long-running resource CreateOrUpdate (PUT) ```typespec -op Azure.ResourceManager.ArmResourceCreateOrUpdateAsync(provider: Microsoft.ThisWillBeReplaced, resource: TResource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceCreateOrUpdateAsync(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ---------------------------------------------------- | -| TResource | the resource being patched | -| TBaseParameters | Optional. Allows overriding the operation parameters | +| Name | Description | +| -------------- | ----------------------------------------------------------------------- | +| Resource | the resource being patched | +| BaseParameters | Optional. Allows overriding the operation parameters | +| LroHeaders | Optional. Allows overriding the lro headers returned on resource create | ### `ArmResourceCreateOrUpdateSync` {#Azure.ResourceManager.ArmResourceCreateOrUpdateSync} DEPRECATED: Please use ArmResourceCreateOrReplaceSync instead ```typespec -op Azure.ResourceManager.ArmResourceCreateOrUpdateSync(provider: Microsoft.ThisWillBeReplaced, resource: TResource): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceCreateOrUpdateSync(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ---------------------------------------------------- | -| TResource | the resource being patched | -| TBaseParameters | Optional. Allows overriding the operation parameters | +| Name | Description | +| -------------- | ---------------------------------------------------- | +| Resource | the resource being patched | +| BaseParameters | Optional. Allows overriding the operation parameters | ### `ArmResourceDeleteAsync` {#Azure.ResourceManager.ArmResourceDeleteAsync} ```typespec -op Azure.ResourceManager.ArmResourceDeleteAsync(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceDeleteAsync(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------------------ | -| TResource | The resource being deleted | -| TBaseParameters | Optional. Allows overriding the parameters for the operation | +| Name | Description | +| -------------- | ---------------------------------------------------------------- | +| Resource | The resource being deleted | +| BaseParameters | Optional. Allows overriding the parameters for the operation | +| LroHeaders | Optional. Allows overriding the headers in the Accepted response | ### `ArmResourceDeleteAsyncBase` {#Azure.ResourceManager.ArmResourceDeleteAsyncBase} ```typespec -op Azure.ResourceManager.ArmResourceDeleteAsyncBase(provider: Microsoft.ThisWillBeReplaced): TResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceDeleteAsyncBase(provider: Microsoft.ThisWillBeReplaced): Response | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------------------ | -| TResource | The resource being deleted | -| TResponse | The response type for the operation | -| TBaseParameters | Optional. Allows overriding the parameters for the operation | +| Name | Description | +| -------------- | ------------------------------------------------------------ | +| Resource | The resource being deleted | +| Response | The response type for the operation | +| BaseParameters | Optional. Allows overriding the parameters for the operation | ### `ArmResourceDeleteSync` {#Azure.ResourceManager.ArmResourceDeleteSync} @@ -834,106 +848,156 @@ op Azure.ResourceManager.ArmResourceDeleteSync(provider: Microsoft.ThisWillBeRep #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------------------ | -| TResource | The resource being deleted | -| TBaseParameters | Optional. Allows overriding the parameters for the operation | +| Name | Description | +| -------------- | ------------------------------------------------------------ | +| Resource | The resource being deleted | +| BaseParameters | Optional. Allows overriding the parameters for the operation | ### `ArmResourceDeleteWithoutOkAsync` {#Azure.ResourceManager.ArmResourceDeleteWithoutOkAsync} ```typespec -op Azure.ResourceManager.ArmResourceDeleteWithoutOkAsync(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeleteAcceptedLroResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceDeleteWithoutOkAsync(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeleteAcceptedLroResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ------------------------------------------------------------ | -| TResource | The resource being deleted | -| TBaseParameters | Optional. Allows overriding the parameters for the operation | +| Name | Description | +| -------------- | ------------------------------------------------------------------------- | +| Resource | The resource being deleted | +| BaseParameters | Optional. Allows overriding the parameters for the operation | +| LroHeaders | Optional. Allows overriding the headers returned in the Accepted response | ### `ArmResourceListAtScope` {#Azure.ResourceManager.ArmResourceListAtScope} -A resource list operation, with scope determined by TBaseParameters +A resource list operation, with scope determined by BaseParameters ```typespec -op Azure.ResourceManager.ArmResourceListAtScope(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceListAtScope(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ---------------------------------------------------- | -| TResource | the resource being patched | -| TBaseParameters | Optional. Allows overriding the operation parameters | +| Name | Description | +| -------------- | ---------------------------------------------------- | +| Resource | the resource being patched | +| BaseParameters | Optional. Allows overriding the operation parameters | ### `ArmResourceListByParent` {#Azure.ResourceManager.ArmResourceListByParent} A resource list operation, at the scope of the resource's parent ```typespec -op Azure.ResourceManager.ArmResourceListByParent(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceListByParent(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| ------------------- | ---------------------------------------------------- | -| TResource | the resource being patched | -| TBaseParameters | Optional. Allows overriding the operation parameters | -| TParentName | Optional. The name of the parent resource | -| TParentFriendlyName | Optional. The friendly name of the parent resource | +| Name | Description | +| ------------------ | ---------------------------------------------------- | +| Resource | the resource being patched | +| BaseParameters | Optional. Allows overriding the operation parameters | +| ParentName | Optional. The name of the parent resource | +| ParentFriendlyName | Optional. The friendly name of the parent resource | + +### `ArmResourcePatchAsync` {#Azure.ResourceManager.ArmResourcePatchAsync} + +```typespec +op Azure.ResourceManager.ArmResourcePatchAsync(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ArmAcceptedLroResponse | Azure.ResourceManager.ErrorResponse +``` + +#### Template Parameters + +| Name | Description | +| -------------- | ----------------------------------------------------------------------------- | +| Resource | the resource being patched | +| Properties | The model type of the resource properties | +| BaseParameters | Optional. Allows overriding the operation parameters | +| LroHeaders | Optional. Allows overriding the lro headers returned in the Accepted response | + +### `ArmResourcePatchSync` {#Azure.ResourceManager.ArmResourcePatchSync} + +```typespec +op Azure.ResourceManager.ArmResourcePatchSync(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +``` + +#### Template Parameters + +| Name | Description | +| -------------- | ---------------------------------------------------- | +| Resource | the resource being patched | +| Properties | The model type of the resource properties | +| BaseParameters | Optional. Allows overriding the operation parameters | ### `ArmResourceRead` {#Azure.ResourceManager.ArmResourceRead} A resource GET operation ```typespec -op Azure.ResourceManager.ArmResourceRead(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceRead(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| --------------- | ---------------------------------------------------- | -| TResource | the resource being patched | -| TBaseParameters | Optional. Allows overriding the operation parameters | +| Name | Description | +| -------------- | ---------------------------------------------------- | +| Resource | the resource being patched | +| BaseParameters | Optional. Allows overriding the operation parameters | -### `checkGlobalNameAvailability` {#Azure.ResourceManager.checkGlobalNameAvailability} +### `ArmTagsPatchAsync` {#Azure.ResourceManager.ArmTagsPatchAsync} -Adds check global name availability operation, normally used if -a resource name must be globally unique (for example, if the resource -exposes and endpoint that uses the resource name in the url) +```typespec +op Azure.ResourceManager.ArmTagsPatchAsync(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.TagsUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ArmAcceptedLroResponse | Azure.ResourceManager.ErrorResponse +``` + +#### Template Parameters + +| Name | Description | +| -------------- | -------------------------------------------------------------------------------- | +| Resource | the resource being patched | +| Properties | | +| BaseParameters | Optional. Allows overriding the operation parameters | +| LroHeaders | Optional. Allows overriding the lro headers that appear in the Accepted response | + +### `ArmTagsPatchSync` {#Azure.ResourceManager.ArmTagsPatchSync} ```typespec -op Azure.ResourceManager.checkGlobalNameAvailability(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced, body: TRequest): TResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmTagsPatchSync(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.TagsUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| ----------------- | --------------------------------------------------------------------------------------------- | -| TRequest | the availability request, defaults to the standard request, containing name and resource type | -| TResponse | the availability response, default to the standard response | -| TAdditionalParams | A model specifying additional non-path parameters to the availability request | +| Name | Description | +| -------------- | ---------------------------------------------------- | +| Resource | the resource being patched | +| BaseParameters | Optional. Allows overriding the operation parameters | -### `checkLocalNameAvailability` {#Azure.ResourceManager.checkLocalNameAvailability} +### `checkGlobalNameAvailability` {#Azure.ResourceManager.checkGlobalNameAvailability} -Adds check location-specific name availability operation, normally used if -a resource name must be globally unique (for example, if the resource -exposes and endpoint that uses the resource name in the url) +```typespec +op Azure.ResourceManager.checkGlobalNameAvailability(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced, body: Request): Response | Azure.ResourceManager.ErrorResponse +``` + +#### Template Parameters + +| Name | Description | +| ---------------- | --------------------------------------------------------------------------------------------- | +| Request | the availability request, defaults to the standard request, containing name and resource type | +| Response | the availability response, default to the standard response | +| AdditionalParams | A model specifying additional non-path parameters to the availability request | + +### `checkLocalNameAvailability` {#Azure.ResourceManager.checkLocalNameAvailability} ```typespec -op Azure.ResourceManager.checkLocalNameAvailability(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced, location: string, body: TRequest): TResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.checkLocalNameAvailability(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced, location: string, body: Request): Response | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| ----------------- | --------------------------------------------------------------------------------------------- | -| TRequest | the availability request, defaults to the standard request, containing name and resource type | -| TResponse | the availability response, default to the standard response | -| TAdditionalParams | A model specifying additional non-path parameters to the availability request | +| Name | Description | +| ---------------- | --------------------------------------------------------------------------------------------- | +| Request | the availability request, defaults to the standard request, containing name and resource type | +| Response | the availability response, default to the standard response | +| AdditionalParams | A model specifying additional non-path parameters to the availability request | ## Azure.ResourceManager.Foundations @@ -944,14 +1008,14 @@ a resource name must be globally unique (for example, if the resource exposes an endpoint that uses the resource name in the url) ```typespec -op Azure.ResourceManager.Foundations.checkNameAvailability(apiVersion: string, body: TRequest): TResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.Foundations.checkNameAvailability(apiVersion: string, body: Request): Response | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters -| Name | Description | -| ----------------- | ------------------------------------------------------------------------ | -| TScopeParameters | A parameter model with properties representing the scope of the resource | -| TRequest | The operation request body | -| TResponse | The operation response | -| TAdditionalParams | A parameter model with properties representing non-path parameters | +| Name | Description | +| ---------------- | ------------------------------------------------------------------------ | +| ScopeParameters | A parameter model with properties representing the scope of the resource | +| Request | The operation request body | +| Response | The operation response | +| AdditionalParams | A parameter model with properties representing non-path parameters | 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 40dd39c6cb..0765484433 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 @@ -3,13 +3,11 @@ jsApi: true title: "[P] JS Api" --- -## Exports - -### Enumerations +## Enumerations - [ResourceBaseType](enumerations/ResourceBaseType.md) -### Interfaces +## Interfaces - [ArmCommonTypeVersions](interfaces/ArmCommonTypeVersions.md) - [ArmLifecycleOperations](interfaces/ArmLifecycleOperations.md) @@ -18,18 +16,18 @@ title: "[P] JS Api" - [ArmResourceOperation](interfaces/ArmResourceOperation.md) - [ArmResourceOperations](interfaces/ArmResourceOperations.md) -### Type Aliases +## Type Aliases - [ArmLifecycleOperationKind](type-aliases/ArmLifecycleOperationKind.md) - [ArmOperationKind](type-aliases/ArmOperationKind.md) - [ArmResourceKind](type-aliases/ArmResourceKind.md) -### Variables +## Variables - [$lib](variables/$lib.md) - [namespace](variables/namespace.md) -### Functions +## Functions - [$armCommonTypesVersion](functions/$armCommonTypesVersion.md) - [$armLibraryNamespace](functions/$armLibraryNamespace.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmLifecycleOperations.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmLifecycleOperations.md index 191909d9eb..94fec23a8c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmLifecycleOperations.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmLifecycleOperations.md @@ -7,7 +7,7 @@ title: "[I] ArmLifecycleOperations" | Property | Type | Description | | :------ | :------ | :------ | -| `createOrUpdate`? | [`ArmResourceOperation`](ArmResourceOperation.md) | - | -| `delete`? | [`ArmResourceOperation`](ArmResourceOperation.md) | - | -| `read`? | [`ArmResourceOperation`](ArmResourceOperation.md) | - | -| `update`? | [`ArmResourceOperation`](ArmResourceOperation.md) | - | +| `createOrUpdate?` | [`ArmResourceOperation`](ArmResourceOperation.md) | - | +| `delete?` | [`ArmResourceOperation`](ArmResourceOperation.md) | - | +| `read?` | [`ArmResourceOperation`](ArmResourceOperation.md) | - | +| `update?` | [`ArmResourceOperation`](ArmResourceOperation.md) | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceDetails.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceDetails.md index 5e81bdb9fe..dcad67d6eb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceDetails.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceDetails.md @@ -13,11 +13,11 @@ Interface for ARM resource detail base. | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `armProviderNamespace` | `string` | - | [`ArmResourceDetailsBase`](ArmResourceDetailsBase.md).`armProviderNamespace` | -| `collectionName` | `string` | - | [`ArmResourceDetailsBase`](ArmResourceDetailsBase.md).`collectionName` | -| `keyName` | `string` | - | [`ArmResourceDetailsBase`](ArmResourceDetailsBase.md).`keyName` | -| `kind` | [`ArmResourceKind`](../type-aliases/ArmResourceKind.md) | - | [`ArmResourceDetailsBase`](ArmResourceDetailsBase.md).`kind` | -| `name` | `string` | - | [`ArmResourceDetailsBase`](ArmResourceDetailsBase.md).`name` | +| `armProviderNamespace` | `string` | - | [`ArmResourceDetailsBase.armProviderNamespace`](ArmResourceDetailsBase.md) | +| `collectionName` | `string` | - | [`ArmResourceDetailsBase.collectionName`](ArmResourceDetailsBase.md) | +| `keyName` | `string` | - | [`ArmResourceDetailsBase.keyName`](ArmResourceDetailsBase.md) | +| `kind` | [`ArmResourceKind`](../type-aliases/ArmResourceKind.md) | - | [`ArmResourceDetailsBase.kind`](ArmResourceDetailsBase.md) | +| `name` | `string` | - | [`ArmResourceDetailsBase.name`](ArmResourceDetailsBase.md) | | `operations` | [`ArmResourceOperations`](ArmResourceOperations.md) | - | - | -| `resourceTypePath`? | `string` | - | - | -| `typespecType` | `Model` | - | [`ArmResourceDetailsBase`](ArmResourceDetailsBase.md).`typespecType` | +| `resourceTypePath?` | `string` | - | - | +| `typespecType` | `Model` | - | [`ArmResourceDetailsBase.typespecType`](ArmResourceDetailsBase.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperation.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperation.md index 400e2fabff..1f141bc290 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperation.md @@ -12,8 +12,8 @@ title: "[I] ArmResourceOperation" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | | `httpOperation` | `HttpOperation` | - | - | -| `kind` | [`ArmOperationKind`](../type-aliases/ArmOperationKind.md) | - | ArmResourceOperationData.kind | -| `name` | `string` | - | ArmResourceOperationData.name | -| `operation` | `Operation` | - | ArmResourceOperationData.operation | -| `operationGroup` | `string` | - | ArmResourceOperationData.operationGroup | +| `kind` | [`ArmOperationKind`](../type-aliases/ArmOperationKind.md) | - | `ArmResourceOperationData.kind` | +| `name` | `string` | - | `ArmResourceOperationData.name` | +| `operation` | `Operation` | - | `ArmResourceOperationData.operation` | +| `operationGroup` | `string` | - | `ArmResourceOperationData.operationGroup` | | `path` | `string` | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperations.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperations.md index f59f44d341..16211cca82 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperations.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperations.md @@ -7,6 +7,6 @@ title: "[I] ArmResourceOperations" | Property | Type | Description | | :------ | :------ | :------ | -| `actions` | `object` | - | +| `actions` | `Object` | - | | `lifecycle` | [`ArmLifecycleOperations`](ArmLifecycleOperations.md) | - | -| `lists` | `object` | - | +| `lists` | `Object` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/variables/$lib.md index 3da9627f33..7077cb0b42 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/variables/$lib.md @@ -4,5 +4,36 @@ title: "[V] $lib" --- ```ts -const $lib: TypeSpecLibrary>; +const $lib: TypeSpecLibrary, never>; ``` + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `arm-common-types-incompatible-version` | `Object` | - | +| `arm-common-types-incompatible-version.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `arm-resource-circular-ancestry` | `Object` | - | +| `arm-resource-circular-ancestry.default` | `string` | - | +| `arm-resource-duplicate-base-parameter` | `Object` | - | +| `arm-resource-duplicate-base-parameter.default` | `string` | - | +| `arm-resource-invalid-base-type` | `Object` | - | +| `arm-resource-invalid-base-type.default` | `string` | - | +| `arm-resource-missing` | `Object` | - | +| `arm-resource-missing.default` | `CallableMessage`<[`string`]\> | - | +| `arm-resource-missing-arm-namespace` | `Object` | - | +| `arm-resource-missing-arm-namespace.default` | `string` | - | +| `arm-resource-missing-name-key-decorator` | `Object` | - | +| `arm-resource-missing-name-key-decorator.default` | `string` | - | +| `arm-resource-missing-name-property` | `Object` | - | +| `arm-resource-missing-name-property.default` | `string` | - | +| `arm-resource-missing-name-segment-decorator` | `Object` | - | +| `arm-resource-missing-name-segment-decorator.default` | `string` | - | +| `decorator-in-namespace` | `Object` | - | +| `decorator-in-namespace.default` | `CallableMessage`<[`string`]\> | - | +| `decorator-param-wrong-type` | `Object` | - | +| `decorator-param-wrong-type.armUpdateProviderNamespace` | `string` | - | +| `parent-type` | `Object` | - | +| `parent-type.notResourceType` | `CallableMessage`<[`string`, `string`]\> | - | +| `single-arm-provider` | `Object` | - | +| `single-arm-provider.default` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/decorators.md index e010294943..0e32fe7902 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/decorators.md @@ -118,6 +118,40 @@ model MyModel { } ``` +### `@clientName` {#@Azure.ClientGenerator.Core.clientName} + +Changes the name of a method, parameter, property, or model generated in the client SDK + +```typespec +@Azure.ClientGenerator.Core.clientName(rename: valueof string, scope?: valueof string) +``` + +#### Target + +`(intrinsic) unknown` + +#### Parameters + +| Name | Type | Description | +| ------ | ----------------------- | ------------------------------------------------------------------------------------------------------------- | +| rename | `valueof scalar string` | The rename you want applied to the object | +| scope | `valueof scalar string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | + +#### Examples + +```typespec +@clientName("nameInClient") +op nameInService: void; +``` + +```typespec +@clientName("nameForJava", "java") +@clientName("name_for_python", "python") +@clientName("nameForCsharp", "csharp") +@clientName("nameForJavascript", "javascript") +op nameInService: void; +``` + ### `@convenientAPI` {#@Azure.ClientGenerator.Core.convenientAPI} Whether you want to generate an operation as a convenient operation. @@ -172,6 +206,34 @@ model ModelToExclude { } ``` +### `@flattenProperty` {#@Azure.ClientGenerator.Core.flattenProperty} + +Set whether a model property should be flattened or not. + +```typespec +@Azure.ClientGenerator.Core.flattenProperty(scope?: valueof string) +``` + +#### Target + +`ModelProperty` + +#### Parameters + +| Name | Type | Description | +| ----- | ----------------------- | ------------------------------------------------------------------------------------------------------------- | +| scope | `valueof scalar string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | + +#### Examples + +```typespec +model Foo { + @flattenProperty + prop: Bar; +} +model Bar {} +``` + ### `@include` {#@Azure.ClientGenerator.Core.include} Whether to include a model in generation for specific languages. By default we generate diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/index.mdx b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/index.mdx index 393298f789..8f47aef4aa 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/index.mdx +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/index.mdx @@ -42,8 +42,10 @@ npm install --save-peer @azure-tools/typespec-client-generator-core - [`@access`](./decorators.md#@Azure.ClientGenerator.Core.access) - [`@client`](./decorators.md#@Azure.ClientGenerator.Core.client) - [`@clientFormat`](./decorators.md#@Azure.ClientGenerator.Core.clientFormat) +- [`@clientName`](./decorators.md#@Azure.ClientGenerator.Core.clientName) - [`@convenientAPI`](./decorators.md#@Azure.ClientGenerator.Core.convenientAPI) - [`@exclude`](./decorators.md#@Azure.ClientGenerator.Core.exclude) +- [`@flattenProperty`](./decorators.md#@Azure.ClientGenerator.Core.flattenProperty) - [`@include`](./decorators.md#@Azure.ClientGenerator.Core.include) - [`@internal`](./decorators.md#@Azure.ClientGenerator.Core.internal) - [`@operationGroup`](./decorators.md#@Azure.ClientGenerator.Core.operationGroup) diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/$clientName.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/$clientName.md new file mode 100644 index 0000000000..4a682bd961 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/$clientName.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $clientName" + +--- +```ts +$clientName( + context, + entity, + value, + scope?): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `entity` | `Type` | +| `value` | `string` | +| `scope`? | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/$flattenProperty.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/$flattenProperty.md new file mode 100644 index 0000000000..9312721198 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/$flattenProperty.md @@ -0,0 +1,29 @@ +--- +jsApi: true +title: "[F] $flattenProperty" + +--- +```ts +$flattenProperty( + context, + target, + scope?): void +``` + +Whether a model property should be flattened. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | `DecoratorContext` | DecoratorContext | +| `target` | `ModelProperty` | ModelProperty to mark as flattened | +| `scope`? | `string` | Names of the projection (e.g. "python", "csharp", "java", "javascript") | + +## Returns + +`void` + +## Deprecated + +This decorator is not recommended to use. diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createDiagnostic.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createDiagnostic.md index 0ee302e15d..5929dacc05 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createDiagnostic.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createDiagnostic.md @@ -23,7 +23,8 @@ createDiagnostic(diag): Diagnostic \| `"invalid-usage"` \| `"invalid-encode"` \| `"discriminator-not-constant"` - \| `"discriminator-not-string"` | + \| `"discriminator-not-string"` + \| `"wrong-client-decorator"` | | `M` extends `string` \| `number` \| `symbol` | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createSdkContext.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createSdkContext.md index 1a7144a532..363718b8b6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createSdkContext.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createSdkContext.md @@ -9,7 +9,7 @@ createSdkContext(context, emitterName?): SdkContext ## Type parameters -| Parameter | Default | +| Parameter | Value | | :------ | :------ | | `TOptions` extends `Record`<`string`, `any`\> | [`SdkEmitterOptions`](../interfaces/SdkEmitterOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClient.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClient.md index 564a6e4ce3..59731c5dc2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClient.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClient.md @@ -7,13 +7,17 @@ title: "[F] getClient" getClient(context, type): SdkClient | undefined ``` +Return the client object for the given namespace or interface, or undefined if the given namespace or interface is not a client. + ## Parameters -| Parameter | Type | -| :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | -| `type` | `Interface` \| `Namespace` | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | SdkContext | +| `type` | `Interface` \| `Namespace` | Type to check | ## Returns [`SdkClient`](../interfaces/SdkClient.md) \| `undefined` + +Client or undefined diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientNameOverride.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientNameOverride.md new file mode 100644 index 0000000000..124d5873f3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientNameOverride.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getClientNameOverride" + +--- +```ts +getClientNameOverride(context, entity): string | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `entity` | `Type` | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getLibraryName.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getLibraryName.md index 3b8f6163f4..46598da2d5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getLibraryName.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getLibraryName.md @@ -10,17 +10,18 @@ getLibraryName(context, type): string Get the library name of a property / parameter / operation / model / enum. Takes projections into account Returns name in the following order of priority -1. language emitter name, i.e. @projectedName("csharp", "csharpSpecificName") => "csharpSpecificName" -2. client name, i.e. @projectedName("client", "clientName") => "clientName" -3. friendly name, i.e. @friendlyName("friendlyName") => "friendlyName" -4. name in typespec +1. language emitter name, i.e. @clientName("csharpSpecificName", "csharp") => "csharpSpecificName" +2. client name, i.e. @clientName(""clientName") => "clientName" +3. deprecated projected name +4. friendly name, i.e. @friendlyName("friendlyName") => "friendlyName" +5. name in typespec ## Parameters | Parameter | Type | Description | | :------ | :------ | :------ | | `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | | -| `type` | `Model` \| `ModelProperty` \| `Operation` | | +| `type` | \| `Model` \| `ModelProperty` \| `Enum` \| `EnumMember` \| `Operation` | | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getPropertyNames.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getPropertyNames.md index ae70d7b0bd..e5cadca760 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getPropertyNames.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getPropertyNames.md @@ -7,11 +7,7 @@ title: "[F] getPropertyNames" getPropertyNames(context, property): [string, string] ``` -Get the library and wire name of a model property. Takes projections into account - -Gets library name from getLibraryName. Returns wire name in the following order of priority: -1. projected wire name i.e. @projectedName("json", "jsonSpecificName") => jsonSpecificName -2. name in typespec +Get the library and wire name of a model property. Takes ## Parameters @@ -25,3 +21,11 @@ Gets library name from getLibraryName. Returns wire name in the following order [`string`, `string`] a tuple of the library and wire name for a model property + +## Client Name + +and + +## Encoded Name + +into account diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getWireName.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getWireName.md index eafacad8be..d5cbf9e231 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getWireName.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getWireName.md @@ -9,10 +9,20 @@ getWireName(context, type): string ## Parameters -| Parameter | Type | -| :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | -| `type` | `Object` | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | - | +| `type` | `Object` | - | +| `type.instantiationParameters`? | `Type`[] | - | +| `type.isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | +| `type.kind` | \| `"String"` \| `"Number"` \| `"Boolean"` \| `"Model"` \| `"ModelProperty"` \| `"Scalar"` \| `"Interface"` \| `"Enum"` \| `"EnumMember"` \| `"TemplateParameter"` \| `"Namespace"` \| `"Operation"` \| `"StringTemplate"` \| `"StringTemplateSpan"` \| `"Tuple"` \| `"Union"` \| `"UnionVariant"` \| `"Intrinsic"` \| `"Function"` \| `"Decorator"` \| `"FunctionParameter"` \| `"Object"` \| `"Projection"` | - | +| `type.name` | `string` | - | +| `type.node`? | \| `TypeSpecScriptNode` \| `JsSourceFileNode` \| `JsNamespaceDeclarationNode` \| `TemplateArgumentNode` \| `TemplateParameterDeclarationNode` \| `ProjectionParameterDeclarationNode` \| `ProjectionLambdaParameterDeclarationNode` \| `ModelPropertyNode` \| `UnionVariantNode` \| `OperationStatementNode` \| `OperationSignatureDeclarationNode` \| `OperationSignatureReferenceNode` \| `EnumMemberNode` \| `EnumSpreadMemberNode` \| `ModelSpreadPropertyNode` \| `DecoratorExpressionNode` \| `DirectiveExpressionNode` \| `ImportStatementNode` \| `ModelStatementNode` \| `ScalarStatementNode` \| `NamespaceStatementNode` \| `InterfaceStatementNode` \| `UnionStatementNode` \| `UsingStatementNode` \| `EnumStatementNode` \| `AliasStatementNode` \| `DecoratorDeclarationStatementNode` \| `FunctionDeclarationStatementNode` \| `AugmentDecoratorStatementNode` \| `EmptyStatementNode` \| `InvalidStatementNode` \| `ProjectionStatementNode` \| `ArrayExpressionNode` \| `MemberExpressionNode` \| `ModelExpressionNode` \| `TupleExpressionNode` \| `UnionExpressionNode` \| `IntersectionExpressionNode` \| `TypeReferenceNode` \| `ValueOfExpressionNode` \| `StringLiteralNode` \| `NumericLiteralNode` \| `BooleanLiteralNode` \| `StringTemplateExpressionNode` \| `VoidKeywordNode` \| `NeverKeywordNode` \| `AnyKeywordNode` \| `FunctionParameterNode` \| `StringTemplateSpanNode` \| `StringTemplateHeadNode` \| `StringTemplateMiddleNode` \| `StringTemplateTailNode` \| `ExternKeywordNode` \| `DocNode` \| `DocTextNode` \| `DocReturnsTagNode` \| `DocErrorsTagNode` \| `DocParamTagNode` \| `DocTemplateTagNode` \| `DocUnknownTagNode` \| `ProjectionExpressionStatementNode` \| `ProjectionLogicalExpressionNode` \| `ProjectionRelationalExpressionNode` \| `ProjectionEqualityExpressionNode` \| `ProjectionUnaryExpressionNode` \| `ProjectionArithmeticExpressionNode` \| `ProjectionCallExpressionNode` \| `ProjectionMemberExpressionNode` \| `ProjectionDecoratorReferenceExpressionNode` \| `ProjectionTupleExpressionNode` \| `ProjectionModelExpressionNode` \| `ProjectionIfExpressionNode` \| `ProjectionBlockExpressionNode` \| `ProjectionLambdaExpressionNode` \| `IdentifierNode` \| `ReturnExpressionNode` \| `ProjectionModelSelectorNode` \| `ProjectionModelPropertySelectorNode` \| `ProjectionInterfaceSelectorNode` \| `ProjectionOperationSelectorNode` \| `ProjectionEnumSelectorNode` \| `ProjectionEnumMemberSelectorNode` \| `ProjectionUnionSelectorNode` \| `ProjectionUnionVariantSelectorNode` \| `ProjectionModelPropertyNode` \| `ProjectionModelSpreadPropertyNode` \| `ProjectionNode` | - | +| `type.projectionBase`? | `Type` | - | +| `type.projectionSource`? | `Type` | - | +| `type.projector`? | `Projector` | - | +| `type.projections` | - | +| `type.projectionsByName` | - | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInOperationGroup.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInOperationGroup.md index 8e0e1670a2..736a2591b4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInOperationGroup.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInOperationGroup.md @@ -7,7 +7,7 @@ title: "[F] isInOperationGroup" isInOperationGroup(context, type): boolean ``` -Check a namespace or interface is an operation group. +Check an operation is in an operation group. ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listClients.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listClients.md index 7287fc691a..76d2c877be 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listClients.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listClients.md @@ -7,12 +7,16 @@ title: "[F] listClients" listClients(context): SdkClient[] ``` +List all the clients. + ## Parameters -| Parameter | Type | -| :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | SdkContext | ## Returns [`SdkClient`](../interfaces/SdkClient.md)[] + +Array of clients diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationGroups.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationGroups.md index d0926905c9..dbd2d588fb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationGroups.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationGroups.md @@ -4,17 +4,21 @@ title: "[F] listOperationGroups" --- ```ts -listOperationGroups(context, client): SdkOperationGroup[] +listOperationGroups( + context, + group, + ignoreHierarchy): SdkOperationGroup[] ``` -List all the operation groups inside a client. +List all the operation groups inside a client or an operation group. If ignoreHierarchy is true, the result will include all nested operation groups. ## Parameters -| Parameter | Type | -| :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | -| `client` | [`SdkClient`](../interfaces/SdkClient.md) | +| Parameter | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | `undefined` | SdkContext | +| `group` | [`SdkClient`](../interfaces/SdkClient.md) \| [`SdkOperationGroup`](../interfaces/SdkOperationGroup.md) | `undefined` | Client or operation group to list operation groups | +| `ignoreHierarchy` | `boolean` | `false` | Whether to get all nested operation groups | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationsInOperationGroup.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationsInOperationGroup.md index bc1bc8d0ae..15d5ac6b22 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationsInOperationGroup.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationsInOperationGroup.md @@ -4,17 +4,21 @@ title: "[F] listOperationsInOperationGroup" --- ```ts -listOperationsInOperationGroup(context, group): Operation[] +listOperationsInOperationGroup( + context, + group, + ignoreHierarchy): Operation[] ``` -List operation in the given operation group. Pass a client to list the operation at the root of the client. +List operations inside a client or an operation group. If ignoreHierarchy is true, the result will include all nested operations. ## Parameters -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | - | -| `group` | [`SdkClient`](../interfaces/SdkClient.md) \| [`SdkOperationGroup`](../interfaces/SdkOperationGroup.md) | | +| Parameter | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | `undefined` | - | +| `group` | [`SdkClient`](../interfaces/SdkClient.md) \| [`SdkOperationGroup`](../interfaces/SdkOperationGroup.md) | `undefined` | Client or operation group to list operations | +| `ignoreHierarchy` | `boolean` | `false` | Whether to get all nested operations | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/reportDiagnostic.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/reportDiagnostic.md index 6c566bc94e..7954d97554 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/reportDiagnostic.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/reportDiagnostic.md @@ -23,7 +23,8 @@ reportDiagnostic(program, diag): void \| `"invalid-usage"` \| `"invalid-encode"` \| `"discriminator-not-constant"` - \| `"discriminator-not-string"` | + \| `"discriminator-not-string"` + \| `"wrong-client-decorator"` | | `M` extends `string` \| `number` \| `symbol` | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldFlattenProperty.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldFlattenProperty.md new file mode 100644 index 0000000000..0de64766ab --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldFlattenProperty.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] shouldFlattenProperty" + +--- +```ts +shouldFlattenProperty(context, target): boolean +``` + +Whether a model property should be flattened or not. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | SdkContext | +| `target` | `ModelProperty` | ModelProperty that we want to check whether it should be flattened or not | + +## Returns + +`boolean` + +whether the model property should be flattened or not 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 716158169c..c1db63fefa 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 @@ -3,9 +3,7 @@ jsApi: true title: "[P] JS Api" --- -## Exports - -### Interfaces +## Interfaces - [SdkArrayType](interfaces/SdkArrayType.md) - [SdkBodyModelPropertyType](interfaces/SdkBodyModelPropertyType.md) @@ -25,10 +23,11 @@ title: "[P] JS Api" - [SdkTupleType](interfaces/SdkTupleType.md) - [SdkUnionType](interfaces/SdkUnionType.md) -### Type Aliases +## Type Aliases - [AccessFlags](type-aliases/AccessFlags.md) - [ClientFormat](type-aliases/ClientFormat.md) +- [LanguageScopes](type-aliases/LanguageScopes.md) - [SdkBuiltInKinds](type-aliases/SdkBuiltInKinds.md) - [SdkModelPropertyType](type-aliases/SdkModelPropertyType.md) - [SdkOperation](type-aliases/SdkOperation.md) @@ -37,18 +36,20 @@ title: "[P] JS Api" - [SdkType](type-aliases/SdkType.md) - [SdkValidation](type-aliases/SdkValidation.md) -### Variables +## Variables - [$lib](variables/$lib.md) - [namespace](variables/namespace.md) -### Functions +## Functions - [$access](functions/$access.md) - [$client](functions/$client.md) - [$clientFormat](functions/$clientFormat.md) +- [$clientName](functions/$clientName.md) - [$convenientAPI](functions/$convenientAPI.md) - [$exclude](functions/$exclude.md) +- [$flattenProperty](functions/$flattenProperty.md) - [$include](functions/$include.md) - [$internal](functions/$internal.md) - [$operationGroup](functions/$operationGroup.md) @@ -63,6 +64,7 @@ title: "[P] JS Api" - [getAllModels](functions/getAllModels.md) - [getClient](functions/getClient.md) - [getClientFormat](functions/getClientFormat.md) +- [getClientNameOverride](functions/getClientNameOverride.md) - [getClientNamespaceString](functions/getClientNamespaceString.md) - [getClientType](functions/getClientType.md) - [getCrossLanguageDefinitionId](functions/getCrossLanguageDefinitionId.md) @@ -103,5 +105,6 @@ title: "[P] JS Api" - [listOperationsInOperationGroup](functions/listOperationsInOperationGroup.md) - [reportDiagnostic](functions/reportDiagnostic.md) - [reportUnionUnsupported](functions/reportUnionUnsupported.md) +- [shouldFlattenProperty](functions/shouldFlattenProperty.md) - [shouldGenerateConvenient](functions/shouldGenerateConvenient.md) - [shouldGenerateProtocol](functions/shouldGenerateProtocol.md) 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 aab0a994a7..c12aefb54d 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 @@ -11,8 +11,8 @@ title: "[I] SdkArrayType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `__raw`? | `Type` | - | SdkTypeBase.\_\_raw | -| `deprecation`? | `string` | - | SdkTypeBase.deprecation | -| `kind` | `"array"` | - | SdkTypeBase.kind | -| `nullable` | `boolean` | - | SdkTypeBase.nullable | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `kind` | `"array"` | - | `SdkTypeBase.kind` | +| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | | `valueType` | [`SdkType`](../type-aliases/SdkType.md) | - | - | 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 87a0cee4d8..09876de3d7 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 @@ -11,14 +11,14 @@ title: "[I] SdkBodyModelPropertyType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `__raw`? | `ModelProperty` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | -| `apiVersions` | `string`[] | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | -| `description`? | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`description` | -| `details`? | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`details` | +| `__raw?` | `ModelProperty` | - | [`SdkModelPropertyTypeBase.__raw`](SdkModelPropertyTypeBase.md) | +| `apiVersions` | `string`[] | - | [`SdkModelPropertyTypeBase.apiVersions`](SdkModelPropertyTypeBase.md) | +| `description?` | `string` | - | [`SdkModelPropertyTypeBase.description`](SdkModelPropertyTypeBase.md) | +| `details?` | `string` | - | [`SdkModelPropertyTypeBase.details`](SdkModelPropertyTypeBase.md) | | `discriminator` | `boolean` | - | - | | `kind` | `"property"` | - | - | -| `nameInClient` | `string` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`nameInClient` | -| `optional` | `boolean` | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | +| `nameInClient` | `string` | - | [`SdkModelPropertyTypeBase.nameInClient`](SdkModelPropertyTypeBase.md) | +| `optional` | `boolean` | - | [`SdkModelPropertyTypeBase.optional`](SdkModelPropertyTypeBase.md) | | `serializedName` | `string` | - | - | -| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | -| `visibility`? | `Visibility`[] | - | - | +| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | [`SdkModelPropertyTypeBase.type`](SdkModelPropertyTypeBase.md) | +| `visibility?` | `Visibility`[] | - | - | 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 1bfd5ab082..fae14cfb2d 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 @@ -11,8 +11,8 @@ title: "[I] SdkBuiltInType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `__raw`? | `Type` | - | SdkTypeBase.\_\_raw | -| `deprecation`? | `string` | - | SdkTypeBase.deprecation | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | | `encode` | `string` | - | - | -| `kind` | [`SdkBuiltInKinds`](../type-aliases/SdkBuiltInKinds.md) | - | SdkTypeBase.kind | -| `nullable` | `boolean` | - | SdkTypeBase.nullable | +| `kind` | [`SdkBuiltInKinds`](../type-aliases/SdkBuiltInKinds.md) | - | `SdkTypeBase.kind` | +| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | 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 2bc93b8665..be7d96be7c 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 @@ -11,9 +11,9 @@ title: "[I] SdkConstantType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `__raw`? | `Type` | - | SdkTypeBase.\_\_raw | -| `deprecation`? | `string` | - | SdkTypeBase.deprecation | -| `kind` | `"constant"` | - | SdkTypeBase.kind | -| `nullable` | `boolean` | - | SdkTypeBase.nullable | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `kind` | `"constant"` | - | `SdkTypeBase.kind` | +| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | | `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 523d4d097a..512c81f6b4 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 @@ -5,7 +5,7 @@ title: "[I] SdkContext" --- ## Type parameters -| Parameter | Default | +| Parameter | Value | | :------ | :------ | | `TOptions` extends `object` | `Record`<`string`, `any`\> | @@ -13,17 +13,14 @@ title: "[I] SdkContext" | Property | Type | Description | | :------ | :------ | :------ | -| `arm`? | `boolean` | - | -| `clientProjectedProgram`? | `ProjectedNameView` | - | +| `arm?` | `boolean` | - | | `emitContext` | `EmitContext`<`TOptions`\> | - | | `emitterName` | `string` | - | -| `filterOutCoreModels`? | `boolean` | - | +| `filterOutCoreModels?` | `boolean` | - | | `generateConvenienceMethods` | `boolean` | - | | `generateProtocolMethods` | `boolean` | - | -| `generatedNames`? | `Set`<`string`\> | - | -| `jsonProjectedProgram`? | `ProjectedNameView` | - | -| `languageProjectedProgram`? | `ProjectedNameView` | - | -| `modelsMap`? | `Map`<`Type`, [`SdkModelType`](SdkModelType.md) \| [`SdkEnumType`](SdkEnumType.md)\> | - | -| `operationModelsMap`? | `Map`<`Operation`, `Map`<`Type`, [`SdkModelType`](SdkModelType.md) \| [`SdkEnumType`](SdkEnumType.md)\>\> | - | -| `packageName`? | `string` | - | +| `generatedNames?` | `Set`<`string`\> | - | +| `modelsMap?` | `Map`<`Type`, [`SdkModelType`](SdkModelType.md) \| [`SdkEnumType`](SdkEnumType.md)\> | - | +| `operationModelsMap?` | `Map`<`Operation`, `Map`<`Type`, [`SdkModelType`](SdkModelType.md) \| [`SdkEnumType`](SdkEnumType.md)\>\> | - | +| `packageName?` | `string` | - | | `program` | `Program` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDatetimeType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDatetimeType.md index 87f734b4a3..c4ceba012d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDatetimeType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDatetimeType.md @@ -11,9 +11,9 @@ title: "[I] SdkDatetimeType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `__raw`? | `Type` | - | SdkTypeBase.\_\_raw | -| `deprecation`? | `string` | - | SdkTypeBase.deprecation | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | | `encode` | `DateTimeKnownEncoding` | - | - | -| `kind` | `"datetime"` | - | SdkTypeBase.kind | -| `nullable` | `boolean` | - | SdkTypeBase.nullable | +| `kind` | `"datetime"` | - | `SdkTypeBase.kind` | +| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | | `wireType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | 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 6786ed2683..33b834fb0d 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 @@ -11,9 +11,9 @@ title: "[I] SdkDictionaryType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `__raw`? | `Type` | - | SdkTypeBase.\_\_raw | -| `deprecation`? | `string` | - | SdkTypeBase.deprecation | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | | `keyType` | [`SdkType`](../type-aliases/SdkType.md) | - | - | -| `kind` | `"dict"` | - | SdkTypeBase.kind | -| `nullable` | `boolean` | - | SdkTypeBase.nullable | +| `kind` | `"dict"` | - | `SdkTypeBase.kind` | +| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | | `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 d3330b459c..5db2371dda 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 @@ -11,9 +11,9 @@ title: "[I] SdkDurationType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `__raw`? | `Type` | - | SdkTypeBase.\_\_raw | -| `deprecation`? | `string` | - | SdkTypeBase.deprecation | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | | `encode` | `DurationKnownEncoding` | - | - | -| `kind` | `"duration"` | - | SdkTypeBase.kind | -| `nullable` | `boolean` | - | SdkTypeBase.nullable | +| `kind` | `"duration"` | - | `SdkTypeBase.kind` | +| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | | `wireType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEmitterOptions.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEmitterOptions.md index 4064df041d..52f4e95580 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEmitterOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEmitterOptions.md @@ -7,7 +7,7 @@ title: "[I] SdkEmitterOptions" | Property | Type | Description | | :------ | :------ | :------ | -| `filter-out-core-models`? | `boolean` | - | -| `generate-convenience-methods`? | `boolean` | - | -| `generate-protocol-methods`? | `boolean` | - | -| `package-name`? | `string` | - | +| `filter-out-core-models?` | `boolean` | - | +| `generate-convenience-methods?` | `boolean` | - | +| `generate-protocol-methods?` | `boolean` | - | +| `package-name?` | `string` | - | 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 d55cba448e..7e0d7faaba 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 @@ -11,17 +11,17 @@ title: "[I] SdkEnumType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `__raw`? | `Type` | - | SdkTypeBase.\_\_raw | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | | `access` | `undefined` \| [`AccessFlags`](../type-aliases/AccessFlags.md) | - | - | | `crossLanguageDefinitionId` | `string` | - | - | -| `deprecation`? | `string` | - | SdkTypeBase.deprecation | -| `description`? | `string` | - | - | -| `details`? | `string` | - | - | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `description?` | `string` | - | - | +| `details?` | `string` | - | - | | `isFixed` | `boolean` | - | - | | `isFlags` | `boolean` | - | - | -| `kind` | `"enum"` | - | SdkTypeBase.kind | +| `kind` | `"enum"` | - | `SdkTypeBase.kind` | | `name` | `string` | - | - | -| `nullable` | `boolean` | - | SdkTypeBase.nullable | +| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | | `usage` | `UsageFlags` | - | - | | `valueType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | | `values` | [`SdkEnumValueType`](SdkEnumValueType.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 bd59d8e2b4..9260c09bc1 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 @@ -11,13 +11,13 @@ title: "[I] SdkEnumValueType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `__raw`? | `Type` | - | SdkTypeBase.\_\_raw | -| `deprecation`? | `string` | - | SdkTypeBase.deprecation | -| `description`? | `string` | - | - | -| `details`? | `string` | - | - | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `description?` | `string` | - | - | +| `details?` | `string` | - | - | | `enumType` | [`SdkEnumType`](SdkEnumType.md) | - | - | -| `kind` | `"enumvalue"` | - | SdkTypeBase.kind | +| `kind` | `"enumvalue"` | - | `SdkTypeBase.kind` | | `name` | `string` | - | - | -| `nullable` | `boolean` | - | SdkTypeBase.nullable | +| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | | `value` | `string` \| `number` | - | - | | `valueType` | [`SdkType`](../type-aliases/SdkType.md) | - | - | 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 d4f56b19b7..557becf6e3 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 @@ -11,10 +11,10 @@ title: "[I] SdkModelPropertyTypeBase" | Property | Type | Description | | :------ | :------ | :------ | -| `__raw`? | `ModelProperty` | - | +| `__raw?` | `ModelProperty` | - | | `apiVersions` | `string`[] | - | -| `description`? | `string` | - | -| `details`? | `string` | - | +| `description?` | `string` | - | +| `details?` | `string` | - | | `nameInClient` | `string` | - | | `optional` | `boolean` | - | | `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 325075092f..c4198589bc 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 @@ -11,19 +11,19 @@ title: "[I] SdkModelType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `__raw`? | `Type` | - | SdkTypeBase.\_\_raw | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | | `access` | `undefined` \| [`AccessFlags`](../type-aliases/AccessFlags.md) | - | - | -| `additionalProperties` | `boolean` | - | - | -| `baseModel`? | [`SdkModelType`](SdkModelType.md) | - | - | +| `additionalProperties` | `undefined` \| [`SdkType`](../type-aliases/SdkType.md) | - | - | +| `baseModel?` | [`SdkModelType`](SdkModelType.md) | - | - | | `crossLanguageDefinitionId` | `string` | - | - | -| `deprecation`? | `string` | - | SdkTypeBase.deprecation | -| `description`? | `string` | - | - | -| `details`? | `string` | - | - | -| `discriminatedSubtypes`? | `Record`<`string`, [`SdkModelType`](SdkModelType.md)\> | - | - | -| `discriminatorValue`? | `string` | - | - | -| `generatedName`? | `string` | - | - | -| `kind` | `"model"` | - | SdkTypeBase.kind | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `description?` | `string` | - | - | +| `details?` | `string` | - | - | +| `discriminatedSubtypes?` | `Record`<`string`, [`SdkModelType`](SdkModelType.md)\> | - | - | +| `discriminatorValue?` | `string` | - | - | +| `generatedName?` | `string` | - | - | +| `kind` | `"model"` | - | `SdkTypeBase.kind` | | `name` | `string` | - | - | -| `nullable` | `boolean` | - | SdkTypeBase.nullable | +| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | | `properties` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md)[] | - | - | | `usage` | `UsageFlags` | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkOperationGroup.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkOperationGroup.md index cb5564552a..f07c95ec2c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkOperationGroup.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkOperationGroup.md @@ -7,5 +7,7 @@ title: "[I] SdkOperationGroup" | Property | Type | Description | | :------ | :------ | :------ | +| `groupPath` | `string` | - | | `kind` | `"SdkOperationGroup"` | - | +| `subOperationGroups?` | [`SdkOperationGroup`](SdkOperationGroup.md)[] | - | | `type` | `Interface` \| `Namespace` | - | 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 e2b552d048..2530b58fb6 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 @@ -11,8 +11,8 @@ title: "[I] SdkTupleType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `__raw`? | `Type` | - | SdkTypeBase.\_\_raw | -| `deprecation`? | `string` | - | SdkTypeBase.deprecation | -| `kind` | `"tuple"` | - | SdkTypeBase.kind | -| `nullable` | `boolean` | - | SdkTypeBase.nullable | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `kind` | `"tuple"` | - | `SdkTypeBase.kind` | +| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | | `values` | [`SdkType`](../type-aliases/SdkType.md)[] | - | - | 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 60703fe079..9925905134 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 @@ -11,10 +11,10 @@ title: "[I] SdkUnionType" | Property | Type | Description | Inheritance | | :------ | :------ | :------ | :------ | -| `__raw`? | `Type` | - | SdkTypeBase.\_\_raw | -| `deprecation`? | `string` | - | SdkTypeBase.deprecation | -| `generatedName`? | `string` | - | - | -| `kind` | `"union"` | - | SdkTypeBase.kind | -| `name`? | `string` | - | - | -| `nullable` | `boolean` | - | SdkTypeBase.nullable | +| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `generatedName?` | `string` | - | - | +| `kind` | `"union"` | - | `SdkTypeBase.kind` | +| `name?` | `string` | - | - | +| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | | `values` | [`SdkType`](../type-aliases/SdkType.md)[] | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/LanguageScopes.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/LanguageScopes.md new file mode 100644 index 0000000000..7b011c18d4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/LanguageScopes.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[T] LanguageScopes" + +--- +```ts +type LanguageScopes: + | "dotnet" + | "java" + | "python" + | "javascript" + | "go" + | string; +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/variables/$lib.md index 3da9627f33..60e27408e4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/variables/$lib.md @@ -4,5 +4,38 @@ title: "[V] $lib" --- ```ts -const $lib: TypeSpecLibrary>; +const $lib: TypeSpecLibrary, never>; ``` + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `access` | `Object` | - | +| `access.default` | `string` | - | +| `client-name` | `Object` | - | +| `client-name.default` | `CallableMessage`<[`string`]\> | - | +| `client-service` | `Object` | - | +| `client-service.default` | `CallableMessage`<[`string`]\> | - | +| `discriminator-not-constant` | `Object` | - | +| `discriminator-not-constant.default` | `CallableMessage`<[`string`]\> | - | +| `discriminator-not-string` | `Object` | - | +| `discriminator-not-string.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `incorrect-client-format` | `Object` | - | +| `incorrect-client-format.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `invalid-encode` | `Object` | - | +| `invalid-encode.default` | `string` | - | +| `invalid-encode.wrongType` | `CallableMessage`<[`string`, `string`]\> | - | +| `invalid-usage` | `Object` | - | +| `invalid-usage.default` | `string` | - | +| `union-null` | `Object` | - | +| `union-null.default` | `string` | - | +| `union-unsupported` | `Object` | - | +| `union-unsupported.default` | `string` | - | +| `union-unsupported.null` | `string` | - | +| `unknown-client-format` | `Object` | - | +| `unknown-client-format.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `use-enum-instead` | `Object` | - | +| `use-enum-instead.default` | `string` | - | +| `wrong-client-decorator` | `Object` | - | +| `wrong-client-decorator.default` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2022-07-08.md b/packages/website/versioned_docs/version-latest/release-notes/release-2022-07-08.md index 5977f07886..42138eb4b2 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2022-07-08.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2022-07-08.md @@ -21,127 +21,6 @@ This release brings a stricter option definition for emitters and requires usage All options have also been renamed to match `kebab-case` naming. The options can also be specified via the `tspconfig.yaml` file. -### Migrating Command Line Scripts - -If you had for example `--option operationPollingLocation=tenant` - -1. Use `tspconfig.yaml` project file **Recommended** - - If you don't have that file yet, create it next to `package.json`, this file can be used to configure the emitters. - - ```yaml - emitters: - @azure-tools/typespec-providerhub-controller: - : - - # For example - emitters: - @azure-tools/typespec-providerhub-controller: - operation-polling-location: tenant - ``` - -2. Via the `--option` flag - - You can still use the `--option` flag but you'll need to specify the fully qualified name of the option. - - ```bash - --option @azure-tools/typespec-providerhub-controller.= - - # For example - --option @azure-tools/typespec-providerhub-controller.operation-polling-location=tenant - ``` - -#### Renamed Emitter Options - -| Before | Now | -| ------------------------------------------------ | ---------------------------- | -| **@azure-tools/typespec-autorest** | -| `outputFile` | `output-file` | -| `examples-directory` | `examples-directory` | -| **@azure-tools/typespec-providerhub-controller** | -| `serviceCodePath` | `service-code-path` | -| `operationPollingLocation` | `operation-polling-location` | -| `controllerHost` | `controller-host` | -| `registrationOutputPath` | `registration-output-path` | - -### Migrating Projects - -To migrate the project, you will need to update package.json, then update the `.csproj` file to use the new emitter options. - -#### Updating `package.json` - -The TypeSpec project used the `~` option to protect your project from breaking changes when installing or updating dependencies via npm. To upgrade the project to use the new version of typespec, you must update the package.json file to use the new dependencies. Update the `dependencies` section of the package.json (in `typespec\package.json`) as follows: - -```json -"dependencies": { - "@typespec/compiler": "~0.33.0", - "@typespec/openapi": "~0.10.1", - "@typespec/rest": "~0.15.1", - "@azure-tools/typespec-autorest": "~0.18.0", - "@azure-tools/typespec-azure-core": "~0.5.0", - "@azure-tools/typespec-providerhub": "~0.19.0", - "@azure-tools/typespec-providerhub-controller": "~0.14.0", - "@azure-tools/typespec-azure-resource-manager": "~0.8.0" - } -``` - -Once this is done and package.json is saved, navigate to the typespec directory (`.\typespec\`) and install the new packages using npm. - -```bash -c:/my-project/typespec/> npm install -``` - -#### Updating emitter options in the `.csproj` file - -As described above, the emitter option names have changed, if you created a TypeSpec project using the typespec-providerhub template, the option names used by the TypeSpec project during compilation appear in the 'Options' property of the `` element, as a semicolon-separated string: - -```xml - -``` - -Each of the setting names need to be changed to include the emitter name and to switch from camelCase to kebab-case. The settings that may appear in your csproj file and the changes that are needed include: - -| Before | Now | -| -------------------------------- | ----------------------------------------------------------------------- | -| `azure-resource-provider-folder` | `@azure-tools/typespec-autorest.azure-resource-provider-folder` | -| `examples-directory` | `@azure-tools/typespec-autorest.examples-directory` | -| `registrationOutputPath` | `@azure-tools/typespec-providerhub-controller.registration-output-path` | -| **Optional Settings** | -| `outputFile` | `@azure-tools/typespec-autorest.output-file` | - -The above `` element would be rewritten as follows: - -```xml - -``` - -### Migrating a 'monorepo' project - -If you are not using the project template, but are simply using a local package.json to manage your typespec dependencies, you can upgrade the project to use the new version of typespec by updating the package.json file to use the new dependencies. Update the `dependencies` section of the package.json as follows: - -```json -"dependencies": { - "@typespec/compiler": "~0.33.0", - "@typespec/openapi": "~0.10.1", - "@typespec/rest": "~0.15.1", - "@azure-tools/typespec-autorest": "~0.18.0", - "@azure-tools/typespec-azure-core": "~0.5.0", - "@azure-tools/typespec-providerhub": "~0.19.0", - "@azure-tools/typespec-providerhub-controller": "~0.14.0", - "@azure-tools/typespec-azure-resource-manager": "~0.8.0" - } -``` - -Once this is complete and package.json is saved, navigate to the typespec directory and install the new packages using npm. - -```bash -c:/my-typespec-project/ npm install -``` - ## `@serviceHost` decorator replaced with `@server` decorator Note that **it is unlikely that this change has any impact on existing ARM specs**. The `@serviceHost` decorator that decorated the root namespace was used to specify the domain name of the base service endpoint. This functionality has been replaced by the `@server` decorator, which allows specifying full and parametrized Uris for the service endpoint, as described [here](https://github.com/microsoft/typespec/tree/main/docs/tutorial.md#service-definition-and-metadata) diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2022-10-12.md b/packages/website/versioned_docs/version-latest/release-notes/release-2022-10-12.md index c15fbcd8f4..c2ed13e954 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2022-10-12.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2022-10-12.md @@ -27,22 +27,3 @@ You now have to explicitly include this interface in your Arm spec. // Add this to your spec. interface Operations extends Azure.ResourceManager.Operations {} ``` - -## **`Emitter`** `typespec-provider-hub-controller` Deprecate `service-code-path` - -`service-code-path` option has been replaced by `output-dir` -Before - -```yaml -emitters: - "@azure-tools/typespec-providerhub-controller": - service-code-path: ./my-controllers -``` - -After - -```yaml -emitters: - "@azure-tools/typespec-providerhub-controller": - output-dir: ./my-controllers -``` diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2022-12-07.md b/packages/website/versioned_docs/version-latest/release-notes/release-2022-12-07.md index 31e6bcf767..d8052e3756 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2022-12-07.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2022-12-07.md @@ -18,30 +18,6 @@ See TypeSpec Core breaking changes in [release notes](https://microsoft.github.i All Azure emitters (DPG, Autorest) will migrate to treating raw TypeSpec enums as extensible, without using the `@knownValues` decorator. Azure emitters that want to suppress this behavior and model raw enums as closed must use the new `@fixed` decorator. -### `@azure-tools/typespec-providerhub-controller` - Change to output-dir logic in compiler changed some logic in `typespec-providerhub-controller` - -The `typespec-providerhub-controller` was automatically putting generated artifact in "{output-dir}/generated" now it will be `{output-dir}/@azure-tools/typespec-providerhub-controller` by default. To revert to the previous behavior add this to your `tspconfig.yaml` - -``` -"@azure-tools/typespec-providerhub-controller": - emitter-output-dir: "{output-dir}/generated" -``` - -For the `typespec-providerhub-template` project you can update the `tspconfig.yaml` config file to be: - -```yaml -output-dir: "{project-root}/../" -emitters: - "@azure-tools/typespec-autorest": - emitter-output-dir: "{output-dir}" - azure-resource-provider-folder: ./swagger/Contoso/resource-manager - examples-directory: ./examples - new-line: lf - "@azure-tools/typespec-providerhub-controller": - emitter-output-dir: "{output-dir}/generated" - code-kind: model -``` - ### `typespec-azure-core` becomes more strict on camelCase/PascalCase check - PascalCase must be applied to model/interface/namespace name diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-02-07.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-02-07.md index 2975f35bff..703ac950be 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-02-07.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-02-07.md @@ -28,14 +28,6 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n - Use `DPGContext` instead of `Program` - Add usage and reference documentation to the website -### Microsoft.TypeSpec.Providerhub.Controller - -- Add new serialization types to correctly serialize enumerations - -### typespec-providerhub-controller - -- Fix serialization issue with optional value types - ## Breaking Changes ### typespec-autorest breaking changes @@ -65,11 +57,6 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n - Removed `@convenienceAPI` decorator. Use `@convenientAPI` and `@protocolAPI` instead. - Removed `getConvenienceAPIName` function. Use `shouldGenerateProtocol` and `shouldGenerateConvenient` functions instead. -### TypeSpec-Providerhub-Controller breaking changes - -- Removed `service-code-path` emitter option. Use `emitter-output-dir` instead. -- Now generates nullable valuable types for optional value type parameters - ## Deprecations ### typespec-azure-resource-manager deprecations diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-03-13.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-03-13.md index ef760dc709..5f55ec9a75 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-03-13.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-03-13.md @@ -29,15 +29,6 @@ See [Cadl to TypeSpec rename and migration FAQ](./cadl-typespec-migration.md) - Export embedded models in Array/List/Model for `getAllModels`. - fix getAllModels when there are no models -### Microsoft.TypeSpec.Providerhub.Controller - -- Fix serialization issues and add support for paging - -### typespec-providerhub-controller - -- Add new known types and fix produces types for actions and accepted responses -- Add support for empty and asynchronous produces types for actions in the controller - ## Breaking Changes ### Package Renaming (Cadl -> TypeSpec) @@ -51,8 +42,6 @@ Packages now use `typespec` instead of `cadl` in package names. | @azure-tools/cadl-azure-resource-manager | @azure-tools/typespec-azure-resource-manager | | @azure-tools/cadl-DPG | @azure-tools/typespec-client-generator-core | | @azure-tools/cadl-diff | @azure-tools/typespec-diff | -| @azure-tools/cadl-providerhub | @azure-tools/typespec-providerhub | -| @azure-tools/cadl-providerhub-controller | @azure-tools/typespec-providerhub-controller | The `migrate` package can be used to migrate specs to using the new package imports and namespaces. For more information about migrating to new TypeSpec packages, see the [note on Cadl to TypeScript Migration](https://azure.github.io/typespec-azure/docs/next/release-notes/cadl-typespec-migration). diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-04-11.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-04-11.md index 31fc8ac3ef..1bd3bbc619 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-04-11.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-04-11.md @@ -41,10 +41,6 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n - Fix intrinsic type checking in getSdkSimpleType -### @azure-tools/typespec-providerhub-controller - -- Fix issues with generating patch operations for tags and custom update templates - ## Breaking Changes ### @azure-tools/typespec-autorest: Config interpolation diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-05-10.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-05-10.md index b4f19f66bb..53b9ddd2a7 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-05-10.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-05-10.md @@ -47,12 +47,6 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n - refine types in union and enum - remove support for zonedDateTime -### @azure-tools/typespec-providerhub-controller features - -- Add support for `@encode` decorator - -## Bug Fixes - ### @azure-tools/typespec-azure-core bug fixes - Fix issue with LongRunningResourceCreateWithServiceProvidedName. @@ -63,7 +57,3 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n - Fix issue where a decorator renames operations in a way that is contrary to guidelines. - Fix issue with overriding interface lifecycle operations - -### Microsoft.TypeSpec.ProviderHub.Controller nuget package fixes - -- Fix over-premissive serialization for enums diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-07-11.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-07-11.md index a9af047bcc..dd4ed1d05a 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-07-11.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-07-11.md @@ -28,16 +28,6 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n - Add operation templates to support new Asynchronous delete API guidelines `ArmResourceDeleteWithoutOkAsync` - Add operation templates to support new Asynchronous action operations with no return value `ArmResourceActionNoResponseContentAsync` -### `@azure-tools/typespec-providerhub-controller` emitter - -- Support non-specific scalar types like `numeric`, `integer` and `float`. Emit a warning when these types are used and emit the best c-sharp approximation for the type. - -### `Microsoft.Providerhub.Controller.Common` library - -- Add types to model valid and invalid `ValidationResponse` types used in `Validate` extension methods - -## Bug Fixes - ### `@azure-tools/typespec-azure-core` bug fixes - Correct `GetLroMetadata` response for operations not tied to a resource (e.g. RPC operations) @@ -51,16 +41,6 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n - fix for decorator about `scalar extends string/numeric` -### `@azure-tools/typespec-providerhub-controller` emitter bug fixes - -- Emit generated versioning classes with models rather than with controllers, fixing issues with solutions with separate controller and model projects -- Fix serialization issue with core `ResourceBase` type -- Fix issues with getting started documentation in dotnet 7.0 - -### `Microsoft.Providerhub.Controller.Common` library bug fixes - -- Fix serialization of SerializationInfo property for resource models - ## New Linting Rules (`@azure-tools/typespec-azure-core`) - Use standard names for operations diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-08-08.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-08-08.md index a309833896..a21e5fc415 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-08-08.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-08-08.md @@ -33,14 +33,6 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n - Add new template `ArmResourceCreateOrReplaceSync` that returns `OK` and `Accepted` responses for synchronous PUT requests. - Add template alias `ArmResourceCreateOrReplaceAsync` for consistent naming of recommended templates for `PUT` operations. -### `@azure-tools/typespec-providerhub-controller` New Features - -- Support shared libraries of ARM types and operations -- Support new ARM template response types -- Add interpolation support of `emitter-output-dir` for the `registration-output-path` emitter option. - -## Bug Fixes - ### `@azure-tools/typespec-autorest` Bug Fixes - Fix: Apply `@minItems` and `@maxItems` decorators on model arrays. diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-10-11.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-10-11.md index 1161a51976..603baf4e1c 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-10-11.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-10-11.md @@ -31,12 +31,6 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n - Add known values - Change discriminator type in base model -### `@azure-tools/typespec-providerhub-controller` New Features - -- Add ResourceProvider Namespace constant to generated service routes. - -## Bug Fixes - ### `@azure-tools/typespec-autorest` Bug Fixes - Fix: A diagnostic will now be emitted for any HTTP authentication scheme not supported by OpenAPI 2. @@ -55,15 +49,6 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n - Fix: Remove dependency on `Language==C#`. -### `@azure-tools/typespec-providerhub-controller` Bug Fixes - -- Fix: Eliminate trailing space in generated enums. -- Fix: Use fully-qualified type reference for generated enum defaults. - -### `@azure-tools/typespec-providerhub-controller-common` Bug Fixes - -- Fix: Correct handling of hidden properties in `VersionedSerializer`. - ## Breaking Changes - There are breaking changes in the TypeSpec core libraries, see [the release notes](https://microsoft.github.io/typespec/release-notes/release-2023-10-11) for details. diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2024-01-23.md b/packages/website/versioned_docs/version-latest/release-notes/release-2024-01-23.md new file mode 100644 index 0000000000..603f45b895 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2024-01-23.md @@ -0,0 +1,59 @@ +--- +title: January 2024 +--- + +# Release Notes January 2024 (2024-01-23) + +:::danger +This release contains **breaking changes** +::: + +See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2024-01-23) + +## New Features + +### `@azure-tools/typespec-autorest` New Features + +- Added support for `@encodedName` decorator. + +### `@azure-tools/typespec-azure-core` New Features + +- Added support in `getLroMetadata` for Azure Resource Manager LRO patterns. +- Added parameter options and supporting templates for `@pollingLocation` and `@finalLocation` decorators to enable specifying or overriding the expected response type when resolving the url in a decorated property. + +### `@azure-tools/typespec-azure-resource-manager` New Features + +- Added new types to support LRO resolution by `Location` and `Azure-AsyncOperation` headers. +- Added new template parameter `LroHeaders` to customize the LRO settings for all asynchronous operation templates. + +### `@azure-tools/typespec-client-generator-core` New Features + +- Added type info for additional properties in model type. +- Added `@clientName` decorator. +- Added support for `@encodedName` decorator. +- Added new `@flattenProperty` decorator. + +## Bug Fixes + +### `@azure-tools/typespec-autorest` Bug Fixes + +- Fix: Changed default treatment of `multipart/form-data` property of type `bytes[]`: it is now treated as multiple file parts. +- Fix: Carried over the union name to `x-ms-enum.name` for OpenAPI enums created from named unions. + +### `@azure-tools/typespec-azure-core` Bug Fixes + +- Fix: Relaxed camelCase linting rule to allow a single non-alphabetical character. Also added standard filterParameter. +- Fix: Gave a name to the `RepeatabilityResult` union used in APIs that support Repeatable Requests. + +### `@azure-tools/typespec-azure-resource-manager` Bug Fixes + +- Fix: Resolved selected Azure Resource Manager common types version when used on version enum members. + +### `@azure-tools/typespec-client-generator-core` Bug Fixes + +- Fix: Replaced missing models in client hierarchy +- Fix: Corrected naming issue for enums with projected names. + +## Breaking Changes + +- There are breaking changes in the TypeSpec core libraries, see [the release notes](https://microsoft.github.io/typespec/release-notes/release-2024-01-23) for details. diff --git a/packages/website/versioned_docs/version-latest/typespec-getting-started.md b/packages/website/versioned_docs/version-latest/typespec-getting-started.md index edab6690dc..e8b9201249 100644 --- a/packages/website/versioned_docs/version-latest/typespec-getting-started.md +++ b/packages/website/versioned_docs/version-latest/typespec-getting-started.md @@ -37,18 +37,6 @@ Use the resources in this section for creating Azure ARM rest API specs. For Pro - Documentation - [TypeSpec Azure ARM library](https://github.com/Azure/typespec-azure/tree/main/packages/typespec-azure-resource-manager/README.md) -## Getting Started for Azure Management Plane ProviderHub UserRP service codegen - -If you intend to using TypeSpec to not only generate Azure ARM rest API specs but also leverage TypeSpec ProviderHub template package to help creating service implementation of ProviderHub user RP project, please see -[step by step guide](https://github.com/Azure/typespec-azure/blob/main/packages/typespec-providerhub-templates/README.md). - -- Documentation - - [ProviderHub Project Templates](https://github.com/Azure/typespec-azure/blob/main/packages/typespec-providerhub-templates/README.md) - - [Checking in TypeSpec Generated Swagger](https://github.com/Azure/typespec-azure/blob/main/docs/checking-in-api-specs-guide.md) -- Video Walkthroughs - - [Getting Started with TypeSpec for ProviderHub](https://microsoft.sharepoint.com/:v:/t/AzureDeveloperExperience/EYTV39X351FAlHb8tIPHdCgB1zgVDUGfcCE2mOoQAlVAcw?e=0D1IIW) - - [Service Code Generation](https://microsoft.sharepoint.com/:v:/t/AzureDeveloperExperience/EUqfqSySRipChjKAciFLHfMBXHnjti49ZTrLKvHW0UWL-Q?e=EDtBNk) - ## Getting Started for Azure Data Plane Services - Documentation