-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Remove <br> syntax from many descriptions in CRP swagger files #23019
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove <br> syntax from many descriptions in CRP swagger files #23019
Conversation
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| availabilitySet.json | 2023-03-01(2f6b797) | 2022-11-01(main) |
| capacityReservation.json | 2023-03-01(2f6b797) | 2022-11-01(main) |
| computeRPCommon.json | 2023-03-01(2f6b797) | 2022-11-01(main) |
| dedicatedHost.json | 2023-03-01(2f6b797) | 2022-11-01(main) |
| image.json | 2023-03-01(2f6b797) | 2022-11-01(main) |
| proximityPlacementGroup.json | 2023-03-01(2f6b797) | 2022-11-01(main) |
| virtualMachine.json | 2023-03-01(2f6b797) | 2022-11-01(main) |
| virtualMachineScaleSet.json | 2023-03-01(2f6b797) | 2022-11-01(main) |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-03-01 | package-2023-03-01(2f6b797) | package-2023-03-01(feature/cplat-2023-03-01) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
ResourceNameRestriction |
The resource name parameter 'availabilitySetName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-03-01/availabilitySet.json#L37 |
ResourceNameRestriction |
The resource name parameter 'availabilitySetName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-03-01/availabilitySet.json#L353 |
MissingTypeObject |
The schema 'AvailabilitySetProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/availabilitySet.json#L411 |
MissingTypeObject |
The schema 'AvailabilitySet' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/availabilitySet.json#L458 |
MissingTypeObject |
The schema 'AvailabilitySetUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/availabilitySet.json#L476 |
MissingTypeObject |
The schema 'AvailabilitySetListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/availabilitySet.json#L494 |
ResourceNameRestriction |
The resource name parameter 'capacityReservationGroupName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-03-01/capacityReservation.json#L37 |
ResourceNameRestriction |
The resource name parameter 'capacityReservationGroupName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-03-01/capacityReservation.json#L390 |
ResourceNameRestriction |
The resource name parameter 'capacityReservationName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-03-01/capacityReservation.json#L390 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: ComputeRP/stable/2023-03-01/capacityReservation.json#L391 |
LroLocationHeader |
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-03-01/capacityReservation.json#L513 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: ComputeRP/stable/2023-03-01/capacityReservation.json#L533 |
LroLocationHeader |
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-03-01/capacityReservation.json#L572 |
ResourceNameRestriction |
The resource name parameter 'capacityReservationGroupName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-03-01/capacityReservation.json#L665 |
OperationIdNounVerb |
Per the Noun_Verb convention for Operation Ids, the noun 'CapacityReservations' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ComputeRP/stable/2023-03-01/capacityReservation.json#L670 |
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Compute/operations' does not match the ARM specification. Please standardize the schema. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L52 |
MissingTypeObject |
The schema 'ComputeOperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L178 |
MissingTypeObject |
The schema 'ComputeOperationValue' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L194 |
MissingTypeObject |
The schema 'ComputeOperationValueDisplay' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L213 |
MissingTypeObject |
The schema 'UsageName' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L238 |
MissingTypeObject |
The schema 'Usage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L251 |
MissingTypeObject |
The schema 'ListUsagesResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L287 |
MissingTypeObject |
The schema 'InstanceViewStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L319 |
MissingTypeObject |
The schema 'SubResourceWithColocationStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L354 |
MissingTypeObject |
The schema 'VirtualMachineSize' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L368 |
MissingTypeObject |
The schema 'VirtualMachineSizeListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L402 |
MissingTypeObject |
The schema 'Plan' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L417 |
MissingTypeObject |
The schema 'HardwareProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L438 |
MissingTypeObject |
The schema 'ImageReference' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L639 |
MissingTypeObject |
The schema 'KeyVaultSecretReference' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/computeRPCommon.json#L690 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2023-03-01 |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Hi, @Sandido Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hold off on merging as there is still some discussion about this. |
|
Hi, @Sandido. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
* copy last version to 2023-03-01 folder * update version reference in the new folder * update versions reference in the new folder * add new readme tag with new version * sync with updates made to 2022-11-01 version * fix generation error * fix duplicate enum name thru c# directive instead. * make all the changes to this version that was made to the last version (2022-11-01) to address modelvalidation errors * update * Revert "update" This reverts commit 08417d3. * Added $expand option in ListAllVMs and ListAllVMs in RG (#22800) * Added $expand option in ListAllVMs and ListAllVMs in RG * Update virtualMachine.json * dedicatedHost Resize feature (#23268) * dedicatedHost Resize feature * DedicatedHost Sku renamed to size and resolved lint errors. * reviewer comments * httpMethod fix * Add property for VM (#22882) (#23329) Co-authored-by: payalguptapg <[email protected]> * Add Reapply for VMSS (#22344) * Add Reapply for VMSS * Prettier fix * Update examples * Address review comments 01 * Use typical resourceGroupName parameter. * Address review comments - Rename examples * Remove <br> syntax from many descriptions in CRP swagger files (#23019) * up to computeRPCommon * all but computeRPCommons * computerpcommon * vmss clean * common clean * vmss try n * trying only \n * remove \n as it messes with rest docs * cleanup 2022-11-01 accidents * cleanups 2023 * remove ID from Update objects that do not have ID (#23078) * update * add identifiers --------- Co-authored-by: Theodore Chang <[email protected]> * Origin/feature/cplat 2023 03 01 (#23203) * Update virtualMachine.json Added missing property for Additional properties not allowed: provisionAfterExtensions Json path: $.value[*].properties.provisionAfterExtensions * added missing property for provisionAfterExtensions * add locatoin in VirtualMachineScaleSetVMExtension * fixed issue of x-ms-mutability --------- Co-authored-by: Younghyun Kim <[email protected]> * Add securityPostureReference (#23106) * [RestorePoints] Adding Encryption, Source Details, HyperVGeneration and WriteAccelerated for Restore Point (#23303) * Restore Point Encryption Details * Modified descriptions and made DiskRestorePointProperties as input property * Renaming object and adding type * Renaming DiskRestorePointProperties * making DiskRestorePoint.id readOnly * Modifying reference * Running Prettier * Renaming EncryptionType * Adding HyperVGeneration and WriteAcceleratorEnabled (prchin) * Add optional parameter hibernate to vmss deallocate api (#23409) * Add optional parameter hibernate to vmss deallocate api * Fix with prettier * update example for vmss deallocate * Add Spot Related Properties to VMSS PATCH * prettier and lintDiff suppressions * retry lintDiff suppression * lint diff suppression retry * Add managed identities parameters for blobs, add treatFailureAsDeploymentFailure flag for Run Command (#23557) * Add managed identities inputs for script, errorBlob, outputBlob * Add treatFailureAsDeploymentFailure flag * Update proximityPlacementGroup.json (#23556) * Update proximityPlacementGroup.json * Update proximityPlacementGroup.json * Update proximityPlacementGroup.json --------- Co-authored-by: Theodore Chang <[email protected]> Co-authored-by: Kartik Gupta <[email protected]> Co-authored-by: cakarata <[email protected]> Co-authored-by: payalguptapg <[email protected]> Co-authored-by: Anshul Verma <[email protected]> Co-authored-by: Adam Sandor <[email protected]> Co-authored-by: younghyun5756 <[email protected]> Co-authored-by: Younghyun Kim <[email protected]> Co-authored-by: krishnak-msft <[email protected]> Co-authored-by: Linu George <[email protected]> Co-authored-by: vatsan28 <[email protected]> Co-authored-by: Viv Lingaiah <[email protected]> Co-authored-by: Micah McKittrick <[email protected]>
* copy last version to 2023-03-01 folder * update version reference in the new folder * update versions reference in the new folder * add new readme tag with new version * sync with updates made to 2022-11-01 version * fix generation error * fix duplicate enum name thru c# directive instead. * make all the changes to this version that was made to the last version (2022-11-01) to address modelvalidation errors * update * Revert "update" This reverts commit 08417d3. * Added $expand option in ListAllVMs and ListAllVMs in RG (Azure#22800) * Added $expand option in ListAllVMs and ListAllVMs in RG * Update virtualMachine.json * dedicatedHost Resize feature (Azure#23268) * dedicatedHost Resize feature * DedicatedHost Sku renamed to size and resolved lint errors. * reviewer comments * httpMethod fix * Add property for VM (Azure#22882) (Azure#23329) Co-authored-by: payalguptapg <[email protected]> * Add Reapply for VMSS (Azure#22344) * Add Reapply for VMSS * Prettier fix * Update examples * Address review comments 01 * Use typical resourceGroupName parameter. * Address review comments - Rename examples * Remove <br> syntax from many descriptions in CRP swagger files (Azure#23019) * up to computeRPCommon * all but computeRPCommons * computerpcommon * vmss clean * common clean * vmss try n * trying only \n * remove \n as it messes with rest docs * cleanup 2022-11-01 accidents * cleanups 2023 * remove ID from Update objects that do not have ID (Azure#23078) * update * add identifiers --------- Co-authored-by: Theodore Chang <[email protected]> * Origin/feature/cplat 2023 03 01 (Azure#23203) * Update virtualMachine.json Added missing property for Additional properties not allowed: provisionAfterExtensions Json path: $.value[*].properties.provisionAfterExtensions * added missing property for provisionAfterExtensions * add locatoin in VirtualMachineScaleSetVMExtension * fixed issue of x-ms-mutability --------- Co-authored-by: Younghyun Kim <[email protected]> * Add securityPostureReference (Azure#23106) * [RestorePoints] Adding Encryption, Source Details, HyperVGeneration and WriteAccelerated for Restore Point (Azure#23303) * Restore Point Encryption Details * Modified descriptions and made DiskRestorePointProperties as input property * Renaming object and adding type * Renaming DiskRestorePointProperties * making DiskRestorePoint.id readOnly * Modifying reference * Running Prettier * Renaming EncryptionType * Adding HyperVGeneration and WriteAcceleratorEnabled (prchin) * Add optional parameter hibernate to vmss deallocate api (Azure#23409) * Add optional parameter hibernate to vmss deallocate api * Fix with prettier * update example for vmss deallocate * Add Spot Related Properties to VMSS PATCH * prettier and lintDiff suppressions * retry lintDiff suppression * lint diff suppression retry * Add managed identities parameters for blobs, add treatFailureAsDeploymentFailure flag for Run Command (Azure#23557) * Add managed identities inputs for script, errorBlob, outputBlob * Add treatFailureAsDeploymentFailure flag * Update proximityPlacementGroup.json (Azure#23556) * Update proximityPlacementGroup.json * Update proximityPlacementGroup.json * Update proximityPlacementGroup.json --------- Co-authored-by: Theodore Chang <[email protected]> Co-authored-by: Kartik Gupta <[email protected]> Co-authored-by: cakarata <[email protected]> Co-authored-by: payalguptapg <[email protected]> Co-authored-by: Anshul Verma <[email protected]> Co-authored-by: Adam Sandor <[email protected]> Co-authored-by: younghyun5756 <[email protected]> Co-authored-by: Younghyun Kim <[email protected]> Co-authored-by: krishnak-msft <[email protected]> Co-authored-by: Linu George <[email protected]> Co-authored-by: vatsan28 <[email protected]> Co-authored-by: Viv Lingaiah <[email protected]> Co-authored-by: Micah McKittrick <[email protected]>
ARM API Information (Control Plane)
The < b r > syntax is translated fine in the Rest API docs, https://learn.microsoft.com/en-us/rest/api/compute/virtual-machine-scale-sets/create-or-update?tabs=HTTP#scaleinpolicy
However, in all of the SDK docs the raw html is translated to <br>
as seen in https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.management.compute.models.vaultcertificate?view=azure-dotnet#properties
After an extensive email discussion with the code generator teams and docs teams, they are leaning towards treating the swagger description as plain text going forward.
This PR removes the < b r > syntax from descriptions where the change in the Rest API docs would not make the docs meaningfully worse, but would improve the SDK docs.
Lots of break line formats remain as removing them would make the Rest API docs worse, https://msazure.visualstudio.com/One/_workitems/edit/17491396.
I need to spend more time determining how to rewrite these if necessary.
.Net SDK PR: Azure/azure-sdk-for-net#35016
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.