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

PowerBiDedicated - Fix Swagger Correctness Issue V1 #12866

Merged

Conversation

david-msft
Copy link
Contributor

@david-msft david-msft commented Feb 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 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, @david-msft 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 5, 2021

    Swagger Validation Report

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

    Rule Message
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'enableEndToEndTLS' renamed or removed?
    New: Microsoft.AppPlatform/preview/2020-11-01-preview/appplatform.json#L3374:7
    Old: Microsoft.AppPlatform/preview/2020-11-01-preview/appplatform.json#L3374: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: 4 Warnings warning [Detail]

    Rule Message
    ⚠️ PreCheck/SchemaMissingType "readme":"powerbidedicated/resource-manager/readme.md",
    "tag":"package-2017-10-01",
    "details":"The schema 'OperationListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"powerbidedicated/resource-manager/readme.md",
    "tag":"package-2017-10-01",
    "details":"The schema 'Operation-display' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"powerbidedicated/resource-manager/readme.md",
    "tag":"package-2017-10-01",
    "details":"The schema 'ErrorResponse-error' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/CheckDuplicateSchemas "readme":"powerbidedicated/resource-manager/readme.md",
    "tag":"package-2017-10-01",
    "details":"Checking for duplicate schemas,
    this could take a (long) while. Run with --verbose for more detail."
    ️️✔️[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 5, 2021

    Swagger Generation Artifacts

    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 65dd3a4. 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/powerbidedicated/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.PowerBIDedicated [View full logs]  [Release SDK Changes]
      cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Customizations/CustomCapacitiesOperations.cs(13,47): error CS0535: 'CustomCapacitiesOperations' does not implement interface member 'ICapacitiesOperations.CheckNameAvailabilityWithHttpMessagesAsync(string, CheckCapacityNameAvailabilityParameters, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Microsoft.Azure.Management.PowerBIDedicated.csproj]
      cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Customizations/CustomCapacitiesOperations.cs(13,47): error CS0535: 'CustomCapacitiesOperations' does not implement interface member 'ICapacitiesOperations.CheckNameAvailabilityWithHttpMessagesAsync(string, CheckCapacityNameAvailabilityParameters, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Microsoft.Azure.Management.PowerBIDedicated.csproj]
      cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Customizations/CustomCapacitiesOperations.cs(13,47): error CS0535: 'CustomCapacitiesOperations' does not implement interface member 'ICapacitiesOperations.CheckNameAvailabilityWithHttpMessagesAsync(string, CheckCapacityNameAvailabilityParameters, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Microsoft.Azure.Management.PowerBIDedicated.csproj]
      cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Customizations/CustomCapacitiesOperations.cs(13,47): error CS0535: 'CustomCapacitiesOperations' does not implement interface member 'ICapacitiesOperations.CheckNameAvailabilityWithHttpMessagesAsync(string, CheckCapacityNameAvailabilityParameters, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Microsoft.Azure.Management.PowerBIDedicated.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Customizations/CustomCapacitiesOperations.cs(13,47): error CS0535: 'CustomCapacitiesOperations' does not implement interface member 'ICapacitiesOperations.CheckNameAvailabilityWithHttpMessagesAsync(string, CheckCapacityNameAvailabilityParameters, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Microsoft.Azure.Management.PowerBIDedicated.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Customizations/CustomCapacitiesOperations.cs(13,47): error CS0535: 'CustomCapacitiesOperations' does not implement interface member 'ICapacitiesOperations.CheckNameAvailabilityWithHttpMessagesAsync(string, CheckCapacityNameAvailabilityParameters, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Microsoft.Azure.Management.PowerBIDedicated.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Customizations/CustomCapacitiesOperations.cs(13,47): error CS0535: 'CustomCapacitiesOperations' does not implement interface member 'ICapacitiesOperations.CheckNameAvailabilityWithHttpMessagesAsync(string, CheckCapacityNameAvailabilityParameters, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Microsoft.Azure.Management.PowerBIDedicated.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Customizations/CustomCapacitiesOperations.cs(13,47): error CS0535: 'CustomCapacitiesOperations' does not implement interface member 'ICapacitiesOperations.CheckNameAvailabilityWithHttpMessagesAsync(string, CheckCapacityNameAvailabilityParameters, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/powerbidedicated/Microsoft.Azure.Management.PowerBIDedicated/src/Microsoft.Azure.Management.PowerBIDedicated.csproj]
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: dotnet
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 65dd3a4. 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
    • ️✔️powerbidedicated/mgmt/2021-01-01/powerbidedicated [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️powerbidedicated/mgmt/2017-10-01/powerbidedicated [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Field `Code` of struct `ErrorResponse` has been removed
      info	[Changelog] - Field `Message` of struct `ErrorResponse` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New function `DedicatedCapacityMutableProperties.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New struct `ErrorResponseError`
      info	[Changelog] - New field `Mode` in struct `DedicatedCapacityProperties`
      info	[Changelog] - New field `Mode` in struct `DedicatedCapacityMutableProperties`
      info	[Changelog] - New field `Error` in struct `ErrorResponse`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 6 additive change(s).
      info	[Changelog]
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 65dd3a4. 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/powerbidedicated/resource-manager/readme.md
    • ️✔️powerbidedicated [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]  WARN [email protected] No repository field.
      cmderr	[resource-manager] WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 65dd3a4. 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/powerbidedicated/resource-manager/readme.md
    • ️✔️@azure/arm-powerbidedicated [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/powerBIDedicatedManagementClient.js → ./dist/arm-powerbidedicated.js...
      cmderr	[npmPack] created ./dist/arm-powerbidedicated.js in 302ms
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 65dd3a4. 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
    • ️✔️azure-mgmt-powerbidedicated [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model DedicatedCapacityUpdateParameters has a new parameter mode
      info	[Changelog]   - Model DedicatedCapacity has a new parameter mode
      info	[Changelog]   - Model DedicatedCapacity has a new parameter system_data
      info	[Changelog]   - Model Resource has a new parameter system_data
      info	[Changelog]   - Added operation group AutoScaleVCoresOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model Resource no longer has parameter sku
      info	[Changelog]   - Model ErrorResponse has a new signature
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    In the Window Period to fix mismatches between swagger and service, when PR is labelled with “FixS360”, breaking change can be approved by PR assignee; the Azure Breaking Change Board is no longer required to approve the PR. Please ensure to clarify what s360 action items to be solved, and @ mention PR assignee for awareness. Please check this wiki [Window to Fix Broken]( Window to Fix Broken - Overview (azure.com)) for more details.

    @david-msft
    Copy link
    Contributor Author

    david-msft commented Feb 5, 2021

    Hi @xccc-msft ,
    This PR is to resolve S360 correctness issue, https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=18e1beff-abc0-41a1-adb3-03d8a5eae476. Per @shenglol 's suggestion, making the mode as read-only in this API version. Please review when you have a chance, thanks!

    @openapi-workflow-bot
    Copy link

    Hi @david-msft, 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.

    @ghost
    Copy link

    ghost commented Feb 21, 2021

    Hi, @david-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Feb 21, 2021
    @ghost ghost removed the no-recent-activity label Mar 2, 2021
    @david-msft david-msft requested a review from xseeseesee March 2, 2021 23:33
    @david-msft
    Copy link
    Contributor Author

    @xccc-msft can we merge this PR?

    @david-msft david-msft added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Mar 2, 2021
    @david-msft
    Copy link
    Contributor Author

    @Azure/swagger-specs-pull-request-approvers can we merge this PR. it is approved

    @yungezz
    Copy link
    Member

    yungezz commented Mar 3, 2021

    hi @ArcturusZhang could you pls confirm impact ot Go SDK?
    hi @msyyc could you pls confirm impact ot Go SDK?

    @david-msft
    Copy link
    Contributor Author

    david-msft commented Mar 4, 2021

    @yungezz Friendly ping again. maybe can @shenglol approve? I thought this was merged when it was approved. we are about the hitting the deadline in S360, can we expedite this? Thanks!

    @david-msft
    Copy link
    Contributor Author

    Hi,
    Would be appreciated it if someone can have a quick look at this? @Azure/swagger-specs-pull-request-approvers

    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 Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates CI-BreakingChange-Go CI-BreakingChange-Python FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants