fixing NRP networking resource properties #12570
Merged
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
|
Hi, @guptas14 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. vsswagger@microsoft.com |
Swagger Validation Report
Only 10 items are listed, please refer to log for more details.
|
| Rule | Message |
|---|---|
| The JSON file has a circular reference. readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2020-08-01/virtualNetwork.json |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 1378 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"network/resource-manager/readme.md", "tag":"package-2020-08", "details":"The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2020-08", "details":"The schema 'ApplicationGatewayBackendHealthOnDemand' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2020-08", "details":"The schema 'ApplicationGatewayBackendHealth' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2020-08", "details":"The schema 'ApplicationGatewayBackendHealthPool' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2020-08", "details":"The schema 'ApplicationGatewayBackendHealthHttpSettings' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2020-08", "details":"The schema 'ApplicationGatewayBackendHealthServer' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2020-08", "details":"The schema 'ApplicationGatewaySku' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2020-08", "details":"The schema 'ApplicationGatewaySslPolicy' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2020-08", "details":"The schema 'ApplicationGatewayClientAuthConfiguration' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2020-08", "details":"The schema 'ApplicationGatewayIPConfigurationPropertiesFormat' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
|
Hi @guptas14, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi @guptas14, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
@guptas14 Please attach s360 issue links. Thanks. |
|
Hi @guptas14, Please ping supports to fix CI issues. Thanks. |
|
S360 identified issues link: |
kairu-ms
reviewed
Jan 27, 2021
kairu-ms
reviewed
Jan 27, 2021
| @@ -83,7 +83,7 @@ | |||
| "CloudError": { | |||
| "x-ms-external": true, | |||
| "properties": { | |||
| "error": { | |||
| "Error": { | |||
There was a problem hiding this comment.
@guptas14, Could you share the background why you need change error to Error?
There was a problem hiding this comment.
Hi,
I need to make these changes to fix the Swagger incorrectness identified by S360 automation.
There are several resource properties being returned by Networking RP service, which were missing in Swagger, or which did not tell default values.
For Error property, the Swagger definition has 'e' where all api's return error with 'E' in json object. This CloudError is a generic object for all error properties being returned.
S360 identified issues link:
https://msazure.visualstudio.com/Swagger%20KPIs/_workitems/edit/8187877
There was a problem hiding this comment.
Please check this report, for instance, generated by S360:
https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=136094B8-8B18-40F7-A370-07AC2CCA81B0
Additional properties not allowed: Error
Json path: $.Error
#/definitions/CloudError
network.json#L83
@shenglol Could you please confirm here, regarding these Swagger incorrectness fixes required by NRP.
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
According to codegen log, there may be problems in swagger file. Detailed info : cmderr [Autorest] Failure during batch task - {"tag":"package-2020-08"} -- Error: $ref to original location 'file:///home/vsts/work/1/s/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2020-08-01/networkInterface.json#/components/schemas/PrivateLinkService' is not found in the new refs collection. |
|
@guptas14, please share the background why you did these changes. |
Could you help me with the fix needed here? |
raych1
reviewed
Jan 28, 2021
| "description": "The service public IP address of the public IP address resource." | ||
| }, | ||
| "natGateway": { | ||
| "$ref": "./network.json#/definitions/NatGateway", |
There was a problem hiding this comment.
This reference model doesn't exist.
There was a problem hiding this comment.
@raych1 Could you guide how can I mention the reference to NatGateway model here? what should be the correct syntax?
There was a problem hiding this comment.
The syntax is correct and the issue is NatGateway doesn't exist in network.json under 2020-08-01 folder.
|
Azure Pipelines successfully started running 2 pipeline(s). |
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
This was referenced Feb 20, 2021
Closed
This was referenced May 3, 2021
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* fixing NRP networking resource properties * fixing natgateway and privatelinkservice references * adding custom word privatelinkservice * virtualnetwork prettier fix * added custom word natgateway * added more missing resource properties as per S360 * correct natgateway reference * revert 'Error' property casing * fix linkedpublicipaddress property * adding enum values * added prefixes and prettier check done * added prefix for 2 properties
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
Please ensure to add changelog with 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
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from API 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.