Skip to content

Conversation

@tabenari
Copy link
Contributor

@tabenari tabenari commented Dec 2, 2020

Changelog

  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. December 2020 or January 2021
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet. January 2021
  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.

diyakobo and others added 2 commits December 2, 2020 18:45
merge the origonal repo to update my forced repository
@openapi-workflow-bot
Copy link

Hi, @tabenari 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.
  • 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-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 2, 2020
    @openapi-workflow-bot
    Copy link

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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 2, 2020

    Swagger Validation Report

    ️❌BreakingChange: 16 Errors, 0 Warnings failed [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    1011 - AddingResponseCode The new version adds a response code '200'.
    New: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L326:11
    1021 - AddedAdditionalProperties The new version adds an 'additionalProperties' element.
    New: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L1326:9
    Old: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L674:9
    1021 - AddedAdditionalProperties The new version adds an 'additionalProperties' element.
    New: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L1102:9
    Old: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L462:9
    1021 - AddedAdditionalProperties The new version adds an 'additionalProperties' element.
    New: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L1375:5
    Old: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L723:5
    1026 - TypeChanged The new version has a different type 'object' than the previous one 'array'.
    New: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L1326:9
    Old: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L674:9
    1026 - TypeChanged The new version has a different type 'object' than the previous one 'array'.
    New: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L1102:9
    Old: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L462:9
    1026 - TypeChanged The new version has a different type 'object' than the previous one 'array'.
    New: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L1375:5
    Old: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L723:5
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L1087:9
    Old: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L448:9
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L434:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L476:5
    ️⚠️LintDiff: 2 Warnings warning [Detail]

    Rule Message
    ⚠️ R2017 - PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'SaaS_CreateResource' Request Model: 'SaasResourceCreation' Response Model: 'SaasResource'
    New: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L305
    ⚠️ R2017 - PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'SaasSubscriptionLevel_CreateOrUpdate' Request Model: 'SaasResourceCreation' Response Model: 'SaasResource'
    New: Microsoft.SaaS/preview/2018-03-01-beta/saas.json#L565
    ️️✔️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 Dec 2, 2020

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 54e5466. 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/saas/mgmt/2018-03-01-beta/saas [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 54e5466. 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-01-07 02:02:31 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-saas"
      cmderr	[generate.py] 2021-01-07 02:02:31 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-01-07 02:02:31 INFO autorest --version=3.0.6350 --use=@autorest/[email protected] --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/saas/azure-resourcemanager-saas --java.namespace=com.azure.resourcemanager.saas  --package-version=1.0.0-beta.1 --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/saas/resource-manager/readme.md
      cmderr	[generate.py] 2021-01-07 02:03:08 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-01-07 02:03:08 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-01-07 02:03:08 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-01-07 02:03:08 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-01-07 02:03:08 ERROR [POM][Skip] find more than one <modules> in pom
      cmderr	[generate.py] 2021-01-07 02:03:17 ERROR [GENERATE] Maven build fail
    • ️✔️azure-resourcemanager-saas [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-01-07 02:03:56 DEBUG Got artifact_id: azure-resourcemanager-saas
      cmderr	[Inst] 2021-01-07 02:03:56 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-01-07 02:03:56 ERROR Unmatch any jar in artifacts
    ️️✔️ azure-sdk-for-python succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 54e5466. 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/saas/resource-manager/readme.md
      warn	No package detected after generation
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 54e5466. 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/saas/resource-manager/readme.md
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️️✔️[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 @tabenari, 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 think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ma/swaggerfeedback.

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

    @tabenari
    Copy link
    Contributor Author

    tabenari commented Dec 6, 2020

    Hi @zhenglaizhang I need the breaking changes errors to be approved.
    The 3 AddedAdditionalProperties and the 3 TypeChanged errors are for fixing an error in the swagger (Fix the Tags field of an ARM resource).

    The additional 4 items for AddedPath and the NoVersionChange errors are due to adding new functionality with a new resource type. We onboarded to this git repo about two weeks ago and this new resource type was not ready then, so no real users for this swagger file, and no breaking changes to the only consumer of our RP which is Ibiza through ARM.

    I also don't understand why the java generator is failing, it would be great if you could help with that as well?

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Dec 14, 2020
    @openapi-workflow-bot
    Copy link

    Hi, @tabenari 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-workflow-bot
    Copy link

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

    @ArcturusZhang
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    Copy link
    Member

    @ArcturusZhang ArcturusZhang left a comment

    Choose a reason for hiding this comment

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

    Please fix the output-folder for go SDK generation.
    And usually we use preview for package version suffix, not beta or alpha. Do you think preview makes sense here?

    @openapi-workflow-bot
    Copy link

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

    @majastrz
    Copy link
    Member

    majastrz commented Jan 5, 2021

    Previous issues are addressed but the linter flagged some missing list APIs. Please take a look.

    @zhenglaizhang
    Copy link
    Contributor

    @tabenari, pls help fix the lint warnings.

    @majastrz majastrz added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMChangesRequested WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 6, 2021
    Copy link
    Member

    @majastrz majastrz left a comment

    Choose a reason for hiding this comment

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

    Signed off from ARM side, but please fix the lint warnings like another commenter suggested.

    @zhenglaizhang zhenglaizhang added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Jan 7, 2021
    Copy link
    Member

    @ArcturusZhang ArcturusZhang left a comment

    Choose a reason for hiding this comment

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

    LGTM

    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 ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    7 participants