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

added SVI discover example #19980

Merged
merged 3 commits into from
Jul 28, 2022
Merged

added SVI discover example #19980

merged 3 commits into from
Jul 28, 2022

Conversation

gargankit-microsoft
Copy link
Member

@gargankit-microsoft gargankit-microsoft commented Jul 27, 2022

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for 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 are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the 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 refresh required 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

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
  • 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a 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, @gargankit-microsoft 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 27, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.9.6)] new version base version
    SAPVirtualInstance.json 2021-12-01-preview(dc2c089) 2021-12-01-preview(main)
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2021-12-01-preview package-2021-12-01-preview(dc2c089) package-2021-12-01-preview(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ R1003 - ListInOperationName Since operation 'SAPSupportedSku' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L99
    ⚠️ R1003 - ListInOperationName Since operation 'SAPDiskConfigurations' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L155
    ⚠️ R1003 - ListInOperationName Since operation 'SAPAvailabilityZoneDetails' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L205
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L1729
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'getsizingrecommendations' in:'SAPSizingRecommendations'. Consider updating the operationId
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L43
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'getsapsupportedsku' in:'SAPSupportedSku'. Consider updating the operationId
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L99
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'getdiskconfigurations' in:'SAPDiskConfigurations'. Consider updating the operationId
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L155
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'getavailabilityzonedetails' in:'SAPAvailabilityZoneDetails'. Consider updating the operationId
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L205
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'applicationInstances' with immediate parent 'SAPVirtualInstance', must have a list by immediate parent operation.
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L2966
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'centralInstances' with immediate parent 'SAPVirtualInstance', must have a list by immediate parent operation.
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L3178
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'databaseInstances' with immediate parent 'SAPVirtualInstance', must have a list by immediate parent operation.
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L3241
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disablePasswordAuthentication
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L1867
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isAppServerCertified
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L2089
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDatabaseCertified
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L2093
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: hardStop
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L2566
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isSecondaryIpEnabled
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L3260
    ⚠️ R4021 - DescriptionAndTitleMissing 'virtualMachineId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L2710
    ⚠️ R4021 - DescriptionAndTitleMissing 'virtualMachineId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.Workloads/preview/2021-12-01-preview/SAPVirtualInstance.json#L2720
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/dc2c08929e3a86b28d5736736dd907092683b7bd/specification/workloads/resource-manager/readme.md#tag-package-2021-12-01-preview">workloads/resource-manager/readme.md#package-2021-12-01-preview
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ Modeler/MissingType "readme":"workloads/resource-manager/readme.md",
    "tag":"package-2021-12-01-preview",
    "details":"The schema 'OperationsDefinition-properties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/workloads/resource-manager/Microsoft.Workloads/preview/2021-12-01-preview/monitors.json#/components/schemas/OperationsDefinition-properties"


    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"workloads/resource-manager/readme.md",
    "tag":"package-2021-12-01-preview",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 27, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - armworkloads - 0.2.1
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-workloads - 1.0.0b1
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 0131409. 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
      cmderr	[automation_generate.sh]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-workloads [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0131409. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️armworkloads [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0131409. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-workloads [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Type Alias DB2ProviderInstanceProperties
      info	[Changelog]   - Added Type Alias DeploymentConfiguration
      info	[Changelog]   - Added Type Alias DeploymentWithOSConfiguration
      info	[Changelog]   - Added Type Alias DiscoveryConfiguration
      info	[Changelog]   - Added Type Alias HanaDbProviderInstanceProperties
      info	[Changelog]   - Added Type Alias LinuxConfiguration
      info	[Changelog]   - Added Type Alias Monitor
      info	[Changelog]   - Added Type Alias MonitorPropertiesErrors
      info	[Changelog]   - Added Type Alias MsSqlServerProviderInstanceProperties
      info	[Changelog]   - Added Type Alias OperationsContent
      info	[Changelog]   - Added Type Alias OperationsDefinitionDisplay
      info	[Changelog]   - Added Type Alias PatchResourceRequestBodyIdentity
      info	[Changelog]   - Added Type Alias PhpWorkloadResource
      info	[Changelog]   - Added Type Alias PhpWorkloadResourceIdentity
      info	[Changelog]   - Added Type Alias PrometheusHaClusterProviderInstanceProperties
      info	[Changelog]   - Added Type Alias PrometheusOSProviderInstanceProperties
      info	[Changelog]   - Added Type Alias ProviderInstance
      info	[Changelog]   - Added Type Alias ProviderInstancePropertiesErrors
      info	[Changelog]   - Added Type Alias ProxyResource
      info	[Changelog]   - Added Type Alias SAPApplicationServerInstance
      info	[Changelog]   - Added Type Alias SAPCentralServerInstance
      info	[Changelog]   - Added Type Alias SAPDatabaseInstance
      info	[Changelog]   - Added Type Alias SAPInstallWithoutOSConfigSoftwareConfiguration
      info	[Changelog]   - Added Type Alias SapNetWeaverProviderInstanceProperties
      info	[Changelog]   - Added Type Alias SAPVirtualInstance
      info	[Changelog]   - Added Type Alias SearchProfile
      info	[Changelog]   - Added Type Alias ServiceInitiatedSoftwareConfiguration
      info	[Changelog]   - Added Type Alias SingleServerConfiguration
      info	[Changelog]   - Added Type Alias SingleServerRecommendationResult
      info	[Changelog]   - Added Type Alias ThreeTierConfiguration
      info	[Changelog]   - Added Type Alias ThreeTierRecommendationResult
      info	[Changelog]   - Added Type Alias TrackedResource
      info	[Changelog]   - Added Type Alias VmssNodesProfile
      info	[Changelog]   - Added Type Alias WindowsConfiguration
      info	[Changelog]   - Added Type Alias WordpressInstanceResource
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 0131409. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/workloads/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
      cmderr	[Autorest] No usable version of the libssl was found
      cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
      cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
      warn	Skip package processing as generation is failed
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 0131409. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      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
    • ️✔️workloads [View full logs
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @gargankit-microsoft, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    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
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants