Fix the error in Api v3.1-preview.1 #10137

HanLiMS · 2020-07-14T23:43:46Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

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
- Adding a new service
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 API 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 version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

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

openapi-pipeline-app · 2020-07-14T23:43:49Z

[Staging] Swagger Validation Report

️❌BreakingChange: 7 Errors, 0 Warnings [Detail] [Expand]

Rule	Message
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'detectedLanguages' renamed or removed? New: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1285:7 Old: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1285:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'detectedLanguages' renamed or removed? New: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1285:7 Old: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1285:7
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'detectedLanguage' that was not found in the old version. New: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1285:7 Old: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1285:7
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'detectedLanguage' that was not found in the old version. New: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1258:11 Old: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1258:11
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'detectedLanguage' that was not found in the old version. New: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1285:7 Old: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1285:7
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'detectedLanguage' that was not found in the old version. New: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1278:5 Old: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1278:5
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'detectedLanguage' in response that was not found in the old version. New: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1285:7 Old: TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json#L1285:7

️️✔️LintDiff [Detail]

 Validation passes for LintDiff.

️️✔️Avocado [Detail]

 Validation passes for Avocado.

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

azure-pipelines · 2020-07-14T23:44:02Z

Azure Pipelines successfully started running 1 pipeline(s).

openapi-sdkautomation · 2020-07-14T23:45:23Z

azure-sdk-for-java - Release

⚠️ warning [Logs] [Expand Details]

⚠️ Generate from 1adebe2 with merge commit 38a485f. SDK Automation 13.0.17.20200619.4

Failed to find any changed packages. Please check the changed file list.
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/TextAnalyticsClient.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/implementation/TextAnalyticsClientImpl.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/implementation/package-info.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/DetectedLanguage.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/DocumentStatistics.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/EntitiesBatchResult.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/EntitiesBatchResultItem.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/EntityRecord.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/ErrorRecord.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/ErrorResponse.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/ErrorResponseException.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/InternalError.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/KeyPhraseBatchResult.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/KeyPhraseBatchResultItem.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/LanguageBatchInput.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/LanguageBatchResult.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/LanguageBatchResultItem.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/LanguageInput.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/MatchRecord.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/MultiLanguageBatchInput.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/MultiLanguageInput.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/RequestStatistics.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/SentimentBatchResult.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/SentimentBatchResultItem.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/models/package-info.java
/z/work/azure-sdk-for-java/cognitiveservices/data-plane/language/textanalytics/src/main/java/com/microsoft/azure/cognitiveservices/language/textanalytics/package-info.java

openapi-sdkautomation · 2020-07-14T23:45:25Z

Azure CLI Extension Generation - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

azure-pipelines · 2020-07-14T23:45:25Z

Azure Pipelines successfully started running 1 pipeline(s).

openapi-sdkautomation · 2020-07-14T23:45:26Z

azure-sdk-for-go - Release

️✔️ succeeded [Logs] [Expand Details]

️✔️ Generate from 1adebe2 with merge commit 38a485f. SDK Automation 13.0.17.20200619.4
️✔️cognitiveservices/v2.0 [View full logs] [Release SDK Changes]
- cognitiveservices.v2.0.zip
️✔️cognitiveservices/v2.1 [View full logs] [Release SDK Changes]
- cognitiveservices.v2.1.zip

openapi-sdkautomation · 2020-07-14T23:45:27Z

azure-sdk-for-net - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

openapi-sdkautomation · 2020-07-14T23:45:28Z

Trenton Generation - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

openapi-sdkautomation · 2020-07-14T23:45:29Z

azure-sdk-for-python - Release

️✔️ succeeded [Logs] [Expand Details]

️✔️ Generate from 1adebe2 with merge commit 38a485f. SDK Automation 13.0.17.20200619.4

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

[build_conf] INFO:packaging_tools:Building template azure-cognitiveservices-language-textanalytics
[build_conf] INFO:packaging_tools.conf:Skipping default conf since the file exists
[build_conf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
[build_conf] INFO:packaging_tools:Template done azure-cognitiveservices-language-textanalytics
[build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
[build_package]   warnings.warn(msg)
[build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
[build_package]   warnings.warn(msg)
[breaking_change_setup] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
[ChangeLog] Traceback (most recent call last):
[ChangeLog]   File "/usr/lib/python3.6/runpy.py", line 193, in _run_module_as_main
[ChangeLog]     "__main__", mod_spec)
[ChangeLog]   File "/usr/lib/python3.6/runpy.py", line 85, in _run_code
[ChangeLog]     exec(code, run_globals)
[ChangeLog]   File "/z/work/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/change_log.py", line 200, in 
[ChangeLog]     change_log = build_change_log(old_report, new_report)
[ChangeLog]   File "/z/work/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/change_log.py", line 147, in build_change_log
[ChangeLog]     change_log.operation(diff_line)
[ChangeLog]   File "/z/work/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/change_log.py", line 38, in operation
[ChangeLog]     _, operation_name, *remaining_path = path
[ChangeLog] ValueError: not enough values to unpack (expected at least 2, got 1)
[ChangeLog] Size of delta 7.210% size of original (original: 8641 chars, delta: 623 chars)

openapi-sdkautomation · 2020-07-14T23:45:31Z

azure-sdk-for-js - Release

️✔️ succeeded [Logs] [Expand Details]

️✔️ Generate from 1adebe2 with merge commit 38a485f. SDK Automation 13.0.17.20200619.4

️✔️@azure/cognitiveservices-textanalytics [View full logs] [Release SDK Changes]

azure-cognitiveservices-textanalytics-4.0.0.tgz

[npmPack] npm WARN deprecated rollup-plugin-node-resolve@5.2.0: This package has been deprecated and is no longer maintained. Please use @rollup/plugin-node-resolve.
[npmPack] npm WARN deprecated resolve-url@0.2.1: https://github.com/lydell/resolve-url#deprecated
[npmPack] npm WARN deprecated urix@0.1.0: Please see https://github.com/lydell/urix#deprecated
[npmPack] npm notice created a lockfile as package-lock.json. You should commit this file.
[npmPack] loaded rollup.config.js with warnings
[npmPack] (!) Unused external imports
[npmPack] default imported from external module 'rollup' but never used
[npmPack] 
[npmPack] ./esm/textAnalyticsClient.js → ./dist/cognitiveservices-textanalytics.js...
[npmPack] created ./dist/cognitiveservices-textanalytics.js in 190ms
[npmPack] npm notice 
[npmPack] npm notice package: @azure/cognitiveservices-textanalytics@4.0.0
[npmPack] npm notice === Tarball Contents === 
[npmPack] npm notice 32.5kB dist/cognitiveservices-textanalytics.js        
[npmPack] npm notice 10.6kB dist/cognitiveservices-textanalytics.min.js    
[npmPack] npm notice 345B   esm/models/index.js                            
[npmPack] npm notice 18.5kB esm/models/mappers.js                          
[npmPack] npm notice 803B   esm/models/parameters.js                       
[npmPack] npm notice 1.0kB  rollup.config.js                               
[npmPack] npm notice 4.6kB  esm/textAnalyticsClient.js                     
[npmPack] npm notice 2.0kB  esm/textAnalyticsClientContext.js              
[npmPack] npm notice 1.7kB  package.json                                   
[npmPack] npm notice 457B   tsconfig.json                                  
[npmPack] npm notice 67.1kB dist/cognitiveservices-textanalytics.js.map    
[npmPack] npm notice 9.5kB  dist/cognitiveservices-textanalytics.min.js.map
[npmPack] npm notice 5.1kB  esm/models/index.d.ts.map                      
[npmPack] npm notice 126B   esm/models/index.js.map                        
[npmPack] npm notice 1.1kB  esm/models/mappers.d.ts.map                    
[npmPack] npm notice 10.3kB esm/models/mappers.js.map                      
[npmPack] npm notice 255B   esm/models/parameters.d.ts.map                 
[npmPack] npm notice 508B   esm/models/parameters.js.map                   
[npmPack] npm notice 1.8kB  esm/textAnalyticsClient.d.ts.map               
[npmPack] npm notice 2.8kB  esm/textAnalyticsClient.js.map                 
[npmPack] npm notice 398B   esm/textAnalyticsClientContext.d.ts.map        
[npmPack] npm notice 970B   esm/textAnalyticsClientContext.js.map          
[npmPack] npm notice 3.6kB  README.md                                      
[npmPack] npm notice 13.6kB esm/models/index.d.ts                          
[npmPack] npm notice 13.3kB src/models/index.ts                            
[npmPack] npm notice 1.4kB  esm/models/mappers.d.ts                        
[npmPack] npm notice 14.5kB src/models/mappers.ts                          
[npmPack] npm notice 210B   esm/models/parameters.d.ts                     
[npmPack] npm notice 810B   src/models/parameters.ts                       
[npmPack] npm notice 4.9kB  esm/textAnalyticsClient.d.ts                   
[npmPack] npm notice 8.8kB  src/textAnalyticsClient.ts                     
[npmPack] npm notice 758B   esm/textAnalyticsClientContext.d.ts            
[npmPack] npm notice 1.7kB  src/textAnalyticsClientContext.ts              
[npmPack] npm notice 1.1kB  LICENSE.txt                                    
[npmPack] npm notice === Tarball Details === 
[npmPack] npm notice name:          @azure/cognitiveservices-textanalytics         
[npmPack] npm notice version:       4.0.0                                          
[npmPack] npm notice filename:      azure-cognitiveservices-textanalytics-4.0.0.tgz
[npmPack] npm notice package size:  32.0 kB                                        
[npmPack] npm notice unpacked size: 237.3 kB                                       
[npmPack] npm notice shasum:        5b1df9aacbc66dfc7e8af2fade6bbfa2530aa6bc       
[npmPack] npm notice integrity:     sha512-kQCZKgUxT/14U[...]21zcUjNa+R1MQ==       
[npmPack] npm notice total files:   34                                             
[npmPack] npm notice

openapi-sdkautomation · 2020-07-14T23:46:53Z

azure-sdk-for-python-track2 - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

azuresdkci · 2020-07-14T23:51:23Z

Can one of the admins verify this patch?

deyaaeldeen

Thanks!

mssfang · 2020-07-16T01:18:27Z

@jhendrixMSFT can you take a look at this PR. It failed at breaking change step.

jhendrixMSFT · 2020-07-20T15:29:41Z

That's expected as your change is breaking in nature. Given that this is in preview it should be ok.

Can you please fix the prettier failure? Might simply be the missing new-line char at the end of the example file you updated.

mssfang · 2020-07-21T00:33:38Z

Thank you, Joel.
@HanLiMS can you follow up this?

azure-pipelines · 2020-07-24T00:04:55Z

Azure Pipelines successfully started running 1 pipeline(s).

HanLiMS · 2020-07-24T00:54:19Z

That's expected as your change is breaking in nature. Given that this is in preview it should be ok.

Can you please fix the prettier failure? Might simply be the missing new-line char at the end of the example file you updated.

@jhendrixMSFT Thanks a lot for your review. I just updated this PR. Could you approve and merge this PR if everything looks good to you?

* fix the error in api v3.1-preview.1 * update version * fix newline

fix the error in api v3.1-preview.1

0e28218

HanLiMS requested a review from yangyuan as a code owner July 14, 2020 23:43

openapi-assignment-bot bot assigned jhendrixMSFT Jul 14, 2020

update version

9f66ed6

deyaaeldeen approved these changes Jul 15, 2020

View reviewed changes

fix newline

1adebe2

jhendrixMSFT approved these changes Jul 24, 2020

View reviewed changes

lmazuel merged commit 38a485f into Azure:master Jul 24, 2020

00Kai0 pushed a commit to 00Kai0/azure-rest-api-specs that referenced this pull request Oct 12, 2020

Fix the error in Api v3.1-preview.1 (Azure#10137)

c8fe594

* fix the error in api v3.1-preview.1 * update version * fix newline

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix the error in Api v3.1-preview.1 #10137

Fix the error in Api v3.1-preview.1 #10137

HanLiMS commented Jul 14, 2020

openapi-pipeline-app bot commented Jul 14, 2020 •

edited

Loading

azure-pipelines bot commented Jul 14, 2020

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

azure-pipelines bot commented Jul 14, 2020

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

azuresdkci commented Jul 14, 2020

deyaaeldeen left a comment

mssfang commented Jul 16, 2020

jhendrixMSFT commented Jul 20, 2020

mssfang commented Jul 21, 2020

azure-pipelines bot commented Jul 24, 2020

HanLiMS commented Jul 24, 2020

Fix the error in Api v3.1-preview.1 #10137

Fix the error in Api v3.1-preview.1 #10137

Conversation

HanLiMS commented Jul 14, 2020

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-pipeline-app bot commented Jul 14, 2020 • edited Loading

[Staging] Swagger Validation Report

azure-pipelines bot commented Jul 14, 2020

openapi-sdkautomation bot commented Jul 14, 2020 • edited Loading

azure-sdk-for-java - Release

openapi-sdkautomation bot commented Jul 14, 2020 • edited Loading

Azure CLI Extension Generation - Release

azure-pipelines bot commented Jul 14, 2020

openapi-sdkautomation bot commented Jul 14, 2020 • edited Loading

azure-sdk-for-go - Release

openapi-sdkautomation bot commented Jul 14, 2020 • edited Loading

azure-sdk-for-net - Release

openapi-sdkautomation bot commented Jul 14, 2020 • edited Loading

Trenton Generation - Release

openapi-sdkautomation bot commented Jul 14, 2020 • edited Loading

azure-sdk-for-python - Release

openapi-sdkautomation bot commented Jul 14, 2020 • edited Loading

azure-sdk-for-js - Release

openapi-sdkautomation bot commented Jul 14, 2020 • edited Loading

azure-sdk-for-python-track2 - Release

azuresdkci commented Jul 14, 2020

deyaaeldeen left a comment

Choose a reason for hiding this comment

mssfang commented Jul 16, 2020

jhendrixMSFT commented Jul 20, 2020

mssfang commented Jul 21, 2020

azure-pipelines bot commented Jul 24, 2020

HanLiMS commented Jul 24, 2020

openapi-pipeline-app bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 14, 2020 •

edited

Loading