Skip to content
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

Pprp #13294

Merged
merged 22 commits into from
Mar 8, 2021
Merged

Pprp #13294

merged 22 commits into from
Mar 8, 2021

Conversation

rapatank
Copy link
Contributor

@rapatank rapatank commented Mar 5, 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 Breaking Change 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 or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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, @rapatank 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 5, 2021

    Swagger Validation Report

    ️❌BreakingChange: 6 Errors, 0 Warnings failed [Detail]

    Rule Message
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json#L151:9
    Old: Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json#L151:9
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: common-types/resource-management/v1/privatelinks.json#L114:5
    Old: Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json#L163:5
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'systemData' renamed or removed?
    New: common-types/resource-management/v1/privatelinks.json#L115:7
    Old: Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json#L166:7
    1041 - AddedPropertyInResponse The new version has a new property 'systemData' in response that was not found in the old version.
    New: Microsoft.PowerPlatform/preview/2020-10-30-preview/privateEndpointConnection.json#L265:7
    Old: Microsoft.PowerPlatform/preview/2020-10-30-preview/privateEndpointConnection.json#L265:7
    1041 - AddedPropertyInResponse The new version has a new property 'requiredZoneNames' in response that was not found in the old version.
    New: common-types/resource-management/v1/privatelinks.json#L115:7
    Old: Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json#L166:7
    1041 - AddedPropertyInResponse The new version has a new property 'systemData' in response that was not found in the old version.
    New: Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json#L150:7
    Old: Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json#L150:7
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️️✔️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: 5 Errors, 14 Warnings failed [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    PreCheck/DuplicateSchema "readme":"powerplatform/resource-manager/readme.md",
    "tag":"package-2020-10-30-preview",
    "details":"Duplicate Schema named PrivateLinkResourceListResult -- properties.value.$ref: undefined => "#/components/schemas/schemas:164" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    PreCheck/DuplicateSchema "readme":"powerplatform/resource-manager/readme.md",
    "tag":"package-2020-10-30-preview",
    "details":"Duplicate Schema named PrivateLinkResource -- properties.systemData: "description":"Metadata for the private link resource.",
    "$ref":"#/components/schemas/schemas:102" =>,
    allOf.0.$ref: undefined => "#/components/schemas/schemas:37" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    PreCheck/DuplicateSchema "readme":"powerplatform/resource-manager/readme.md",
    "tag":"package-2020-10-30-preview",
    "details":"Duplicate Schema named Resource -- title: "Resource" =>,
    properties.location: undefined => "description":"Region where the EnterprisePolicy is located.",
    "readOnly":true,
    "$ref":"#/components/schemas/schemas:125" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    PreCheck/PropertyRedeclaration "readme":"powerplatform/resource-manager/readme.md",
    "tag":"package-2020-10-30-preview",
    "details":"Schema 'TrackedResource' has a property 'location' that is conflicting with a property in the parent schema 'Resource' differs more than just description : [readOnly => '',
    x-ms-mutability => 'read,
    create']"
    AutorestCore/Exception "readme":"powerplatform/resource-manager/readme.md",
    "tag":"package-2020-10-30-preview",
    "details":"Error: Plugin prechecker reported failure."
    ⚠️ PreCheck/SchemaMissingType "readme":"powerplatform/resource-manager/readme.md",
    "tag":"package-2020-10-30-preview",
    "details":"The schema 'keyProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"powerplatform/resource-manager/readme.md",
    "tag":"package-2020-10-30-preview",
    "details":"The schema 'EnterprisePolicyList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"powerplatform/resource-manager/readme.md",
    "tag":"package-2020-10-30-preview",
    "details":"The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"powerplatform/resource-manager/readme.md",
    "tag":"package-2020-10-30-preview",
    "details":"The schema 'ErrorResponseBody' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"powerplatform/resource-manager/readme.md",
    "tag":"package-2020-10-30-preview",
    "details":"The schema 'Operation-display' 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 Mar 5, 2021

    Swagger Generation Artifacts

    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 3b566ba. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-03-08 06:43:14 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-powerplatform"
      cmderr	[generate.py] 2021-03-08 06:43:14 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-03-08 06:43:14 INFO autorest --version=3.1.0 --use=@autorest/java@4.0.19 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/powerplatform/azure-resourcemanager-powerplatform --java.namespace=com.azure.resourcemanager.powerplatform   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/powerplatform/resource-manager/readme.md
      cmderr	[generate.py] 2021-03-08 06:43:49 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-03-08 06:43:49 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-03-08 06:43:49 INFO [POM][Skip] pom already has module azure-resourcemanager-powerplatform
      cmderr	[generate.py] 2021-03-08 06:43:49 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-03-08 06:43:49 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-03-08 06:43:49 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-powerplatform [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-03-08 06:46:15 DEBUG Got artifact_id: azure-resourcemanager-powerplatform
      cmderr	[Inst] 2021-03-08 06:46:15 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-03-08 06:46:15 DEBUG Got artifact: azure-resourcemanager-powerplatform-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-03-08 06:46:15 DEBUG Got artifact: azure-resourcemanager-powerplatform-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-03-08 06:46:15 DEBUG Match jar package: azure-resourcemanager-powerplatform-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-03-08 06:46:15 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13294/azure-sdk-for-java/azure-resourcemanager-powerplatform/azure-resourcemanager-powerplatform-1.0.0-beta.1.jar\" -o azure-resourcemanager-powerplatform-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-powerplatform -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-powerplatform-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 3b566ba. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      warn	No package detected after generation
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 3b566ba. 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
    • ️✔️preview/powerplatform/mgmt/2020-10-30/powerplatform [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Field `SystemData` of struct `PrivateLinkResourceProperties` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New function `SubnetProperties.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New field `RequiredZoneNames` in struct `PrivateLinkResourceProperties`
      info	[Changelog] - New field `Vnetid` in struct `SubnetProperties`
      info	[Changelog] - New field `SystemData` in struct `PrivateLinkResource`
      info	[Changelog] - New field `SystemData` in struct `PrivateEndpointConnection`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 5 additive change(s).
      info	[Changelog]
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 3b566ba. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/powerplatform/resource-manager/readme.md
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    .gitignore Outdated
    *.d.ts.map
    /azure-rest-api-specs
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Can you exclude this file since the change is personal related?

    @openapi-workflow-bot
    Copy link

    Hi @rapatank, 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.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @openapi-workflow-bot
    Copy link

    Hi @rapatank, 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."

    @@ -279,6 +284,7 @@
    "properties": {
    "id": {
    "type": "string",
    "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$",
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    This regex allows double slashes? e.g. /subscriptions//resourceGroups/...

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Actually, this is the same as the patterns other RPs have defined. Examples:
    azure-rest-api-specs\specification\redis\resource-manager\Microsoft.Cache\stable\2017-02-01\redis.json

    azure-rest-api-specs\specification\apimanagement\resource-manager\Microsoft.ApiManagement\preview\2019-12-01-preview\apimdeployment.json

    @raych1 raych1 added the Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review label Mar 8, 2021
    @raych1
    Copy link
    Member

    raych1 commented Mar 8, 2021

    @rapatank , can you fix the CI check errors?

    @raych1 raych1 added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 8, 2021
    @raych1 raych1 merged commit 3b566ba into master Mar 8, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * Update to use common type.
    
    * Update .gitignore
    
    * Update .gitignore
    
    * Revert "Update to use common type."
    
    This reverts commit ad02e06.
    
    * Delete .gitignore
    
    * Updating the models.
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants