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

[Hub Generated] Review request for Microsoft.Maps for swagger completeness fix #14456

Merged
merged 4 commits into from
May 21, 2021
Merged

[Hub Generated] Review request for Microsoft.Maps for swagger completeness fix #14456

merged 4 commits into from
May 21, 2021

Conversation

stack111
Copy link
Contributor

@stack111 stack111 commented May 18, 2021

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

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
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • 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, @stack111 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 May 18, 2021

    Swagger Validation Report

    ️❌BreakingChange: 5 Errors, 0 Warnings failed [Detail]
    Rule Message
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Maps/stable/2021-02-01/maps-management.json#L442:5
    1041 - AddedPropertyInResponse The new version has a new property 'internalName' in response that was not found in the old version.
    New: Microsoft.Maps/stable/2021-02-01/maps-management.json#L1105:7
    Old: Microsoft.Maps/stable/2021-02-01/maps-management.json#L1066:7
    1041 - AddedPropertyInResponse The new version has a new property 'internalMetricName' in response that was not found in the old version.
    New: Microsoft.Maps/stable/2021-02-01/maps-management.json#L1105:7
    Old: Microsoft.Maps/stable/2021-02-01/maps-management.json#L1066:7
    1041 - AddedPropertyInResponse The new version has a new property 'sourceMdmNamespace' in response that was not found in the old version.
    New: Microsoft.Maps/stable/2021-02-01/maps-management.json#L1105:7
    Old: Microsoft.Maps/stable/2021-02-01/maps-management.json#L1066:7
    1041 - AddedPropertyInResponse The new version has a new property 'toBeExportedToShoebox' in response that was not found in the old version.
    New: Microsoft.Maps/stable/2021-02-01/maps-management.json#L1105:7
    Old: Microsoft.Maps/stable/2021-02-01/maps-management.json#L1066:7
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: toBeExportedToShoebox
    Location: Microsoft.Maps/stable/2021-02-01/maps-management.json#L1126
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️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.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"maps/resource-manager/readme.md",
    "tag":"package-2021-02",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"maps/resource-manager/readme.md",
    "tag":"package-2021-02",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"maps/resource-manager/readme.md",
    "tag":"package-2021-02",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 18, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-maps - 2.0.0
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 34f09c2. 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 --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/maps/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.Maps [View full logs]  [Release SDK Changes]
      cmdout	[msbuild] /home/vsts/work/1/s/azure-sdk-for-net/sdk/maps/Microsoft.Azure.Management.Maps/tests/Helpers/MapsManagementTestUtilities.cs(50,23): error CS0246: The type or namespace name 'MapsManagementClient' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/maps/Microsoft.Azure.Management.Maps/tests/Microsoft.Azure.Management.Maps.Tests.csproj]
      cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/maps/Microsoft.Azure.Management.Maps/tests/Helpers/MapsManagementTestUtilities.cs(69,23): error CS0246: The type or namespace name 'MapsAccountCreateParameters' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/maps/Microsoft.Azure.Management.Maps/tests/Microsoft.Azure.Management.Maps.Tests.csproj]
      cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/maps/Microsoft.Azure.Management.Maps/tests/Helpers/MapsManagementTestUtilities.cs(102,55): error CS0246: The type or namespace name 'MapsManagementClient' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/maps/Microsoft.Azure.Management.Maps/tests/Microsoft.Azure.Management.Maps.Tests.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/maps/Microsoft.Azure.Management.Maps/tests/Helpers/MapsManagementTestUtilities.cs(50,23): error CS0246: The type or namespace name 'MapsManagementClient' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/maps/Microsoft.Azure.Management.Maps/tests/Microsoft.Azure.Management.Maps.Tests.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/maps/Microsoft.Azure.Management.Maps/tests/Helpers/MapsManagementTestUtilities.cs(69,23): error CS0246: The type or namespace name 'MapsAccountCreateParameters' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/maps/Microsoft.Azure.Management.Maps/tests/Microsoft.Azure.Management.Maps.Tests.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/maps/Microsoft.Azure.Management.Maps/tests/Helpers/MapsManagementTestUtilities.cs(102,55): error CS0246: The type or namespace name 'MapsManagementClient' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/maps/Microsoft.Azure.Management.Maps/tests/Microsoft.Azure.Management.Maps.Tests.csproj]
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: dotnet
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 34f09c2. 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] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      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-maps [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model Dimension has a new parameter internal_metric_name
      info	[Changelog]   - Model Dimension has a new parameter source_mdm_namespace
      info	[Changelog]   - Model Dimension has a new parameter internal_name
      info	[Changelog]   - Model Dimension has a new parameter to_be_exported_to_shoebox
      info	[Changelog]   - Added operation MapsOperationsOperations.list_subscription_operations
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 34f09c2. 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
    • ️✔️track2_azure-mgmt-maps [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model Dimension has a new parameter source_mdm_namespace
      info	[Changelog]   - Model Dimension has a new parameter to_be_exported_to_shoebox
      info	[Changelog]   - Model Dimension has a new parameter internal_metric_name
      info	[Changelog]   - Model Dimension has a new parameter internal_name
      info	[Changelog]   - Added operation MapsOperations.list_subscription_operations
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 34f09c2. 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
    • ️✔️maps/mgmt/2021-02-01/maps [View full logs]  [Release SDK Changes] Breaking Change Detected
      Only show 24 items here, please refer to log for details.
      info	[Changelog]
      info	[Changelog] - New const `Secondary`
      info	[Changelog] - New const `Key`
      info	[Changelog] - New const `Gen2`
      info	[Changelog] - New const `ManagedIdentity`
      info	[Changelog] - New const `Gen1`
      info	[Changelog] - New const `S0`
      info	[Changelog] - New const `User`
      info	[Changelog] - New const `Primary`
      info	[Changelog] - New const `G2`
      info	[Changelog] - New const `S1`
      info	[Changelog] - New const `Application`
      info	[Changelog] - New function `Client.ListSubscriptionOperations(context.Context) (OperationsPage, error)`
      info	[Changelog] - New function `Client.ListSubscriptionOperationsSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `Client.ListSubscriptionOperationsPreparer(context.Context) (*http.Request, error)`
      info	[Changelog] - New function `Client.ListSubscriptionOperationsComplete(context.Context) (OperationsIterator, error)`
      info	[Changelog] - New function `Client.ListSubscriptionOperationsResponder(*http.Response) (Operations, error)`
      info	[Changelog] - New field `SourceMdmNamespace` in struct `Dimension`
      info	[Changelog] - New field `ToBeExportedToShoebox` in struct `Dimension`
      info	[Changelog] - New field `InternalName` in struct `Dimension`
      info	[Changelog] - New field `InternalMetricName` in struct `Dimension`
      info	[Changelog]
      info	[Changelog] Total 11 breaking change(s), 17 additive change(s).
      info	[Changelog]
    • ️✔️maps/mgmt/2018-05-01/maps [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️maps/mgmt/2017-01-01/maps [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️maps/mgmt/2017-01-01-preview/maps [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] This package was removed
    • ️✔️preview/maps/mgmt/2020-02-01-preview/maps [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 34f09c2. 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/maps/resource-manager/readme.md
    • ️✔️@azure/arm-maps [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/azureMapsManagementClient.js → ./dist/arm-maps.js...
      cmderr	[npmPack] created ./dist/arm-maps.js in 254ms
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 34f09c2. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      warn	No file changes detected after generation
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    [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.

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @openapi-workflow-bot
    Copy link

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

    @stack111
    Copy link
    Contributor Author

    stack111 commented May 18, 2021

    We had 1 case of live validation which showed that we do not document the following operation in our swagger. The operation is not entirely used often by customers and most RPs do not document the api. I'm adding the operation to mark 100% completeness coverage on the affected api version. I'd like to request exception given the live traffic validation was only available after we published this API a few weeks ago.

    Breaking Change details

    @stack111 stack111 changed the title [Hub Generated] Review request for Microsoft.Maps to add version stable/2021-02-01 [Hub Generated] Review request for Microsoft.Maps for swagger completeness fix May 18, 2021
    @stack111 stack111 marked this pull request as ready for review May 18, 2021 18:51
    @lirenhe
    Copy link
    Member

    lirenhe commented May 19, 2021

    @stack111, could you follow the http://aka.ms/bcforapi to review this change? The review board would review your request based on your justification.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label May 21, 2021
    @lirenhe lirenhe merged commit 34f09c2 into Azure:master May 21, 2021
    This was referenced May 21, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    …eness fix (Azure#14456)
    
    * adding missing op based on live validation
    
    * fixup
    
    * fix linter
    
    * fixes based on swagger correctness
    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 FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants