Skip to content

Conversation

@sonalverm
Copy link
Contributor

@sonalverm sonalverm commented Feb 3, 2021

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.

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

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.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service
  • 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.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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.

@openapi-workflow-bot
Copy link

Hi, @sonalverm Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 3, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 70 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'PrivateLinkResources_ListByService' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.SecurityAndCompliance/stable/2021-01-11/privateLinkServicesForEDMUpload.json#L536
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'PrivateLinkResourcesComp_ListByService' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.SecurityAndCompliance/stable/2021-01-11/privateLinkServicesForM365ComplianceCenter.json#L536
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'PrivateLinkResourcesSec_ListByService' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.SecurityAndCompliance/stable/2021-01-11/privateLinkServicesForM365SecurityCenter.json#L536
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'PrivateLinkResourcesAdtAPI_ListByService' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.SecurityAndCompliance/stable/2021-01-11/privateLinkServicesForO365ManagementActivityAPI.json#L536
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'PrivateLinkResourcesForSCCPowershell_ListByService' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.SecurityAndCompliance/stable/2021-01-11/privateLinkServicesForSCCPowershell.json#L536
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateEndpointConnections' with immediate parent 'PrivateLinkServicesForEDMUploadDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-01-11/privateLinkServicesForSCCPowershell.json#L627
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateLinkResources' with immediate parent 'PrivateLinkServicesForEDMUploadDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-01-11/privateLinkServicesForSCCPowershell.json#L627
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateEndpointConnections' with immediate parent 'PrivateLinkServicesForM365ComplianceCenterDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-01-11/privateLinkServicesForSCCPowershell.json#L627
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateLinkResources' with immediate parent 'PrivateLinkServicesForM365ComplianceCenterDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-01-11/privateLinkServicesForSCCPowershell.json#L627
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateEndpointConnections' with immediate parent 'PrivateLinkServicesForM365SecurityCenterDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-01-11/privateLinkServicesForSCCPowershell.json#L627
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️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: 13 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'ServiceAccessPolicyEntry' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'ServicesResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateEndpoint' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateEndpointConnection' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateEndpointConnectionProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateLinkServiceConnectionState' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateLinkResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateLinkResourceProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateEndpointConnectionListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateLinkResourceListResult' 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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 3, 2021

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 3ae2e25. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️securityandcompliance/mgmt/2021-01-11/securityandcompliance [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 3ae2e25. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/[email protected] --version=3.0.6374 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/securityandcompliance/resource-manager/readme.md
    • ️✔️securityandcompliance [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager]  [email protected] No repository field.
      cmderr	[resource-manager]  SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
      cmderr	[resource-manager]  SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️⚠️ azure-sdk-for-python warning [Detail]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 3ae2e25. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/securityandcompliance/resource-manager/readme.md
    • ️✔️@azure/arm-securityandcompliance [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/securityAndComplianceAPIs.js → ./dist/arm-securityandcompliance.js...
      cmderr	[npmPack] created ./dist/arm-securityandcompliance.js in 589ms
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 3ae2e25. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/securityandcompliance/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.SecurityAndCompliance [View full logs]  [Release SDK Changes]
      warn	Skip artifact folder because it doesn't exist: artifacts/packages
    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @sonalverm, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @openapi-workflow-bot
    Copy link

    Hi, @sonalverm your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @raych1

    @raych1
    Copy link
    Member

    raych1 commented Feb 4, 2021

    @jianyexi , could you have a look at lintDiff runtime errors?

    @sonalverm
    Copy link
    Contributor Author

    @raych1 , could you please help me with swagger lintdiff pipeline errors?

    @mentat9 mentat9 added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMChangesRequested labels Feb 18, 2021
    @raych1
    Copy link
    Member

    raych1 commented Feb 19, 2021

    @msyyc , can you check if this PR causes python sdk breaking change?

    @msyyc
    Copy link
    Member

    msyyc commented Feb 23, 2021

    For python, the PR is ok

    1 similar comment
    @msyyc
    Copy link
    Member

    msyyc commented Feb 23, 2021

    For python, the PR is ok

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Python

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    10 participants