Update READMEs. #14501

tjprescott · 2021-05-20T16:31:09Z

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.

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
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
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:

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

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
- Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
- 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 · 2021-05-20T16:31:12Z

Hi, @tjprescott 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 · 2021-05-20T16:31:13Z

[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 · 2021-05-20T16:31:13Z

Swagger Validation Report

️🔄BreakingChange inProgress [Detail]

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️🔄Avocado inProgress [Detail]

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

️⌛CredScan pending [Detail]

️🔄[Staging] SDK Track2 Validation inProgress [Detail]

️️✔️[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 · 2021-05-20T16:31:14Z

Swagger Generation Artifacts

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

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

Breaking Changes Tracking

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

⚠️Warning [Logs]Release - Generate from f97d1d9. 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-vision-computervision [View full logs] [Release SDK Changes]
- azure-cognitiveservices-vision-computervision-0.6.0.zip
- azure_cognitiveservices_vision_computervision-0.6.0-py2.py3-none-any.whl
```
info	[Changelog]
```

️✔️azure-cognitiveservices-personalizer [View full logs] [Release SDK Changes]

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation group PolicyOperations
info	[Changelog]   - Added operation group EvaluationOperations
info	[Changelog]   - Added operation group LogOperations
info	[Changelog]   - Added operation group MultiSlotEventsOperations
info	[Changelog]   - Added operation group ModelOperations
info	[Changelog]   - Added operation group PersonalizerClientv11Preview1OperationsMixin
info	[Changelog]   - Added operation group MultiSlotOperations
info	[Changelog]   - Added operation group EvaluationsOperations
info	[Changelog]   - Added operation group ServiceConfigurationOperations

️✔️azure-servicefabric [View full logs] [Release SDK Changes]
- azure_servicefabric-7.1.0.45-py2.py3-none-any.whl
- azure-servicefabric-7.1.0.45.zip
```
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from f97d1d9. 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] 2021-06-08 17:16:39 ERROR [Skip] readme path does not format as specification/*/resource-manager/readme.md
warn	No file changes detected after generation
warn	No package detected after generation

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

❌Failed [Logs]Release - Generate from f97d1d9. 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
cmderr	[generator automation] [ERROR] total 6 error(s):
cmderr	[generator automation] [ERROR] failed to parse metadata in '/home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172610/"6.2"': total 1 error(s) during processing metadata /home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172610/"6.2": [open /home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172610/"6.2": no such file or directory]
cmderr	[generator automation] [ERROR] failed to parse metadata in '/home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172687/"6.3"': total 1 error(s) during processing metadata /home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172687/"6.3": [open /home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172687/"6.3": no such file or directory]
cmderr	[generator automation] [ERROR] failed to parse metadata in '/home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172774/"6.4"': total 1 error(s) during processing metadata /home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172774/"6.4": [open /home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172774/"6.4": no such file or directory]
cmderr	[generator automation] [ERROR] failed to parse metadata in '/home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172873/"6.5"': total 1 error(s) during processing metadata /home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172873/"6.5": [open /home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172873/"6.5": no such file or directory]
cmderr	[generator automation] [ERROR] failed to parse metadata in '/home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172977/"7.0"': total 1 error(s) during processing metadata /home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172977/"7.0": [open /home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623172977/"7.0": no such file or directory]
cmderr	[generator automation] [ERROR] failed to parse metadata in '/home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623173086/"7.2"': total 1 error(s) during processing metadata /home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623173086/"7.2": [open /home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1623173086/"7.2": no such file or directory]
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation
warn	Skip package processing as generation is failed

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

❌Failed [Logs]Release - Generate from f97d1d9. 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.6.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/ComputerVision/readme.md
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.6.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
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.6.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/servicefabric/data-plane/readme.md

❌@azure/cognitiveservices-computervision [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-computervision]: npm pack --silent

❌@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

️✔️@azure/servicefabric [View full logs] [Release SDK Changes]

azure-servicefabric-5.0.0.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/serviceFabricClient.js → ./dist/servicefabric.js...
cmderr	[npmPack] created ./dist/servicefabric.js in 1.1s

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

tjprescott · 2021-05-20T19:48:13Z

@jhendrixMSFT this is not a breaking change for Python. I don't know why the bot complains about this every time we do a README update.

tjprescott · 2021-06-03T19:41:57Z

@iscai-msft ping :)

iscai-msft · 2021-06-07T15:09:45Z

specification/cognitiveservices/data-plane/Personalizer/readme.python.md

-  no-namespace-folders: true
-  output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-personalizer/azure/cognitiveservices/personalizer
+no-namespace-folders: true
+clear-output-folder: false


nit: since false is default for clear-output-folder, you can just remove this line

I have run into situations where the default wasn't the default on older versions of autorest, so I think there's some value in being explicit here.

specification/cognitiveservices/data-plane/Personalizer/readme.python.md

openapi-pipeline-app · 2021-06-07T16:29:16Z

Swagger Validation Report

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

There are no breaking changes.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️️✔️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 succeeded [Detail] [Expand]

There are no breaking changes.

️🔄CredScan inProgress [Detail]

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

Validation passes for SDKTrack2Validation

️️✔️[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?}

* Readme Updates * Code review feedback.

Readme Updates

0fa1d14

tjprescott requested review from samedder and yangyuan as code owners May 20, 2021 16:31

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

openapi-pipeline-app bot added the CI-BreakingChange-Python label May 20, 2021

jhendrixMSFT requested a review from iscai-msft May 20, 2021 21:14

iscai-msft reviewed Jun 7, 2021

View reviewed changes

Code review feedback.

b2da280

iscai-msft approved these changes Jun 7, 2021

View reviewed changes

lmazuel merged commit f97d1d9 into master Jun 8, 2021

heaths mentioned this pull request Jun 16, 2021

Initial 2021-05-01-preview version #14855

Merged

asager pushed a commit to asager/azure-rest-api-specs that referenced this pull request Jun 24, 2021

Update READMEs. (Azure#14501)

0f08a0e

* Readme Updates * Code review feedback.

mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021

Update READMEs. (Azure#14501)

707984f

* Readme Updates * Code review feedback.

JackTn deleted the ReadmeUpdates branch June 16, 2022 00:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update READMEs. #14501

Update READMEs. #14501

tjprescott commented May 20, 2021

openapi-workflow-bot bot commented May 20, 2021

openapi-workflow-bot bot commented May 20, 2021

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

edited

Loading

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

edited

Loading

Breaking Changes Tracking

tjprescott commented May 20, 2021

tjprescott commented Jun 3, 2021

iscai-msft Jun 7, 2021

tjprescott Jun 7, 2021

openapi-pipeline-app bot commented Jun 7, 2021 •

edited

Loading

Update READMEs. #14501

Update READMEs. #14501

Conversation

tjprescott commented May 20, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented May 20, 2021

openapi-workflow-bot bot commented May 20, 2021

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

Swagger Validation Report

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

Swagger Generation Artifacts

Breaking Changes Tracking

tjprescott commented May 20, 2021

tjprescott commented Jun 3, 2021

iscai-msft Jun 7, 2021

Choose a reason for hiding this comment

tjprescott Jun 7, 2021

Choose a reason for hiding this comment

openapi-pipeline-app bot commented Jun 7, 2021 • edited Loading

Swagger Validation Report

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

edited

Loading

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

edited

Loading

openapi-pipeline-app bot commented Jun 7, 2021 •

edited

Loading