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

Adding optionality field to Script Parameter. #14437

Merged
merged 1 commit into from
May 17, 2021

Conversation

thinkdavid
Copy link
Contributor

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, @thinkdavid 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

    [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 May 17, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️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.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[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":"vmware/resource-manager/readme.md",
    "tag":"package-2021-06-01",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"vmware/resource-manager/readme.md",
    "tag":"package-2021-06-01",
    "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":"vmware/resource-manager/readme.md",
    "tag":"package-2021-06-01",
    "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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 17, 2021

    Swagger Generation Artifacts

    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from f94cddc563af51e42e7cf2c56b39e2e504e498e8. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.VMwareSolutionApi [View full logs]  [Preview SDK Changes]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from f94cddc563af51e42e7cf2c56b39e2e504e498e8. 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/vmware/resource-manager/readme.md
    • ️✔️@azure/arm-avs [View full logs]  [Preview 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/avsClient.js → ./dist/arm-avs.js...
      cmderr	[npmPack] created ./dist/arm-avs.js in 589ms
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs] Generate from f94cddc563af51e42e7cf2c56b39e2e504e498e8. 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-avs [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model PrivateCloud has a new parameter external_cloud_links
      info	[Changelog]   - Model MetricDimension has a new parameter internal_name
      info	[Changelog]   - Model MetricDimension has a new parameter to_be_exported_for_shoebox
      info	[Changelog]   - Added operation PrivateCloudsOperations.rotate_vcenter_password
      info	[Changelog]   - Added operation PrivateCloudsOperations.rotate_nsxt_password
      info	[Changelog]   - Added operation group DatastoresOperations
      info	[Changelog]   - Added operation group AddonsOperations
      info	[Changelog]   - Added operation group GlobalReachConnectionsOperations
      info	[Changelog]   - Added operation group ScriptPackagesOperations
      info	[Changelog]   - Added operation group ScriptCmdletsOperations
      info	[Changelog]   - Added operation group ScriptExecutionsOperations
      info	[Changelog]   - Added operation group CloudLinksOperations
      info	[Changelog]   - Added operation group WorkloadNetworksOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Operation HcxEnterpriseSitesOperations.create_or_update has a new signature
      info	[Changelog]   - Operation AuthorizationsOperations.create_or_update has a new signature
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from f94cddc563af51e42e7cf2c56b39e2e504e498e8. 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/vmware/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.Avs [View full logs]  [Preview SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from f94cddc563af51e42e7cf2c56b39e2e504e498e8. 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
    • ️✔️avs/mgmt/2021-06-01/avs [View full logs]  [Preview SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️avs/mgmt/2020-03-20/avs [View full logs]  [Preview SDK Changes]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New field `InternalName` in struct `MetricDimension`
      info	[Changelog] - New field `ToBeExportedForShoebox` in struct `MetricDimension`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 1 additive change(s).
      info	[Changelog]
    • ️✔️preview/avs/mgmt/2021-01-01-preview/avs [View full logs]  [Preview SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️preview/avs/mgmt/2020-07-17-preview/avs [View full logs]  [Preview SDK Changes] Breaking Change Detected
      Only show 30 items here, please refer to log for details.
      info	[Changelog] - New struct `AddonProperties`
      info	[Changelog] - New struct `AddonSrmProperties`
      info	[Changelog] - New struct `AddonUpdate`
      info	[Changelog] - New struct `AddonUpdateProperties`
      info	[Changelog] - New struct `AddonsClient`
      info	[Changelog] - New struct `AddonsCreateOrUpdateFuture`
      info	[Changelog] - New struct `AddonsDeleteFuture`
      info	[Changelog] - New struct `PrivateCloudsRotateNsxtPasswordFuture`
      info	[Changelog] - New struct `PrivateCloudsRotateVcenterPasswordFuture`
      info	[Changelog] - New struct `WorkloadNetworkDNSService`
      info	[Changelog] - New struct `WorkloadNetworkDNSServiceProperties`
      info	[Changelog] - New struct `WorkloadNetworkDNSServicesList`
      info	[Changelog] - New struct `WorkloadNetworkDNSServicesListIterator`
      info	[Changelog] - New struct `WorkloadNetworkDNSServicesListPage`
      info	[Changelog] - New struct `WorkloadNetworkDNSZone`
      info	[Changelog] - New struct `WorkloadNetworkDNSZoneProperties`
      info	[Changelog] - New struct `WorkloadNetworkDNSZonesList`
      info	[Changelog] - New struct `WorkloadNetworkDNSZonesListIterator`
      info	[Changelog] - New struct `WorkloadNetworkDNSZonesListPage`
      info	[Changelog] - New struct `WorkloadNetworksCreateDNSServiceFuture`
      info	[Changelog] - New struct `WorkloadNetworksCreateDNSZoneFuture`
      info	[Changelog] - New struct `WorkloadNetworksDeleteDNSServiceFuture`
      info	[Changelog] - New struct `WorkloadNetworksDeleteDNSZoneFuture`
      info	[Changelog] - New struct `WorkloadNetworksUpdateDNSServiceFuture`
      info	[Changelog] - New struct `WorkloadNetworksUpdateDNSZoneFuture`
      info	[Changelog] - New field `InternalName` in struct `MetricDimension`
      info	[Changelog] - New field `ToBeExportedForShoebox` in struct `MetricDimension`
      info	[Changelog]
      info	[Changelog] Total 11 breaking change(s), 220 additive change(s).
      info	[Changelog]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from f94cddc563af51e42e7cf2c56b39e2e504e498e8. 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-05-17 19:52:22 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-avs;1.0.0-beta.1;1.0.0-beta.2"
      cmderr	[generate.py] 2021-05-17 19:52:22 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2021-05-17 19:52:22 INFO autorest --version=3.1.3 --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/avs/azure-resourcemanager-avs --java.namespace=com.azure.resourcemanager.avs   --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/vmware/resource-manager/readme.md
      cmderr	[generate.py] 2021-05-17 19:53:07 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-avs
      cmderr	[generate.py] 2021-05-17 19:53:07 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-05-17 19:53:07 INFO [POM][Skip] pom already has module azure-resourcemanager-avs
      cmderr	[generate.py] 2021-05-17 19:53:07 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-05-17 19:53:07 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-05-17 19:53:07 INFO [POM][Skip] pom already has module sdk/avs
      cmderr	[generate.py] 2021-05-17 19:53:07 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-avs [View full logs]  [Preview SDK Changes]
      cmderr	[Inst] 2021-05-17 19:56:16 DEBUG Got artifact_id: azure-resourcemanager-avs
      cmderr	[Inst] 2021-05-17 19:56:16 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-05-17 19:56:16 DEBUG Got artifact: azure-resourcemanager-avs-1.0.0-beta.2-javadoc.jar
      cmderr	[Inst] 2021-05-17 19:56:16 DEBUG Got artifact: azure-resourcemanager-avs-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-05-17 19:56:16 DEBUG Match jar package: azure-resourcemanager-avs-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-05-17 19:56:16 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14437/azure-sdk-for-java/azure-resourcemanager-avs/azure-resourcemanager-avs-1.0.0-beta.2.jar\" -o azure-resourcemanager-avs-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-avs -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-avs-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from f94cddc563af51e42e7cf2c56b39e2e504e498e8. 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
    • ️✔️vmware [View full logs]  [Preview Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @ctaggart ctaggart merged commit 4764179 into Azure:AVS/2021-06 May 17, 2021
    ArcturusZhang pushed a commit that referenced this pull request May 18, 2021
    * add AVS 2021-06-01 API
    
    * add cmdlets custom word
    
    * rename ScriptCmdlet cmdletDescription to description (#14218)
    
    * Adding optional to the script parameter (#14437)
    
    Co-authored-by: David Becher <[email protected]>
    
    Co-authored-by: david becher <[email protected]>
    Co-authored-by: David Becher <[email protected]>
    @thinkdavid thinkdavid deleted the dabecher/addingOptional branch May 18, 2021 14:06
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * add AVS 2021-06-01 API
    
    * add cmdlets custom word
    
    * rename ScriptCmdlet cmdletDescription to description (Azure#14218)
    
    * Adding optional to the script parameter (Azure#14437)
    
    Co-authored-by: David Becher <[email protected]>
    
    Co-authored-by: david becher <[email protected]>
    Co-authored-by: David Becher <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants