-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Updating Compute Diagnostic RP's swagger with additional APIs #18317
Conversation
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 |
[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. |
Swagger Validation Report
|
Rule | Message |
---|---|
1038 - AddedPath |
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 |
1038 - AddedPath |
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: 4 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 )
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 |
|
'storageAccountId' 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#L423 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4041 - XmsIdentifierValidation |
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 |
|
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 |
️⚠️
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).
Swagger Generation Artifacts
|
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: |
* fix privateLink client name * Add missing PL operations * fix prettier and validation errors * wrap PrivateLinkAssociation in properties field * match pla put and get response * fix getpla example * add 201 response to PUT requests * add 201 response to PUT examples * Update specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/privateLinks.json Co-authored-by: Dapeng Zhang <ufo54153@gmail.com> Co-authored-by: Dapeng Zhang <ufo54153@gmail.com>
… Private Endpoint Update (#18281) * (Internal only) Added Private Endpoint Proxy Private Endpoint Update * The existing resource also needs a change * Renamed example * Fixing more copy and paste errors * Removed read only, formatted new file * Move provisioning state inside proxy properties * Revert "Move provisioning state inside proxy properties" This reverts commit 414d0c6. * Moved proxy provisioning state into properties, try #2 * Moved proxy provisioning state into properties, try number 3 * Moved proxy provisioning state into properties, try number 4 * Moved Proxy provisioningState to top level, removed property bag * Fixed a naming error * Linter fixes * Removed flatten in Proxy properties * Reverted all provisioningState changes * Swapped properties to match the old swagger
Co-authored-by: Steven Vukelich <svukel@microsoft.com>
…stable/2022-03-01 (#18244) * Adds base for updating Microsoft.Capacity from version stable/2021-07-01 to version 2022-03-01 * Updates readme * Updates API version in new specs and examples * Update with new changes * include quota.json in readme * Remove dollar sign for publisher id * Change name from FulfillmentCreatedDateTime to BenefitStartTime
…02-preview (#18150) * Adds base for updating Microsoft.ContainerService from version preview/2022-01-02-preview to version 2022-02-02-preview * Updates readme * Updates API version in new specs and examples * Add key management service profile of a managed cluster for version 2022-02-02-preview (#17955) * Add key management service profile of a managed cluster for version 2022-02-02-preview * add kmsProfile * update after api review * add more details in description * update for comments * add mc snapshot api (#17974) * add mc snapshot api * fix format * add mc snapshot type * define type for enums * add properties for example * Update readmes for the 2022-02-02-preview dev branch of container service (#17889) * update readme * remove useless -only tags * remove nested property in allOf for 2022-02-02-preview managedClusters (#18063) * Fix credential format typo in 0102 preview (#18117) * add missing type object (#18116) * Update several common definitions according to arm feedback for container service 2022-02-02-preview (#18206) * update definition of serveral parameters and system data * update definition of Resource and move property location to sub resources * add missing tags property for prev Resource * fix for compatibility * fix definition name Co-authored-by: Bin Xia <binxi@microsoft.com> Co-authored-by: Qingqing <qizhe@microsoft.com> Co-authored-by: Tongyao Si <tosi@microsoft.com>
* add xms-ids for monitor * inner properties * change operator to name
* Mobile Network REST API Specification * Removed API versions 2020-06-01-preview and 2021-04-01-preview. Have only the API version 2022-01-01-preview in Public * Addressed Swagger Avocado and Swagger SpellCheck Errors * Addressed Parameters Order Errors * Merge azure-rest-api-specs-pr branch ssivathas/mobilenetwork-public-api into satravi/mobilenetwork-rest-api-specs * Removed Unreferenced JSON Files * Added support for Static IP Addressing to PMN * Addressed Swagger PrettierCheck Errors * Addressed Swagger ModelValidation Errors * change go config to track 2 * Updated the API versions in SDK README files * Update readme.python.md * Update readme.md * Updated ActivationState to ConfigurationState * Addressed XmsIdentifierValidation Errors * Addressed DescriptionAndTitleMissing Errors * Generic name for N2 and N3 Interface attributes to support 4G Networks * Generic name for N6 Interface attribute to support 4G Networks * Generic name for N6 Interface attribute to support 4G Networks * Updated the Mobile Network REST specification and examples * Removed the read-only field activationState * Added 2022-03-01 version * Updated 2022-03-01 version in the README files * Removed the duplicate custom-words * Revert "Mobile Network API version 2022-03-01" * Revert custom-words * Added Mobile Network API version 2022-03-01-preview * Updated Mobile Network API version 2022-03-01-preview specs and examples Co-authored-by: ArcturusZhang <dapzhang@microsoft.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>
…y-2021-12-01-preview' (#18267) * Adds base for updating Microsoft.Security from version preview/2021-07-01-preview to version 2021-12-01-preview * Updates readme * Updates API version in new specs and examples * Keep only Securityconnectors in the API version * Adding CspmMonitorGcp offering * minors * Adding Security connector * Fix prettier issue * Adding information protection offering * Adding suppression rule * added github configuration, fixed bugs * updated examples * added example * fixed bugs in offering inheritnece, added org data for aws/gcp objects, updated discriminators * added discriminator for orgmembershipType on environmentData object, updated aws to awsAccount on examples for aws env data * fixed discriminator position * all example validations + schema validations pass, BEFORE adding updated examples * fixed null aws env data property * Adding DefenderForDatabases * Run prettier * Small renamings * Fix native cloud conection * update servers offerings * adding containers * Remove DefenderForDatabases offerings * Adding Qualys as known word * Update the VA type to enum * small changes for servers offering and gcpproject properties * added missing enum types * Servers P1P2 * Add P1P2 to servers GCP * subPlan fixes * Remove supression * add suppression rule back * Adding operations to the default tag * Add x-ms-identifiers Co-authored-by: Sapir Elmakayes <saelmaka@microsoft.com> Co-authored-by: chemishumacher <chemishumacher@gmail.com>
…stable/7.3 (#18028) * Adds base for updating Microsoft.KeyVault from version preview/7.3-preview to version 7.3 * Updates readme * Updates API version in new specs and examples * [KeyVault] - Add exclusion for known spellcheck issue (#18031) * add exclusion for known spellcheck issue * collapse cspell ignore for keyvault's storage.json
2) Udpate StorageConfigurationInout data model -> removed "resourceId" property.
2) Added new APIs + examples for Compute Diagnostic RP - 2021-06-01-preview 3) Prettier fix
Closing this Pull request and creating a new one. |
Updating Compute Diagnostic RP's Swagger API .(Ref PR: Azure/azure-rest-api-specs#18317) (Azure#18351) * 1) Ref PR: Azure/azure-rest-api-specs#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.
Updating Compute Diagnostic RP's Swagger API .(Ref PR: Azure/azure-rest-api-specs#18317) (Azure#18351) * 1) Ref PR: Azure/azure-rest-api-specs#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.
Updating Compute Diagnostic RP's Swagger API .(Ref PR: Azure/azure-rest-api-specs#18317) (Azure#18351) * 1) Ref PR: Azure/azure-rest-api-specs#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.
Updating Compute Diagnostic RP's Swagger API .(Ref PR: Azure/azure-rest-api-specs#18317) (#18351) * 1) Ref PR: Azure/azure-rest-api-specs#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.
…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.
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.