Add personalizer v1.1-preview.1 swagger for SDK #14289

ormichae · 2021-05-06T19:44:31Z

Purpose of the update is to generate an SDK for a new Personalizer API version (v1.1preview.1)
Will be offered in public preview starting after Build
We will publish the swagger before the build conference

openapi-workflow-bot · 2021-05-06T19:44:33Z

Hi, @ormichae 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 · 2021-05-06T19:44:34Z

Swagger Validation Report

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

There are no breaking changes.

️⚠️LintDiff: 2 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- data-plane/Personalizer/readme.md tag:release_1_1_preview.1
Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- data-plane/Personalizer/readme.md tag:default

The following errors/warnings are introduced by current PR:

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 'EvaluationModel'. Consider using the plural form of 'Evaluation' 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.1/Personalizer.json#L184
⚠️ R4000 - ParameterDescriptionRequired	'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Personalizer/preview/v1.1-preview.1/Personalizer.json#L192

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.1/Personalizer.json#L21
⚠️ 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.1/Personalizer.json#L65

️️✔️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 BreakingChange (Base on preview version): 1 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.9)
- original: preview/v1.0/Personalizer.json <---> new: preview/v1.1-preview.1/Personalizer.json

Rule	Message
`❌` 1037 - ConstraintIsWeaker	The new version has a less constraining 'enum' value than the previous one. New: Personalizer/preview/v1.1-preview.1/Personalizer.json#L954:9 Old: Personalizer/preview/v1.0/Personalizer.json#L163:9

️❌Cross Version BreakingChange (Base on stable version): 2 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.9)
- original: stable/v1.0/Personalizer.json <---> new: preview/v1.1-preview.1/Personalizer.json

Rule	Message
`❌` 1037 - ConstraintIsWeaker	The new version has a less constraining 'enum' value than the previous one. New: Personalizer/preview/v1.1-preview.1/Personalizer.json#L954:9 Old: Personalizer/stable/v1.0/Personalizer.json#L694:9
`❌` 1037 - ConstraintIsWeaker	The new version has a less constraining 'enum' value than the previous one. New: Personalizer/preview/v1.1-preview.1/Personalizer.json#L1353:9 Old: Personalizer/stable/v1.0/Personalizer.json#L878: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.1

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.1",
"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.1",
"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.1",
"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.

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

openapi-workflow-bot · 2021-05-06T19:44:34Z

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

ghost · 2021-05-06T19:44:35Z

Thank you for your contribution ormichae! We will review the pull request and get back to you soon.

openapi-pipeline-app · 2021-05-06T19:44:35Z

Swagger Generation Artifacts

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 1f66f14. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️personalizer/v1.0/personalizer [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

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

⚠️Warning [Logs]Release - Generate from 1f66f14. 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.2.2 requires azure-core<2.0.0,>=1.9.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.2.2 requires azure-core<2.0.0,>=1.9.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]

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation group EvaluationsOperations
info	[Changelog]   - Added operation group ModelOperations
info	[Changelog]   - Added operation group ServiceConfigurationOperations
info	[Changelog]   - Added operation group PersonalizerClientOperationsMixin
info	[Changelog]   - Added operation group LogOperations
info	[Changelog]   - Added operation group PolicyOperations

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 1f66f14. 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.4.4 --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]

azure-cognitiveservices-personalizer-2.0.1.tgz

cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/personalizerClient.js → ./dist/cognitiveservices-personalizer.js...
cmderr	[npmPack] created ./dist/cognitiveservices-personalizer.js in 265ms

️❌[Staging] ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` RestBuild error	"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=214333&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 "

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

openapi-workflow-bot · 2021-05-06T19:46:27Z

Hi @ormichae, 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 · 2021-05-07T22:14:47Z

@PhoenixHe-msft I think the ConstraintIsWeaker failure is a false-positive. I'm not sure who owns this tool, can you please route?

PhoenixHe-NV · 2021-05-09T01:17:06Z

@jianyexi to confirm the cross api breaking change result.

jianyexi · 2021-05-09T11:45:36Z

@jianyexi Jianye Xi FTE to confirm the cross api breaking change result.

This is allowed in new api version, please ignore it.

jhendrixMSFT · 2021-05-10T15:03:07Z

@jianyexi are you saying this isn't a false positive? If so, can you please update the wiki with a description for this case as it's not clear why this specific change was flagged.

* added swagger and examples for personalizer v1.1 preview * moved folder * added new version to readme * prettier changes * fixed breaking changes * removed custom words * changed endpoint name * prettier * custom word * custom words Co-authored-by: orenmichaely <35842001+orenmichaely@users.noreply.github.com>

ormichae added 2 commits May 6, 2021 12:28

added swagger and examples for personalizer v1.1 preview

c79fc86

moved folder

639a828

ormichae requested a review from yangyuan as a code owner May 6, 2021 19:44

ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label May 6, 2021

openapi-assignment-bot bot assigned jhendrixMSFT May 6, 2021

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label May 6, 2021

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label May 6, 2021

ormichae changed the title ~~Addpersonalizerv1point1swagger~~ Add personalizer v1.1-preview.1 swagger for SDK May 6, 2021

added new version to readme

c026766

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels May 6, 2021

prettier changes

8b38218

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels May 6, 2021

fixed breaking changes

512b530

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label May 7, 2021

removed custom words

ebe6fc2

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label May 7, 2021

changed endpoint name

998da83

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels May 7, 2021

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label May 7, 2021

prettier

571a33c

sharathmalladi approved these changes May 7, 2021

View reviewed changes

orenmichaely added 2 commits May 7, 2021 15:57

custom word

6ac65ba

custom words

e1f6ff3

jhendrixMSFT approved these changes May 10, 2021

View reviewed changes

jhendrixMSFT merged commit 1f66f14 into Azure:master May 10, 2021

orenmichaely mentioned this pull request May 24, 2021

Addpersonalizerv1point1swagger #14533

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add personalizer v1.1-preview.1 swagger for SDK #14289

Add personalizer v1.1-preview.1 swagger for SDK #14289

ormichae commented May 6, 2021

openapi-workflow-bot bot commented May 6, 2021

openapi-pipeline-app bot commented May 6, 2021 •

edited

Loading

openapi-workflow-bot bot commented May 6, 2021

ghost commented May 6, 2021

openapi-pipeline-app bot commented May 6, 2021 •

edited

Loading

openapi-workflow-bot bot commented May 6, 2021

jhendrixMSFT commented May 7, 2021

PhoenixHe-NV commented May 9, 2021

jianyexi commented May 9, 2021

jhendrixMSFT commented May 10, 2021

Add personalizer v1.1-preview.1 swagger for SDK #14289

Add personalizer v1.1-preview.1 swagger for SDK #14289

Conversation

ormichae commented May 6, 2021

openapi-workflow-bot bot commented May 6, 2021

openapi-pipeline-app bot commented May 6, 2021 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented May 6, 2021

ghost commented May 6, 2021

openapi-pipeline-app bot commented May 6, 2021 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented May 6, 2021

jhendrixMSFT commented May 7, 2021

PhoenixHe-NV commented May 9, 2021

jianyexi commented May 9, 2021

jhendrixMSFT commented May 10, 2021

openapi-pipeline-app bot commented May 6, 2021 •

edited

Loading

openapi-pipeline-app bot commented May 6, 2021 •

edited

Loading