[Cognitive Services - Personalizer] v1.1-preview.2

[slahabar]

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. Sept 2021
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. Sept 2021
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:

• I commit to follow the Breaking Change Policy of "no breaking changes"
• I have reviewed the documentation for the workflow.
• Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.

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

Hi, @slahabar 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-workflow-bot]

[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]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️LintDiff: 0 Warnings warning [Detail]

• Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
  • data-plane/Personalizer/readme.md tag:release_1_1_preview.2
• Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
  • data-plane/Personalizer/readme.md tag:default

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ServiceConfigurationModel'. Consider using the plural form of 'ServiceConfiguration' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Personalizer/preview/v1.1-preview.2/Personalizer.json#L20
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ServiceConfigurationModel'. Consider using the plural form of 'ServiceConfiguration' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Personalizer/preview/v1.1-preview.2/Personalizer.json#L46
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ServiceConfigurationModel'. Consider using the plural form of 'ServiceConfiguration' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Personalizer/preview/v1.1-preview.2/Personalizer.json#L434

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️⚠️Cross-Version Breaking Changes: 2 Warnings warning [Detail]

• Compared Swaggers (Based on Oad v0.9.0)
  • current:preview/v1.1-preview.2/Personalizer.json compared with base:stable/v1.0/Personalizer.json
  • current:preview/v1.1-preview.2/Personalizer.json compared with base:preview/v1.1-preview.1/Personalizer.json

The following breaking changes are detected by comparison with the latest stable version:

Rule	Message
⚠️ 1026 - TypeChanged	The new version has a different type 'object' than the previous one ''. New: Personalizer/preview/v1.1-preview.2/Personalizer.json#L1368:9 Old: Personalizer/stable/v1.0/Personalizer.json#L927:9
⚠️ 1026 - TypeChanged	The new version has a different type 'object' than the previous one ''. New: Personalizer/preview/v1.1-preview.2/Personalizer.json#L1515:9 Old: Personalizer/stable/v1.0/Personalizer.json#L1036:9

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

• The following tags are being changed in this PR
• cognitiveservices/data-plane/Personalizer/readme.md#release_1_1_preview.2

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Personalizer/readme.md",
"tag":"release_1_1_preview.2",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Personalizer/readme.md",
"tag":"release_1_1_preview.2",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Personalizer/readme.md",
"tag":"release_1_1_preview.2",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account. 

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

Breaking Changes Tracking

️✔️azure-sdk-for-go - personalizer/v1.0/personalizer - v57.1.0

️⚠️ azure-sdk-for-python warning [Detail]

• ⚠️Warning [Logs]Release - Generate from a2ff0f7. SDK Automation 14.0.0

  command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
  cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
  cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
  cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
  cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
  cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
  command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

• ️✔️azure-cognitiveservices-personalizer [View full logs]  [Release SDK Changes]
  • azure_cognitiveservices_personalizer-0.1.0-py2.py3-none-any.whl
  • azure-cognitiveservices-personalizer-0.1.0.zip

  info	[Changelog] data-plan skip changelog generation temporarily

️⚠️ azure-sdk-for-go warning [Detail]

• ⚠️Warning [Logs]Release - Generate from a2ff0f7. SDK Automation 14.0.0

  command	sh ./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
  cmderr	[generator automation] [WARNING] line in batch '' does not starts with 'tags', ignore

• ️✔️personalizer/v1.0/personalizer [View full logs]  [Release SDK Changes]

  info	[Changelog] No exported changes

️❌ azure-sdk-for-js failed [Detail]

• ❌Failed [Logs]Release - Generate from a2ff0f7. SDK Automation 14.0.0

  warn	Skip initScript due to not configured
  command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/cognitiveservices/data-plane/Personalizer/readme.md

• ❌@azure/cognitiveservices-personalizer [View full logs]  [Release SDK Changes]

  error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js/azure-sdk-for-js/sdk/cognitiveservices/cognitiveservices-personalizer]: npm pack --silent

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-workflow-bot]

Hi @slahabar, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

[jhendrixMSFT]

Can you please fix the model validation, avocado, and prettier CI failures.

[slahabar]

@jhendrixMSFT @yangyuan
Fixed the Avocado, Prettier, Lint, Model validation checks.

There is one failure still showing up. Is this required to pass?
SDK azure-sdk-for-js Failing after 1m — SDK azure-sdk-for-js failed

[jhendrixMSFT]

The JS CI isn't required and can be ignored. @sarangan12 do you want to look into it?

[slahabar]

Can you please review and approve my PR? @jhendrixMSFT

[jhendrixMSFT]

@slahabar has this been reviewed by the arch board? From the review-requested label it appears the answer is no.

[sarangan12]

The JS CI isn't required and can be ignored. @sarangan12 do you want to look into it?

I am fine with override and merge.

[markweitzel]

@slahabar -- I've added a number of comments to this doc. Note that I didn't comment every occurrence of some issues, e.g. returning 204, so please make sure to double check them. If you have any questions, just let me know--happy to jump on a call or IM.

I'd also like some of the other team members to take a look at this as well once you make the next round of updates to make sure I didn't miss anything.

[slahabar]

@jhendrixMSFT - PR is signed off now. Can you please help with the merge?

[markweitzel]

Per the discussions captured in #15696 this has been reviewed and approved by the API Stewardship team