Updating Compute Diagnostic RP's Swagger API .(Ref PR: https://github.com/Azure/azure-rest-api-specs/pull/18317) #18351
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2) Added new APIs + examples for Compute Diagnostic RP - 2021-06-01-preview 3) Prettier fix
ansahdev
requested review from
Sandido,
dkulkarni-ms,
haagha,
madewithsmiles,
MS-syh2qs,
grizzlytheodore and
hyonholee
as code owners
|
Hi, @ansahdev 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version is adding a path that was not found in the old version. New: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L210:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L259:5 |
️⚠️LintDiff: 32 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.12.1 , classic-openapi-validator v1.2.2 )
- Linted configuring files (Based on target branch, openapi-validator v1.12.1 , classic-openapi-validator v1.2.2 )
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L259 |
|
| OperationId should contain the verb: 'registerstorageconfiguration' in:'DiskInspectionStorageConfiguration_Register'. Consider updating the operationId Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L215 |
|
| OperationId should contain the verb: 'validatestorageconfiguration' in:'DiskInspectionStorageConfiguration_Validate'. Consider updating the operationId Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L264 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'CloudService' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'Resource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
|
| Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'VirtualMachineImageResource' Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L303 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
Missing identifier id in array item property Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L453 |
| 'GET' operation 'DiagnosticOperations_Read' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L42 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L337 |
|
| The operation 'DiagnosticOperations_Read' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L38 |
|
| OperationId should contain the verb: 'run' in:'DiskInspection_Create'. Consider updating the operationId Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L85 |
|
| 'result' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L382 |
|
| 'resultStatus' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L385 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Gets the status of a scheduled disk inspection request. Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L167 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Gets the status of a scheduled disk inspection request. Location: Microsoft.Compute/preview/2021-06-01-preview/diagnostic.json#L203 |
️⚠️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-2021-12-01 |
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
ghost
added
the
Swagger Generation Artifacts
|
ansahdev
changed the title
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @ansahdev your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
|
NewApiVersionRequired reason: |
JeffreyRichter
added
the
Approved-BreakingChange
pilor
added
ARMSignedOff
This was referenced Mar 22, 2022
25 tasks
|
@ArcturusZhang ARM has signed off and Breaking changes have been approved, please help merge. |
|
@ansahdev Can you please update the tag for Tag: package-2021-06-01-preview. |
…test RP versions.
ArcturusZhang
approved these changes
Mar 24, 2022
This was referenced Mar 24, 2022
visingl
pushed a commit
that referenced
this pull request
Mar 30, 2022
archerzz
pushed a commit
to Azure/azure-sdk-for-net
that referenced
this pull request
Apr 21, 2022
* Initial commit. * update version * adding preview * assembly version change * fix compute_resource-manager * fix resource_manager * assembly changes * tags and assembly version * version update
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
May 16, 2022
…zure#18351) * 1) Ref PR: Azure#18317 2) Added new APIs + examples for Compute Diagnostic RP - 2021-06-01-preview 3) Prettier fix * Updating readme.md for $(tag) == 'package-2021-06-01-preview' with latest RP versions.
paterasMSFT
pushed a commit
to Azure/azure-sdk-for-net
that referenced
this pull request
Jun 15, 2022
* Initial commit. * update version * adding preview * assembly version change * fix compute_resource-manager * fix resource_manager * assembly changes * tags and assembly version * version update
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.