Skip to content

Conversation

@gorandom
Copy link
Contributor

@gorandom gorandom commented Aug 23, 2022

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 23, 2022

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
compared swaggers (via Oad v0.9.7)] new version base version
redis.json 2022-05-01(ef204b4) 2022-05-01(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-2022-05 package-2022-05(ef204b4) package-2022-05(main)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule Message
R3021 - PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability'
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L73
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2425
R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.Cache/operations' does not match the ARM specification. Please standardize the schema.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L37
R4037 - MissingTypeObject The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L1856
R4037 - MissingTypeObject The schema 'RedisCommonProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L1896
R4037 - MissingTypeObject The schema 'RedisCreateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2033
R4037 - MissingTypeObject The schema 'RedisUpdateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2065
R4037 - MissingTypeObject The schema 'RedisProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2080
R4037 - MissingTypeObject The schema 'RedisCreateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2163
R4037 - MissingTypeObject The schema 'RedisUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2203
R4037 - MissingTypeObject The schema 'RedisAccessKeys' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2224
R4037 - MissingTypeObject The schema 'RedisFirewallRule' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2239
R4037 - MissingTypeObject The schema 'RedisFirewallRuleProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2265
R4037 - MissingTypeObject The schema 'RedisFirewallRuleListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2282
R4037 - MissingTypeObject The schema 'RedisResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2299
R4037 - MissingTypeObject The schema 'RedisInstanceDetails' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2328
R4037 - MissingTypeObject The schema 'RedisListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2366
R4037 - MissingTypeObject The schema 'RedisRegenerateKeyParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2383
R4037 - MissingTypeObject The schema 'RedisRebootParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2403
R4037 - MissingTypeObject The schema 'ExportRDBParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2433
R4037 - MissingTypeObject The schema 'ImportRDBParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2458
R4037 - MissingTypeObject The schema 'ScheduleEntry' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2481
R4037 - MissingTypeObject The schema 'ScheduleEntries' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2519
R4037 - MissingTypeObject The schema 'RedisPatchSchedule' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2536
R4037 - MissingTypeObject The schema 'RedisPatchScheduleListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2559
R4037 - MissingTypeObject The schema 'RedisForceRebootResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2576
R4037 - MissingTypeObject The schema 'RedisLinkedServer' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2586
R4037 - MissingTypeObject The schema 'RedisLinkedServerWithProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2596
R4037 - MissingTypeObject The schema 'RedisLinkedServerProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2611
R4037 - MissingTypeObject The schema 'RedisLinkedServerWithPropertiesList' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2626
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️⚠️~[Staging] TrafficValidation: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️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 succeeded [Detail]
  • The following tags are being changed in this PR
    • "https://github.com/Azure/azure-rest-api-specs/blob/ef204b4833ad3c434636173416347c9cfa17c8fd/specification/redis/resource-manager/readme.md#tag-package-2022-05">redis/resource-manager/readme.md#package-2022-05
The following errors/warnings exist before current PR submission:
Rule Message
PreCheck/DuplicateSchema "readme":"redis/resource-manager/readme.md",
"tag":"package-2022-05",
"details":"Duplicate Schema named 'ErrorDetail' (1 differences):\n - properties.details.$ref: "#/components/schemas/schemas:249" => "#/components/schemas/schemas:461"; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
"readme":"redis/resource-manager/readme.md",
"tag":"package-2022-05",
"details":"Error: 1 errors occured -- cannot continue."
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @gorandom 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 Aug 23, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-go - armredis - 2.0.0
    +	Function `*Client.Update` has been removed
    +	Function `*LinkedServerClient.Delete` has been removed
    +	Struct `ClientUpdateOptions` has been removed
    +	Struct `LinkedServerClientDeleteOptions` has been removed

    azure-sdk-for-js - @azure/arm-rediscache - Approved - 8.0.0
    +	Operation PatchSchedules.createOrUpdate has a new signature
    azure-sdk-for-go - sdk/resourcemanager/redis/armredis - 3.0.0
    +	Struct `CommonProperties` has been removed
    +	Struct `CreateProperties` has been removed
    +	Struct `OperationStatus` has been removed
    +	Struct `Properties` has been removed
    +	Struct `UpdateProperties` has been removed
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8483187. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
      command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    • ️✔️Azure.ResourceManager.Redis [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8483187. 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
    • ️✔️track2_azure-mgmt-redis [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 8483187. 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
    • ️✔️sdk/resourcemanager/redis/armredis [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Struct `CommonProperties` has been removed
      info	[Changelog] - Struct `CreateProperties` has been removed
      info	[Changelog] - Struct `OperationStatus` has been removed
      info	[Changelog] - Struct `Properties` has been removed
      info	[Changelog] - Struct `UpdateProperties` has been removed
      info	[Changelog]
      info	[Changelog] Total 10 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8483187. 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-rediscache [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Operation PatchSchedules.createOrUpdate has a new signature
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8483187. 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
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8483187. 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.Redis [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 23, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/redis/armredis Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Python track2_azure-mgmt-redis Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Java azure-resourcemanager-redis-generated Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    .Net Azure.ResourceManager.Redis Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    JavaScript @azure/arm-rediscache Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @ghost ghost added the Redis Cache label Aug 23, 2022
    @gorandom gorandom marked this pull request as ready for review August 25, 2022 10:21
    @TimLovellSmith
    Copy link
    Member

    @honghr The breaking changes getting flagged here don't seem to be caused in the commits that are part of PR. Do you know whether these breaking changes errors should be addressed here or not?

    @ArcturusZhang
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @TimLovellSmith
    Copy link
    Member

    TimLovellSmith commented Sep 8, 2022

    "ResourceType 'redis' should be deployed in 'West Central US' on apiVersion '2022-05-01'.: expected [ Array(21) ] to satisfy [Function]"

    I think this api-version should be already deployed. At the very least, they are in the checked in manifest file.
    I saw a similar tooling failure for a different version, on the same region, in another Cache PR today that also seemed 'strange'. Is there some tooling bug here? Or was West Central US down?

    @TimLovellSmith
    Copy link
    Member

    @honghr I don't think the go breaking changes errors can be caused by this PR. Are they caused by go SDK?

    @gorandom
    Copy link
    Contributor Author

    @honghr Can you check and merge this PR?

    @ArcturusZhang
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @honghr honghr merged commit 8483187 into Azure:main Sep 29, 2022
    @ArcturusZhang ArcturusZhang added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Sep 29, 2022
    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.

    6 participants