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

Update redisenterprise readme files for C#, Azure CLI, and Azure Resource Manager Schema #12943

Merged

Conversation

greenms
Copy link
Contributor

@greenms greenms commented Feb 10, 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: Update configuration files for SDK/CLI code generation
  2. When you are targeting to deploy new service/feature to public regions? N/A
  3. When you expect to publish swagger? N/A
  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 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, @greenms 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 Feb 10, 2021

    Swagger Validation Report

    ️⌛BreakingChange pending [Detail]
    ️⌛LintDiff pending [Detail]
    ️⌛Avocado pending [Detail]
    ️⌛ModelValidation pending [Detail]
    ️⌛SemanticValidation pending [Detail]
    ️⌛[Staging] Cross Version BreakingChange (Base on preview version) pending [Detail]
    ️⌛[Staging] Cross Version BreakingChange (Base on stable version) pending [Detail]
    ️⌛CredScan pending [Detail]
    ️⌛[Staging] SDK Track2 Validation pending [Detail]
    ️⌛[Staging] PrettierCheck pending [Detail]
    ️️✔️[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 Feb 10, 2021

    Swagger Generation Artifacts

    ️️✔️ azure-cli-extensions succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8228416. Azure CLI 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 --az --use=@autorest/az@latest --version=3.0.6271 --clear-output-folder=true --azure-cli-extension-folder=/home/vsts/work/1/s/azure-cli-extensions ../azure-rest-api-specs/specification/redisenterprise/resource-manager/readme.md
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'ProxyResource' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Sku' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Cluster' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ClusterUpdate' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ClusterProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ClusterList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Database' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'DatabaseUpdate' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'DatabaseProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'DatabaseList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Persistence' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Module' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'RegenerateKeyParameters' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ImportClusterParameters' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ExportClusterParameters' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'TrackedResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ProxyResource' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorDetail' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorResponse' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Operation-display' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'OperationListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'PrivateEndpoint' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'PrivateEndpointConnection' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'PrivateEndpointConnectionProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'PrivateLinkServiceConnectionState' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'PrivateLinkResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'PrivateLinkResourceProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'PrivateEndpointConnectionListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'PrivateLinkResourceListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/CheckDuplicateSchemas): Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
      cmdout	[Autorest] WARNING (): cli.auto-parameter-hidden is not true, skip visibility cleaner
      cmderr	[Autorest] BELOW TEST SCENARIO SECTION CAN BE USED IN readme.cli.md
      cmderr	[Autorest] --------------------------------------------------------
      cmderr	[Autorest]   test-scenario:
      cmderr	[Autorest]     - name: /Databases/put/RedisEnterpriseDatabasesCreate
      cmderr	[Autorest]     - name: /Databases/get/RedisEnterpriseDatabasesGet
      cmderr	[Autorest]     - name: /Databases/get/RedisEnterpriseDatabasesListByCluster
      cmderr	[Autorest]     - name: /Databases/patch/RedisEnterpriseDatabasesUpdate
      cmderr	[Autorest]     - name: /Databases/post/RedisEnterpriseDatabasesExport
      cmderr	[Autorest]     - name: /Databases/post/RedisEnterpriseDatabasesImport
      cmderr	[Autorest]     - name: /Databases/post/RedisEnterpriseDatabasesListKeys
      cmderr	[Autorest]     - name: /Databases/post/RedisEnterpriseDatabasesRegenerateKey
      cmderr	[Autorest]     - name: /Databases/delete/RedisEnterpriseDatabasesDelete
      cmderr	[Autorest]     - name: /OperationsStatus/get/OperationsStatusGet
      cmderr	[Autorest]     - name: /PrivateEndpointConnections/put/RedisEnterprisePutPrivateEndpointConnection
      cmderr	[Autorest]     - name: /PrivateEndpointConnections/get/RedisEnterpriseGetPrivateEndpointConnection
      cmderr	[Autorest]     - name: /PrivateEndpointConnections/get/RedisEnterpriseListPrivateEndpointConnections
      cmderr	[Autorest]     - name: /PrivateEndpointConnections/delete/RedisEnterpriseDeletePrivateEndpointConnection
      cmderr	[Autorest]     - name: /PrivateLinkResources/get/RedisEnterpriseListPrivateLinkResources
      cmderr	[Autorest]     - name: /RedisEnterprise/put/RedisEnterpriseCreate
      cmderr	[Autorest]     - name: /RedisEnterprise/get/RedisEnterpriseGet
      cmderr	[Autorest]     - name: /RedisEnterprise/get/RedisEnterpriseList
      cmderr	[Autorest]     - name: /RedisEnterprise/get/RedisEnterpriseListByResourceGroup
      cmderr	[Autorest]     - name: /RedisEnterprise/patch/RedisEnterpriseUpdate
      cmderr	[Autorest]     - name: /RedisEnterprise/delete/RedisEnterpriseDelete
      cmderr	[Autorest] --------------------------------------------------------
    • ️✔️redisenterprise [View full logs]  [Release Azure CLI Changes]
    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @markcowl
    Copy link
    Member

    @greenms Can merge once the checks pass

    @greenms
    Copy link
    Contributor Author

    greenms commented Feb 10, 2021

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    Copy link
    Member

    @TimLovellSmith TimLovellSmith left a comment

    Choose a reason for hiding this comment

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

    LGTM except maybe the TLS enum question

    @TimLovellSmith
    Copy link
    Member

    @markcowl I don't understand the way azure-cli-extensions and azure-sdk-for-python-track2 are failing, any insights?

    @greenms
    Copy link
    Contributor Author

    greenms commented Feb 11, 2021

    Thanks Tim. I also just sent out email requests for help on the Python Track2 failure (sent to @jsntcy and Yuchao Yan) and the Azure CLI failure (sent to @achandmsft and [email protected])

    @greenms
    Copy link
    Contributor Author

    greenms commented Feb 11, 2021

    Identified an issue in the setup instructions for Azure CLI: Azure/autorest.az#744

    @greenms
    Copy link
    Contributor Author

    greenms commented Feb 11, 2021

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @greenms
    Copy link
    Contributor Author

    greenms commented Feb 11, 2021

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @greenms
    Copy link
    Contributor Author

    greenms commented Feb 11, 2021

    /azp run

    @greenms
    Copy link
    Contributor Author

    greenms commented Feb 11, 2021

    @markcowl @ArcturusZhang I believe I verified that without any of these readme file changes, the Python Track2 code generation will still fail with the 'pass-thru' TypeError message. You can see in this Draft PR that I introduce some harmless whitespace to trigger the SDK automation pipeline to run, and that the Python Track2 code gen fails with the same error: #12962

    Can I please get this PR merged even with the failing check, due to it not being caused by anything I'm changing in this PR? Thanks.

    @markcowl
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @openapi-workflow-bot
    Copy link

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

    @greenms
    Copy link
    Contributor Author

    greenms commented Feb 16, 2021

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @markcowl
    Copy link
    Member

    @markcowl markcowl closed this Feb 17, 2021
    @markcowl markcowl reopened this Feb 17, 2021
    @markcowl
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @markcowl
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @markcowl
    Copy link
    Member

    The latest results are here: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=737104&view=results

    Unsure why the failure is occurring, but it may be due to this being a readme-only change. Once the other checks pass, an admin can merge this, however.

    @allenjzhang allenjzhang merged commit 8228416 into Azure:master Feb 17, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    …urce Manager Schema (Azure#12943)
    
    * Update readme files for csharp, az cli, and azureresourceschema
    
    * Fix spelling mistake
    
    * Fix bug from issue 744
    
    * Add newline to end of readme files
    
    * First round of updates for Azure CLI code generation
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants