Api center (#27617)

* Removing deuplicate definition * Fix example formatting and some operation signatures * Add API version 2023-10-01-preview [Import] (#27385) * Base version 2023-06-06 * 2023-10-01-preview version changes * 2023-10-01-preview version changes - generate max set examples * Change provisioning state because of cross-version breaking change * Fix prettier checks * Generate max set examples * Fix prettier checks * Add min set examples * Regenerate examples * Update readme * remove min set examples and change provisioning state * revert provisioning state change * Update readme for SDK generation * Mjmadhu playwrighttesting microsoft.azure playwright service 2023 10 01 preview new (#27132) * First commit with existing version files in new version folder * Added new ARM stable api-version for GA * Readme changes * Addressed review comments * Changed data type to float as discussed in the comments * Added suppression rules for SwaggerLintDiff as per review comment * Added suppression rules for SwaggerLintDiff as per review comment * Fix for suppressions not working * Modified suppression syntax to the new one as per TSG. * Added paths in suppressions * Rectifying path for ResourceNameRestriction Suppression * Paths not working correctly with ResourceNameRestriction suppression * HDInsight: onboard new apiversion 2023-11-01-preview (#27306) * onboard new apiversion 2023-11-01-preview * Adds base for updating Microsoft.HDInsight/HDInsightOnAks from version preview/2023-06-01-preview to version 2023-11-01-preview * Updates readme * Updates API version in new specs and examples * move changes from rpaasmaster branch * fix comment * fix comment * fix comment * fix comment * fix comment * fix comment * fix comment * fix comment * fix comment * Update specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/hdinsight.json Co-authored-by: Cunfeng <[email protected]> * update examples (#27495) Co-authored-by: Long Ding (from Dev Box) <[email protected]> * fix comment * fix comment * fix comment * fix comment * fix comment * fix comment --------- Co-authored-by: Wei Dong <[email protected]> Co-authored-by: Cunfeng <[email protected]> Co-authored-by: LDD <[email protected]> Co-authored-by: Long Ding (from Dev Box) <[email protected]> * [Azure AI - Health Insights] - Typespec revision for Health Insights API Version 2 (#27223) * Health Insights API Version 2 * add custom_words * update radiology insights doc descriptions * misspell * add java service-name option to emit the service name * update openAPI spec. misspell * model is Element instead of extends element * Fhir.R4 namespace as PascalCase * Fix: workaround - force order resolution * fix: suppression to get additionalProperties. DomainResource is Resource * suppress in patient timeline to get additionalProperties * [Health Insights] Project structure updates (#27545) * move main files under service dir * regen openapi + move examples * update client.tsp files * tsp format * update tspconfig.yaml * use clientName decorator to decorate Fhir_R4 models * Operation types as camelCase * replace projectedName with clientName * model extends Element - same as FHIR spec * move clientName to client.tsp * fix: clientName - typename * fix: token-expected: ';' * remove import, typespec-client-generator-core * tsp format * fix: LRO response schema to include result * add @clientName to all models * replace decimal with decimal128, add RI sample * replace decimal128 with float64 * tsp format * suppress AvoidAnonymousTypes * comment clientName decorators * comment clientName decorators * comment clientName decorator for RI client.tsp * Add projectedName * move projectedName to client.tsp * fix: projectedName on client * updat tspconfig.yaml * move service.tsp * update ref * revert structure changes * move examples * tspconfig --------- Co-authored-by: catalinaperalta <[email protected]> * [ci-fix.md] Add known issues to "Swagger LintDiff for TypeSpec" (#27573) * Adding new version 2024-01-01-preview for updating monitor Properties (#27462) * Base API commit * Changing version to new 2024-01-01-preview * Adding additional parameters to MonitorProperties and updating example * Updating readme.md * [Hub Generated] Review request for Microsoft.ContainerService/aks to add version preview/2023-11-02-preview (#27431) * Adds base for updating Microsoft.ContainerService/aks from version preview/2023-10-02-preview to version 2023-11-02-preview * Updates readme * Updates API version in new specs and examples * update readme (#26753) * Add Trusted Launch fields to AgentPoolSecurityProfile (#26850) * add trusted launch fields to AgentPoolSecurityProfile * fix link to docs * add new words to cspell.json * fix links to docs again --------- Co-authored-by: Lily Pan <[email protected]> * Replace "GuardrailsProfile" with "SafeguardsProfile", add ListSafeguardsVersions entities (#26798) * Update readme.md Reverting global tag to stable GA version for SDK release * Change guardrails to safeguards * clean up remaining references * fix casing * Add back guardrailsVersions * Fix typos --------- Co-authored-by: Jooneil Ahn <[email protected]> * Add scheduled events data object. (#26774) * Add eventDetails to ScheduledEventProperties. --------- Co-authored-by: lilypan26 <[email protected]> Co-authored-by: Lily Pan <[email protected]> Co-authored-by: Nick Keller <[email protected]> Co-authored-by: Jooneil Ahn <[email protected]> Co-authored-by: Jun Sun <[email protected]> Co-authored-by: Jun Sun <[email protected]> * Add AppPlatform 2024-01-01-preview (#27113) * Adds base for updating Microsoft.AppPlatform from version preview/2023-11-01-preview to version 2024-01-01-preview * Updates readme * Updates API version in new specs and examples * add cspell exclusion (#26987) * Add option for Application Configuration Service refresh interval (#26943) * add the option for acs refresh interval * refine description and complete examples * feat: Add Java 21 (#26946) * add buildpacks version (#26933) * Update appplatform.json * Update BuildServiceBuilder_Get.json * Update BuildServiceBuilder_List.json * Update BuildServiceBuilder_CreateOrUpdate.json * Update language specific readme.md for 2024-01-01-preview api version (#27041) * Cherry latest stable branch change to preview API version (#27063) * e94094b * 4a35b74 * f3e4338 * 4a35b74 * a92c321 * 9a93245 * a693dc6 * fix lint * fix lint * add buildpacks version (#27061) * Update appplatform.json * Update BuildServiceBuilder_Get.json * Update BuildServiceBuilder_List.json * Update BuildServiceBuilder_CreateOrUpdate.json * Update BuildService_GetSupportedBuildpack.json * Update readme.md (#27095) * Short lived app support (#26958) * Short lived app support * Rename type to kind * add cancelled (#1) * Add testEndpointAuthState to AppResourceProperties (#26938) * add disable test endpoint auth to AppResourceProperties * Update Apps_CreateOrUpdate_VNetInjection.json * Update Apps_CreateOrUpdate.json * Update Apps_Get.json * Update Apps_Get_VNetInjection.json * Update Apps_List.json * Update Apps_List_VNetInjection.json * Update Apps_SetActiveDeployments.json * Update Apps_Update.json * Update Apps_Update_VNetInjection.json * use enum for test endpoint auth * remove api version from readme.python.md * revert short lived app API (#27196) * adding version for python sdk temporarily for python sdk generation --------- Co-authored-by: Jeff <[email protected]> Co-authored-by: Qingyi Liu <[email protected]> Co-authored-by: Yuwei Zhou <[email protected]> Co-authored-by: ninpan-ms <[email protected]> Co-authored-by: Sandy Cai <[email protected]> * Azure Deployment Manager is being decommissioned. Deleting the Rest API Specs related to ADM (#26818) * updating preview tag (#27555) * adding preview to 2023-11 tag * update tag * update tag in yaml * Fixing response codes for importSpecification --------- Co-authored-by: pracagrawal <[email protected]> Co-authored-by: MJ <[email protected]> Co-authored-by: Wei Dong <[email protected]> Co-authored-by: Wei Dong <[email protected]> Co-authored-by: Cunfeng <[email protected]> Co-authored-by: LDD <[email protected]> Co-authored-by: Long Ding (from Dev Box) <[email protected]> Co-authored-by: Asaf Levi <[email protected]> Co-authored-by: catalinaperalta <[email protected]> Co-authored-by: Mike Harder <[email protected]> Co-authored-by: Apoorva Singh <[email protected]> Co-authored-by: FumingZhang <[email protected]> Co-authored-by: lilypan26 <[email protected]> Co-authored-by: Lily Pan <[email protected]> Co-authored-by: Nick Keller <[email protected]> Co-authored-by: Jooneil Ahn <[email protected]> Co-authored-by: Jun Sun <[email protected]> Co-authored-by: Jun Sun <[email protected]> Co-authored-by: Xiaolu Dai <[email protected]> Co-authored-by: Jeff <[email protected]> Co-authored-by: Qingyi Liu <[email protected]> Co-authored-by: Yuwei Zhou <[email protected]> Co-authored-by: ninpan-ms <[email protected]> Co-authored-by: Sandy Cai <[email protected]> Co-authored-by: rohantagaru <[email protected]> Co-authored-by: mwesigwaguma <[email protected]>
Azure · Feb 1, 2024 · 09104ed · 09104ed
1 parent 4173b8d
commit 09104ed
Show file tree

Hide file tree

Showing 748 changed files with 184,569 additions and 7,530 deletions.
diff --git a/cSpell.json b/cSpell.json
@@ -177,6 +177,13 @@
                 "Noreuse"
             ]
         },
+        {
+            "filename": "**/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/**/*json",
+            "words": [
+                "vtpm",
+                "trustedlaunch"
+            ]
+        },
         {
             "filename": "**/specification/containerregistry/data-plane/Microsoft.ContainerRegistry/preview/2018-08-10/containerregistry.json",
             "words": [
@@ -983,6 +990,12 @@
                 "mpga"
             ]
         },
+        {
+            "filename": "**/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json",
+            "words": [
+                "springboot"
+            ]
+        },
         {
             "filename": "**/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/**/*.json",
             "words": [

diff --git a/custom-words.txt b/custom-words.txt
@@ -3108,6 +3108,7 @@ usermetadata
 userpreference
 userprincipalname
 usersetting
+usersync
 usertime
 usql
 usuk
@@ -3979,3 +3980,7 @@ proto
 msvideo
 SOQL
 Mulesoft
+retroperitoneal
+codeable
+telehealth
+loinc
diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md
@@ -16,6 +16,10 @@
     - [`Record<unkown>` causes `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition`](#recordunkown-causes-avoidadditionalproperties-and-propertiestypeobjectnodefinition)
     - [`RequestBodyMustExistForPutPatch`](#requestbodymustexistforputpatch)
     - [`PatchPropertiesCorrespondToPutProperties`](#patchpropertiescorrespondtoputproperties)
+    - [`@singleton` causes `EvenSegmentedPathForPutOperation` and `XmsPageableForListCalls`](#singleton-causes-evensegmentedpathforputoperation-and-xmspageableforlistcalls)
+    - [`AvoidAnonymousParameter`, `AvoidAnonymousTypes`, `IntegerTypeMustHaveFormat`](#avoidanonymousparameter-avoidanonymoustypes-integertypemusthaveformat)
+    - [`AvoidAnonymousTypes` inside a 202 response](#avoidanonymoustypes-inside-a-202-response)
+    - [`OAuth2Auth` causes `XmsEnumValidation`](#oauth2auth-causes-xmsenumvalidation)
   - [`Swagger Avocado`](#swagger-avocado)
     - [Get help fixing Avocado validation failures](#get-help-fixing-avocado-validation-failures)
     - [Run avocado locally](#run-avocado-locally)
@@ -155,21 +159,53 @@ To reproduce LintDiff failures locally, see [CONTRIBUTING.md / How to locally re
 
 ## `Swagger LintDiff` for TypeSpec: troubleshooting guides
 
+Check `Swagger LintDiff` may fail for the OpenAPI generated from TypeSpec, even if there are no warnings or errors reported from the TypeSpec compiler.  Causes include bugs in the TypeSpec OpenAPI emitter, bugs in LintDiff rules, incompatibilities between TypeSpec and LintDiff, or checks duplicated in TypeSpec and LintDiff.
+
+We are working to address the root causes (where possible).  Until then, we recommend you [suppress](#suppression-process) these LintDiff errors, using a "permanent suppression" with a descriptive "reason", so we can revert your suppression when the root cause is fixed.
+
 ### `Record<unkown>` causes `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition`
 
-The use of `Record<unkown>` in TypeSpec is discouraged, and there is a TypeSpec lint rule to enforce this.  If you still need to use `Record<unknown>`, the OpenAPI spec generated will cause many LintDiff errors of types `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition`.  You will need to suppress both the TypeSpec violation (in TypeSpec source code) and the LintDiff violations (in `readme.md`).
+The use of `Record<unkown>` in TypeSpec is discouraged, and there is a TypeSpec lint rule to enforce this.  If you still need to use `Record<unknown>`, the OpenAPI spec generated will cause many LintDiff errors of types `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition`.  You will need to suppress both the TypeSpec violation (in TypeSpec source code) and the LintDiff violations.
 
 ### `RequestBodyMustExistForPutPatch`
 
-We believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/641.  Until fixed, spec authors should **not** suppress the violations in `readme.md`, but rather have label `Approved-LintDiff` applied to their PR to ignore the errors.
+We believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/641
 
 ### `PatchPropertiesCorrespondToPutProperties`
 
-We believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/642.  Until fixed, spec authors should **not** suppress the violations in `readme.md`, but rather have label `Approved-LintDiff` applied to their PR to ignore the errors.
+We believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/642
 
 ### `@singleton` causes `EvenSegmentedPathForPutOperation` and `XmsPageableForListCalls`
 
-If `EvenSegmentedPathForPutOperation` and/or `XmsPageableForListCalls` are failing for OpenAPI generated from TypeSpec using `@singleton` (OpenAPI path ends with `/default`), we believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/646.  Until fixed, spec authors should **not** suppress the violations in `readme.md`, but rather have label `Approved-LintDiff` applied to their PR to ignore the errors.
+If `EvenSegmentedPathForPutOperation` and/or `XmsPageableForListCalls` are failing for OpenAPI generated from TypeSpec using `@singleton` (OpenAPI path ends with `/default`), we believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/646
+
+### `AvoidAnonymousParameter`, `AvoidAnonymousTypes`, `IntegerTypeMustHaveFormat`
+
+Data-plane specs can suppress violations of the following rules, since they only exist for the benefit of SDKs generated from swagger, and data-plane SDKs are generated directly from TypeSpec.  Resource-manager specs should **not** suppress violations of these rules, since resource-manager SDKs are generated from OpenAPI, and rely on these errors being fixed.
+
+* `AvoidAnonymousParameter`
+* `AvoidAnonymousTypes`
+* `IntegerTypeMustHaveFormat`
+
+### `AvoidAnonymousTypes` inside a 202 response
+
+As an exception to the previous note, resource-manager specs **may** be able to suppress `AvoidAnonymousTypes`, but only if the error is inside a 202 response from a long-running operation (LRO).  It is known that SDKs do not need to generate type names for such responses.
+
+### `OAuth2Auth` causes `XmsEnumValidation`
+
+TypeSpec using `OAuth2Auth` may generate the following OpenAPI:
+
+```
+"type": {
+  "type": "string",
+  "description": "OAuth2 authentication",
+  "enum": [
+    "oauth2"
+  ]
+},
+```
+
+Which causes error `XmsEnumValidation`.  The recommended workaround is to add `omit-unreachable-types: true` to your `tspconfig.yaml`.
 
 ## `Swagger Avocado`