Skip to content

Conversation

@annoakes
Copy link
Contributor

@annoakes annoakes commented Jan 20, 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, @annoakes 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 Jan 20, 2021

    Swagger Validation Report

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

    Rule Message
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'NetworkAcls' removed or renamed?
    New: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L930:3
    Old: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L923:3
    1011 - AddingResponseCode The new version adds a response code '202'.
    New: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L297:11
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'networkAcls' renamed or removed?
    New: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L1002:7
    Old: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L995:7
    1041 - AddedPropertyInResponse The new version has a new property 'publicNetworkAccess' in response that was not found in the old version.
    New: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L1002:7
    Old: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L995: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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 20, 2021

    Swagger Generation Artifacts

    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from cb2676d. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	python3 -m venv venv
      command	pip install --upgrade setuptools wheel pip
      command	pip install pathlib jinja2 msrestazure
      command	autorest --version=V2 [email protected]/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/purview/resource-manager/readme.md
    • ⚠️azure-mgmt-purview [View full logs]  [Release SDK Changes]
      cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-purview
      cmderr	[buildConf] INFO:packaging_tools.conf:Build default conf for azure-mgmt-purview
      cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-purview
      cmderr	[buildPackage] /home/vsts/work/1/s/azure-sdk-for-python_tmp/venv/lib/python3.6/site-packages/setuptools/dist.py:479: UserWarning: The version specified ('2020-12-01-preview') is an invalid version, this may not work as expected with newer versions of setuptools, pip, and PyPI. Please see PEP 440 for more details.
      cmderr	[buildPackage]   "details." % version
      cmderr	[buildPackage] warning: no files found matching '*.py' under directory 'tests'
      cmderr	[buildPackage] warning: no files found matching '*.yaml' under directory 'tests'
      cmderr	[buildPackage] /home/vsts/work/1/s/azure-sdk-for-python_tmp/venv/lib/python3.6/site-packages/setuptools/dist.py:479: UserWarning: The version specified ('2020-12-01-preview') is an invalid version, this may not work as expected with newer versions of setuptools, pip, and PyPI. Please see PEP 440 for more details.
      cmderr	[buildPackage]   "details." % version
      cmderr	[buildPackage] warning: no files found matching '*.py' under directory 'tests'
      cmderr	[buildPackage] warning: no files found matching '*.yaml' under directory 'tests'
      cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
      cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.purview
      cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.purview
      cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.purview
      cmderr	[changelogReport] INFO:__main__:Report written to sdk/purview/azure-mgmt-purview/code_reports/latest/report.json
      cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-purview on PyPI
      cmderr	[changelogReportLatest] Traceback (most recent call last):
      cmderr	[changelogReportLatest]   File "/usr/lib/python3.6/runpy.py", line 193, in _run_module_as_main
      cmderr	[changelogReportLatest]     "__main__", mod_spec)
      cmderr	[changelogReportLatest]   File "/usr/lib/python3.6/runpy.py", line 85, in _run_code
      cmderr	[changelogReportLatest]     exec(code, run_globals)
      cmderr	[changelogReportLatest]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/code_report.py", line 399, in <module>
      cmderr	[changelogReportLatest]     main(args.package_name, args.version, args.no_venv, args.pypi, args.last_pypi, args.output)
      cmderr	[changelogReportLatest]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/code_report.py", line 263, in main
      cmderr	[changelogReportLatest]     versions = [str(v) for v in client.get_ordered_versions(package_name)]
      cmderr	[changelogReportLatest]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/pypi_tools/pypi.py", line 40, in get_ordered_versions
      cmderr	[changelogReportLatest]     project = self.project(package_name)
      cmderr	[changelogReportLatest]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/pypi_tools/pypi.py", line 25, in project
      cmderr	[changelogReportLatest]     response.raise_for_status()
      cmderr	[changelogReportLatest]   File "/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv/lib/python3.6/site-packages/requests/models.py", line 943, in raise_for_status
      cmderr	[changelogReportLatest]     raise HTTPError(http_error_msg, response=self)
      cmderr	[changelogReportLatest] requests.exceptions.HTTPError: 404 Client Error: Not Found for url: https://pypi.org/pypi/azure-mgmt-purview/json/
      warn	Script return with result [warning] code [1] signal [null] cwd [azure-sdk-for-python]: python
      warn	Not exact 2 reports found:
      warn		code_reports/latest/report.json
      warn	Not generating changelog.
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from cb2676d. 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/purview/mgmt/2020-12-01-preview/purview [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    ️️✔️[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

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

    @annoakes
    Copy link
    Contributor Author

    NetworkAcl breaking change is for Network Resource Provider Private Endpoint onboarding, we based on old property off of a old contract which is not required. This is not yet leveraged by customers or shipped in any SDK, we have updated based on Networks teams requirments.

    @ChenTanyi
    Copy link
    Contributor

    @annoakes Please fix CI error first.
    For breaking change, you could tell JeffreyRichter about it. I think it would be approved if there is no customer impact.

    @annoakes
    Copy link
    Contributor Author

    @annoakes Please fix CI error first.
    For breaking change, you could tell JeffreyRichter about it. I think it would be approved if there is no customer impact.

    Updated prettier and have reached out to @JeffreyRichter

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 20, 2021
    @annoakes
    Copy link
    Contributor Author

    @annoakes Please fix CI error first.
    For breaking change, you could tell JeffreyRichter about it. I think it would be approved if there is no customer impact.

    Updated prettier and have reached out to @JeffreyRichter

    @annoakes Please fix CI error first.
    For breaking change, you could tell JeffreyRichter about it. I think it would be approved if there is no customer impact.

    Breaking change has been signed off. Please merge, thanks!

    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

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    3 participants