Skip to content

Conversation

@PingZhu2232
Copy link
Contributor

@PingZhu2232 PingZhu2232 commented Jul 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
    • 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, @PingZhu2232 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 Jul 5, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 2 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: isDataAction
    Location: Microsoft.FluidRelay/preview/2021-03-12-preview/fluidrelay.json#L509
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create a Fluid Relay server
    Location: Microsoft.FluidRelay/preview/2021-03-12-preview/fluidrelay.json#L175
    ️️✔️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":"fluidrelay/resource-manager/readme.md",
    "tag":"package-2021-03-12-preview",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"fluidrelay/resource-manager/readme.md",
    "tag":"package-2021-03-12-preview",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"fluidrelay/resource-manager/readme.md",
    "tag":"package-2021-03-12-preview",
    "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.15.456)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"fluidrelay/resource-manager/readme.md",
    "tag":"package-2021-03-12-preview",
    "details":"> Installed 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-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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 5, 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-go - preview/fluidrelay/mgmt/2021-03-12-preview/fluidrelay - v55.7.0
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-fluidrelay - first release
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 980ac88. 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-07-20 08:06:57 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-fluidrelay"
      cmderr	[generate.py] 2021-07-20 08:06:57 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-07-20 08:06:57 INFO autorest --version=3.4.5 --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/fluidrelay/azure-resourcemanager-fluidrelay --java.namespace=com.azure.resourcemanager.fluidrelay   --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/fluidrelay/resource-manager/readme.md
      cmderr	[generate.py] 2021-07-20 08:07:25 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-07-20 08:07:25 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-07-20 08:07:25 INFO [POM][Skip] pom already has module azure-resourcemanager-fluidrelay
      cmderr	[generate.py] 2021-07-20 08:07:25 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-07-20 08:07:25 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-07-20 08:07:25 INFO [POM][Success] Write to root pom
      cmderr	[generate.py] 2021-07-20 08:09:15 ERROR [COMPILE] Maven build fail
    • ️✔️azure-resourcemanager-fluidrelay [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-07-20 08:09:20 DEBUG Got artifact_id: azure-resourcemanager-fluidrelay
      cmderr	[Inst] 2021-07-20 08:09:20 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-07-20 08:09:20 DEBUG Got artifact: azure-resourcemanager-fluidrelay-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-07-20 08:09:20 DEBUG Match jar package: azure-resourcemanager-fluidrelay-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-07-20 08:09:20 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/15083/azure-sdk-for-java/azure-resourcemanager-fluidrelay/azure-resourcemanager-fluidrelay-1.0.0-beta.1.jar\" -o azure-resourcemanager-fluidrelay-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-fluidrelay -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-fluidrelay-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 980ac88. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️preview/fluidrelay/mgmt/2021-03-12-preview/fluidrelay [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 980ac88. 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/fluidrelay/resource-manager/readme.md
      warn	No file changes detected after generation
      warn	No package detected after generation
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi, @PingZhu2232 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([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 Jul 5, 2021
    @PingZhu2232
    Copy link
    Contributor Author

    Service is already in RPSaaSMaster branch in private repo. (https://github.com/Azure/azure-rest-api-specs-pr/tree/RPSaaSMaster/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview) Copying latest version for public preview requirements.

    @akning-ms akning-ms assigned zhenglaizhang and unassigned akning-ms Jul 6, 2021
    @zhenglaizhang
    Copy link
    Contributor

    @msyyc @ArcturusZhang could you help check SDK gen failure? #15083 (comment)

    @msyyc
    Copy link
    Member

    msyyc commented Jul 7, 2021

    For python, I help to commit python configuration and it should work now.

    @mentat9
    Copy link
    Member

    mentat9 commented Jul 13, 2021

    Was this already reviewed by ARM in the private repo? If so, please provide the PR link here, We don't need to re-review it.

    @PingZhu2232
    Copy link
    Contributor Author

    Was this already reviewed by ARM in the private repo? If so, please provide the PR link here, We don't need to re-review it.

    @mentat9 Yes it was already reviewed in the private repo. Link here: https://github.com/Azure/azure-rest-api-specs-pr/pull/3282

    @mentat9
    Copy link
    Member

    mentat9 commented Jul 13, 2021

    Was this already reviewed by ARM in the private repo? If so, please provide the PR link here, We don't need to re-review it.

    @mentat9 Yes it was already reviewed in the private repo. Link here: Azure/azure-rest-api-specs-pr#3282

    That PR wasn't reviewed by ARM, so I'll need to review this from ARM perspective, unless it was covered by ARM in a different PR (labels WaitForArmFeedback/ARMSignedOff).

    @PingZhu2232
    Copy link
    Contributor Author

    Was this already reviewed by ARM in the private repo? If so, please provide the PR link here, We don't need to re-review it.

    @mentat9 Yes it was already reviewed in the private repo. Link here: Azure/azure-rest-api-specs-pr#3282

    That PR wasn't reviewed by ARM, so I'll need to review this from ARM perspective, unless it was covered by ARM in a different PR (labels WaitForArmFeedback/ARMSignedOff).

    Ok, didn't know it was not reviewed by ARM.

    @mentat9
    Copy link
    Member

    mentat9 commented Jul 13, 2021

    Please create a new PR that follows the requirement checked above: 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.

    @PingZhu2232
    Copy link
    Contributor Author

    Please create a new PR that follows the requirement checked above: 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.

    @mentat9 Thanks for notice. But we don't have existing version, this is the first version to merge into public repo.

    @PingZhu2232 PingZhu2232 changed the title adding new version 03-12 initial check in for Microsoft.FluidRelay Jul 13, 2021
    @mentat9
    Copy link
    Member

    mentat9 commented Jul 14, 2021

    Please create a new PR that follows the requirement checked above: 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.

    @mentat9 Thanks for notice. But we don't have existing version, this is the first version to merge into public repo.

    Sorry, misunderstood. Will review next.

    @mentat9 mentat9 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 Jul 19, 2021
    @openapi-workflow-bot
    Copy link

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

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-FixRequiredOnFailure

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    5 participants