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

Swagger correctness fix: add location property to RedisPatchSchedule … #17699

Merged

Conversation

koderjoker
Copy link
Member

@koderjoker koderjoker commented Feb 8, 2022

…and update response examples

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 langauge 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 apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • 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.

@koderjoker koderjoker added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Feb 8, 2022
@openapi-workflow-bot
Copy link

Hi, @koderjoker 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 8, 2022

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    1045 - AddedOptionalProperty The new version has a new optional property 'location' that was not found in the old version.
    New: Microsoft.Cache/stable/2020-12-01/redis.json#L2423:7
    Old: Microsoft.Cache/stable/2020-12-01/redis.json#L2423:7
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    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/2020-12-01/redis.json#L68
    R4009 - RequiredReadOnlySystemData The response of operation:'Redis_Create' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L172
    R4009 - RequiredReadOnlySystemData The response of operation:'Redis_Update' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L236
    R4009 - RequiredReadOnlySystemData The response of operation:'Redis_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L345
    R4009 - RequiredReadOnlySystemData The response of operation:'FirewallRules_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L828
    R4009 - RequiredReadOnlySystemData The response of operation:'FirewallRules_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L899
    R4009 - RequiredReadOnlySystemData The response of operation:'PatchSchedules_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1067
    R4009 - RequiredReadOnlySystemData The response of operation:'PatchSchedules_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1208
    R4009 - RequiredReadOnlySystemData The response of operation:'LinkedServer_Create' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1273
    R4009 - RequiredReadOnlySystemData The response of operation:'LinkedServer_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1399
    R4009 - RequiredReadOnlySystemData The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1562
    R4009 - RequiredReadOnlySystemData The response of operation:'PrivateEndpointConnections_Put' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1613
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2320
    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/2020-12-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/2020-12-01/redis.json#L1781
    R4037 - MissingTypeObject The schema 'RedisCommonProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1821
    R4037 - MissingTypeObject The schema 'RedisCreateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1943
    R4037 - MissingTypeObject The schema 'RedisUpdateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1975
    R4037 - MissingTypeObject The schema 'RedisProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1990
    R4037 - MissingTypeObject The schema 'RedisCreateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2070
    R4037 - MissingTypeObject The schema 'RedisUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2106
    R4037 - MissingTypeObject The schema 'RedisAccessKeys' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2123
    R4037 - MissingTypeObject The schema 'RedisFirewallRule' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2138
    R4037 - MissingTypeObject The schema 'RedisFirewallRuleProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2164
    R4037 - MissingTypeObject The schema 'RedisFirewallRuleListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2181
    R4037 - MissingTypeObject The schema 'RedisResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2198
    R4037 - MissingTypeObject The schema 'RedisInstanceDetails' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2223
    R4037 - MissingTypeObject The schema 'RedisListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2261
    R4037 - MissingTypeObject The schema 'RedisRegenerateKeyParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2278
    R4037 - MissingTypeObject The schema 'RedisRebootParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2298
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Operations_List.
    Url: Microsoft.Cache/stable/2020-12-01/redis.json#L38:14
    ️️✔️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.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️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).
    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 Feb 8, 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-track2 - armredis - 0.4.0
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-redis - 13.1.0
    azure-sdk-for-go - redis/mgmt/2020-12-01/redis - v61.5.0
    +	Type of `CommonProperties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
    +	Type of `CreateProperties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
    +	Type of `Properties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
    +	Type of `UpdateProperties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
    azure-sdk-for-go - redis/mgmt/2020-06-01/redis - v61.5.0
    +	Type of `CommonProperties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
    +	Type of `CreateProperties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
    +	Type of `Properties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
    +	Type of `UpdateProperties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
    ️✔️azure-sdk-for-go - redis/mgmt/2018-03-01/redis - v61.5.0
    ️✔️azure-sdk-for-go - redis/mgmt/2017-10-01/redis - v61.5.0
    ️✔️azure-sdk-for-go - redis/mgmt/2017-02-01/redis - v61.5.0
    ️✔️azure-sdk-for-go - redis/mgmt/2016-04-01/redis - v61.5.0
    ️✔️azure-sdk-for-go - redis/mgmt/2015-08-01/redis - v61.5.0
    ️✔️azure-sdk-for-go - preview/redis/mgmt/2019-07-01-preview/redis - v61.5.0
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 9f57630. 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=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/redis/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] ERROR: Schema violation: Additional properties not allowed: x-ms-identifiers
      cmderr	[Autorest]     - file:///home/vsts/work/1/s/azure-rest-api-specs/specification/common-types/resource-management/v2/types.json:316:8 ($.definitions.ErrorDetail.properties.additionalInfo)
      cmderr	[Autorest] ERROR: Schema violation: Additional properties not allowed: x-ms-identifiers
      cmderr	[Autorest]     - file:///home/vsts/work/1/s/azure-rest-api-specs/specification/common-types/resource-management/v2/types.json:304:8 ($.definitions.ErrorDetail.properties.details)
      cmderr	[Autorest] FATAL: swagger-document/individual/schema-validator - FAILED
      cmderr	[Autorest] FATAL: Error: [OperationAbortedException] Error occurred. Exiting.
      cmderr	[Autorest] Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.
      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-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9f57630. 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]
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.1.2 -> 8.5.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.5.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.5.0` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-redis [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model RedisCommonPropertiesRedisConfiguration has a new parameter zonal_configuration
      info	[Changelog]   - Model RedisPatchSchedule has a new parameter location
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9f57630. 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] 2022-02-15 07:15:42 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-redis-generated"
      cmderr	[generate.py] 2022-02-15 07:15:42 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2022-02-15 07:15:42 INFO autorest --version=3.6.6 --use=@autorest/java@4.0.50 --java --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/redis/azure-resourcemanager-redis-generated --java.namespace=com.azure.resourcemanager.redis.generated   --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --generate-samples --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL  ../azure-rest-api-specs/specification/redis/resource-manager/readme.md
      cmderr	[generate.py] 2022-02-15 07:16:18 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2022-02-15 07:16:18 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2022-02-15 07:16:18 INFO [POM][Skip] pom already has module azure-resourcemanager-redis-generated
      cmderr	[generate.py] 2022-02-15 07:16:18 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2022-02-15 07:16:18 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2022-02-15 07:16:18 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-redis-generated [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2022-02-15 07:17:20 DEBUG Got artifact_id: azure-resourcemanager-redis-generated
      cmderr	[Inst] 2022-02-15 07:17:20 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2022-02-15 07:17:20 DEBUG Got artifact: azure-resourcemanager-redis-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2022-02-15 07:17:20 DEBUG Match jar package: azure-resourcemanager-redis-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2022-02-15 07:17:20 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/17699/azure-sdk-for-java/azure-resourcemanager-redis-generated/azure-resourcemanager-redis-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-redis-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-redis-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-redis-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9f57630. SDK Automation 14.0.0
      command	sh ./eng/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
    • ️✔️redis/mgmt/2020-12-01/redis [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `Properties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
      info	[Changelog] - Type of `CommonProperties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
      info	[Changelog] - Type of `CreateProperties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
      info	[Changelog] - Type of `UpdateProperties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `*CommonPropertiesRedisConfiguration.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `CommonPropertiesRedisConfiguration.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New struct `CommonPropertiesRedisConfiguration`
      info	[Changelog] - New field `Location` in struct `PatchSchedule`
      info	[Changelog]
      info	[Changelog] Total 4 breaking change(s), 5 additive change(s).
    • ️✔️redis/mgmt/2020-06-01/redis [View full logs
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `CreateProperties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
      info	[Changelog] - Type of `Properties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
      info	[Changelog] - Type of `CommonProperties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
      info	[Changelog] - Type of `UpdateProperties.RedisConfiguration` has been changed from `map[string]*string` to `*CommonPropertiesRedisConfiguration`
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `CommonPropertiesRedisConfiguration.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `*CommonPropertiesRedisConfiguration.UnmarshalJSON([]byte) error`
      info	[Changelog] - New struct `CommonPropertiesRedisConfiguration`
      info	[Changelog]
      info	[Changelog] Total 4 breaking change(s), 4 additive change(s).
    • ️✔️redis/mgmt/2018-03-01/redis [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️redis/mgmt/2017-10-01/redis [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️redis/mgmt/2017-02-01/redis [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️redis/mgmt/2016-04-01/redis [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️redis/mgmt/2015-08-01/redis [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️preview/redis/mgmt/2019-07-01-preview/redis [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9f57630. 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
    • ️✔️armredis [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New field `Location` in struct `PatchSchedule`
      info	[Changelog] - New field `ZonalConfiguration` in struct `CommonPropertiesRedisConfiguration`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 2 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9f57630. 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
      cmderr	[automation_init.sh]  read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh] deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] notice created a lockfile as package-lock.json. You should commit this file.
      cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      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
    • ️✔️track2_@azure/arm-rediscache [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Interface ManagedServiceIdentity
      info	[Changelog]   - Added Interface UserAssignedIdentity
      info	[Changelog]   - Added Type Alias ManagedServiceIdentityType
      info	[Changelog]   - Interface RedisCommonPropertiesRedisConfiguration has a new optional parameter preferredDataArchiveAuthMethod
      info	[Changelog]   - Interface RedisCommonPropertiesRedisConfiguration has a new optional parameter preferredDataPersistenceAuthMethod
      info	[Changelog]   - Interface RedisCommonPropertiesRedisConfiguration has a new optional parameter zonalConfiguration
      info	[Changelog]   - Interface RedisCreateParameters has a new optional parameter identity
      info	[Changelog]   - Interface RedisUpdateParameters has a new optional parameter identity
      info	[Changelog]   - Type Alias RedisPatchSchedule has a new parameter location
      info	[Changelog]   - Type Alias RedisResource has a new parameter identity
      info	[Changelog]   - Added Enum KnownManagedServiceIdentityType
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9f57630. 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
    • ️✔️redis [View full logs
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @openapi-workflow-bot
    Copy link

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

    @koderjoker koderjoker force-pushed the kjdev-redis-Microsoft.Cache-2020-12-01 branch from e85ea3e to ed429fc Compare February 8, 2022 04:45
    @koderjoker koderjoker marked this pull request as ready for review February 8, 2022 06:38
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 11, 2022
    @koderjoker
    Copy link
    Member Author

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @koderjoker
    Copy link
    Member Author

    @msyyc just like #17687, the section for which required checks for Model Validation are failing aren't part of the changes in my PR. The same issue occurred in a previous PR as well #17447, but in that case it wasn't marked as required.

    Could you please ignore the failing required check 'Swagger ModelValidation' and merge in my pull request? We've got the breaking change label and need to urgently merge in this change to meet the deadline for swagger issues. This failing check could be resolved later in another PR.

    @koderjoker koderjoker removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label Feb 15, 2022
    @akning-ms akning-ms merged commit 9f57630 into Azure:main Feb 15, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-ModelValidation CI-FixRequiredOnFailure FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants