Update CognitiveServices/Text-Analytics Swagger with new /entities endpoint by assafi · Pull Request #2985 · Azure/azure-rest-api-specs

assafi · 2018-05-01T00:42:41Z

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

The title of the PR is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
If applicable, the PR references the bug/issue that it fixes.
Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

I have read the contribution guidelines.
My spec meets the review criteria:
- The spec conforms to the Swagger 2.0 specification.
- The spec follows the guidelines described in the Swagger checklist document.
- Validation tools were run on swagger spec(s) and have all been fixed in this PR.

msftclas · 2018-05-01T00:42:51Z

All CLA requirements met.

AutorestCI · 2018-05-01T00:43:59Z

Automation for azure-libraries-for-java

The initial PR has been merged into your service PR:
AutorestCI/azure-libraries-for-java#136

AutorestCI · 2018-05-01T00:44:02Z

Automation for azure-sdk-for-node

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-node#2828

AutorestCI · 2018-05-01T00:44:04Z

Automation for azure-sdk-for-python

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-python#2522

AutorestCI · 2018-05-01T00:48:39Z

Automation for azure-sdk-for-go

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-go#1769

azuresdkciprbot · 2018-05-01T22:34:21Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cognitiveservices/data-plane/TextAnalytics/readme.md

⚠️

8 new Warnings.(45 total)

Code	Id	Source	Message
ListInOperationName	R1003	Link	Since operation 'Entities' response has model definition 'array', it should be of the form "_list". Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
DescriptionAndTitleMissing	R4000	Link	'EntitiesBatchResult' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
DescriptionAndTitleMissing	R4000	Link	'EntitiesBatchResultItem' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
DescriptionAndTitleMissing	R4000	Link	'EntityRecord' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
DescriptionAndTitleMissing	R4000	Link	'MatchRecord' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
DescriptionAndTitleMissing	R4000	Link	'documents' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
DescriptionAndTitleMissing	R4000	Link	'errors' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
ParameterNotDefinedInGlobalParameters	R2015	Link	Parameter "api-version" is referenced but not defined in the global parameters section of Service Definition

❌0 new Errors.(1 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-01T22:34:21Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cognitiveservices/data-plane/TextAnalytics/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(2 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

hovsepm · 2018-05-01T22:54:10Z

...gnitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulEntitiesRequest.json

+{
+    "parameters": {
+        "Ocp-Apim-Subscription-Key": "{API key}",
+        "body": {


body [](start = 9, length = 4)

According to your swagger this parameter should be named as input and not body, right?

No. input and body are not part of the request body. I think this is just a reference ID for the example body which has a documents root object. I have followed the same pattern as existing endpoints (the input for all is the same).

Here's an example request body:
{ "documents": [ { "language": "en", "id": "1", "text": "Microsoft released Windows 10" }, { "language": "en", "id": "2", "text": "In 1975, Bill Gates III and Paul Allen founded the company." } ] }

and I think all your samples are flagged as wrong

{ code: 'REQUEST_VALIDATION_ERROR', id: 'OAV109', message: 'Found errors in validating the request for x-ms-example "Successful Key Phrase request" in operation "Key Phrases".', innerErrors: [ { code: 'REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND', id: 'OAV105', message: 'In operation "Key Phrases", parameter input is required in the swagger spec but is not present in the provided example parameter values.' } ] } error: Found errors in validating the request for x-ms-example "Successful Key Phrase request" in operation "Detect Language".: { code: 'REQUEST_VALIDATION_ERROR', id: 'OAV109', message: 'Found errors in validating the request for x-ms-example "Successful Key Phrase request" in operation "Detect Language".', innerErrors: [ { code: 'REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND', id: 'OAV105', message: 'In operation "Detect Language", parameter input is required in the swagger spec but is not present in the provided example parameter values.' } ] } error: Found errors in validating the request for x-ms-example "Successful Key Phrase request" in operation "Sentiment".: { code: 'REQUEST_VALIDATION_ERROR', id: 'OAV109', message: 'Found errors in validating the request for x-ms-example "Successful Key Phrase request" in operation "Sentiment".', innerErrors: [ { code: 'REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND', id: 'OAV105', message: 'In operation "Sentiment", parameter input is required in the swagger spec but is not present in the provided example parameter values.' } ] } error: Found errors in validating the request for x-ms-example "Successful Entities request" in operation "Entities".: { code: 'REQUEST_VALIDATION_ERROR', id: 'OAV109', message: 'Found errors in validating the request for x-ms-example "Successful Entities request" in operation "Entities".', innerErrors: [ { code: 'REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND', id: 'OAV105', message: 'In operation "Entities", parameter input is required in the swagger spec but is not present in the provided example parameter values.' } ] }

Thanks. Should be fixed now.

azuresdkciprbot · 2018-05-02T01:42:19Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cognitiveservices/data-plane/TextAnalytics/readme.md

⚠️

8 new Warnings.(45 total)

Code	Id	Source	Message
ListInOperationName	R1003	Link	Since operation 'Entities' response has model definition 'array', it should be of the form "_list". Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
DescriptionAndTitleMissing	R4000	Link	'EntitiesBatchResult' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
DescriptionAndTitleMissing	R4000	Link	'EntitiesBatchResultItem' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
DescriptionAndTitleMissing	R4000	Link	'EntityRecord' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
DescriptionAndTitleMissing	R4000	Link	'MatchRecord' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
ParameterNotDefinedInGlobalParameters	R2015	Link	Parameter "api-version" is referenced but not defined in the global parameters section of Service Definition
DescriptionAndTitleMissing	R4000	Link	'documents' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
DescriptionAndTitleMissing	R4000	Link	'errors' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.

❌0 new Errors.(1 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-02T01:42:19Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cognitiveservices/data-plane/TextAnalytics/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(2 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

hovsepm · 2018-05-02T21:08:40Z

@assafi please fix this issues as well:

{ code: 'REQUEST_VALIDATION_ERROR',
  id: 'OAV109',
  message: 'Found errors in validating the request for x-ms-example "Successful Key Phrase request" in operation "Key Phrases".',
  innerErrors: 
   [ { code: 'REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND',
       id: 'OAV105',
       message: 'In operation "Key Phrases", parameter AzureRegion is required in the swagger spec but is not present in the provided example parameter values.' } ] }
error: Found errors in validating the request for x-ms-example "Successful Detect Language request" in operation "Detect Language".:
 
{ code: 'REQUEST_VALIDATION_ERROR',
  id: 'OAV109',
  message: 'Found errors in validating the request for x-ms-example "Successful Detect Language request" in operation "Detect Language".',
  innerErrors: 
   [ { code: 'REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND',
       id: 'OAV105',
       message: 'In operation "Detect Language", parameter AzureRegion is required in the swagger spec but is not present in the provided example parameter values.' } ] }
error: Found errors in validating the request for x-ms-example "Successful Sentiment request" in operation "Sentiment".:
 
{ code: 'REQUEST_VALIDATION_ERROR',
  id: 'OAV109',
  message: 'Found errors in validating the request for x-ms-example "Successful Sentiment request" in operation "Sentiment".',
  innerErrors: 
   [ { code: 'REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND',
       id: 'OAV105',
       message: 'In operation "Sentiment", parameter AzureRegion is required in the swagger spec but is not present in the provided example parameter values.' } ] }
error: Found errors in validating the request for x-ms-example "Successful Entities request" in operation "Entities".:
 
{ code: 'REQUEST_VALIDATION_ERROR',
  id: 'OAV109',
  message: 'Found errors in validating the request for x-ms-example "Successful Entities request" in operation "Entities".',
  innerErrors: 
   [ { code: 'REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND',
       id: 'OAV105',
       message: 'In operation "Entities", parameter AzureRegion is required in the swagger spec but is not present in the provided example parameter values.' } ] }

azuresdkciprbot · 2018-05-02T22:06:24Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cognitiveservices/data-plane/TextAnalytics/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(2 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-02T22:06:24Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cognitiveservices/data-plane/TextAnalytics/readme.md

⚠️

8 new Warnings.(45 total)

Code	Id	Source	Message
ListInOperationName	R1003	Link	Since operation 'Entities' response has model definition 'array', it should be of the form "_list". Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
DescriptionAndTitleMissing	R4000	Link	'EntitiesBatchResult' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
DescriptionAndTitleMissing	R4000	Link	'EntitiesBatchResultItem' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
DescriptionAndTitleMissing	R4000	Link	'EntityRecord' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
DescriptionAndTitleMissing	R4000	Link	'MatchRecord' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
ParameterNotDefinedInGlobalParameters	R2015	Link	Parameter "api-version" is referenced but not defined in the global parameters section of Service Definition
DescriptionAndTitleMissing	R4000	Link	'documents' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
DescriptionAndTitleMissing	R4000	Link	'errors' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.

❌0 new Errors.(1 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

Assaf Israel added 4 commits April 30, 2018 16:25

Update TA SDK Swagger file with new /entities endpoint + examples

3203c5b

Fixing entities response default case

ee40a5a

Merge branch 'master' into assafi/ta_sdk_entities

d283bad

Update SDK folder in CSharp configs

0e4a71a

azuresdkci assigned hovsepm May 1, 2018

azuresdkci requested a review from hovsepm May 1, 2018 00:43

AutorestCI mentioned this pull request May 1, 2018

[AutoPR cognitiveservices/data-plane/TextAnalytics] Update CognitiveServices/Text-Analytics Swagger with new /entities endpoint AutorestCI/azure-libraries-for-java#127

Merged

AutorestCI mentioned this pull request May 1, 2018

[AutoPR cognitiveservices/data-plane/TextAnalytics] Update CognitiveServices/Text-Analytics Swagger with new /entities endpoint Azure/azure-sdk-for-node#2818

Merged

AutorestCI mentioned this pull request May 1, 2018

[AutoPR cognitiveservices/data-plane/TextAnalytics] Update CognitiveServices/Text-Analytics Swagger with new /entities endpoint Azure/azure-sdk-for-python#2503

Merged

AutorestCI mentioned this pull request May 1, 2018

[AutoPR cognitiveservices/data-plane/TextAnalytics] Update CognitiveServices/Text-Analytics Swagger with new /entities endpoint Azure/azure-sdk-for-go#1739

Closed

hovsepm reviewed May 1, 2018

View reviewed changes

sergey-shandar added the potential-sdk-breaking-change label May 1, 2018

Fixing examples references

91426c1

AutorestCI mentioned this pull request May 2, 2018

[AutoPR cognitiveservices/data-plane/TextAnalytics] Update CognitiveServices/Text-Analytics Swagger with new /entities endpoint Azure/azure-sdk-for-go#1760

Merged

Adding AzureRegion to examples

3607d47

hovsepm approved these changes May 2, 2018

View reviewed changes

hovsepm merged commit 7b23c9f into Azure:master May 2, 2018

assafi mentioned this pull request May 3, 2018

New Language/TextAnalytics SDK Azure/azure-sdk-for-net#4285

Merged

9 tasks

assafi mentioned this pull request May 3, 2018

Updating Language/Language SDK with new /entities endpoint Azure/azure-sdk-for-net#4286

Merged

9 tasks

Conversation

assafi commented May 1, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR information

Quality of Swagger

Uh oh!

msftclas commented May 1, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AutorestCI commented May 1, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-libraries-for-java

Uh oh!

AutorestCI commented May 1, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-node

Uh oh!

AutorestCI commented May 1, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-python

Uh oh!

AutorestCI commented May 1, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-go

Uh oh!

azuresdkciprbot commented May 1, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented May 1, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

hovsepm May 1, 2018

Choose a reason for hiding this comment

Uh oh!

assafi May 1, 2018

Choose a reason for hiding this comment

Uh oh!

assafi May 2, 2018

Choose a reason for hiding this comment

Uh oh!

hovsepm May 2, 2018

Choose a reason for hiding this comment

Uh oh!

assafi May 2, 2018

Choose a reason for hiding this comment

Uh oh!

azuresdkciprbot commented May 2, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented May 2, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

hovsepm commented May 2, 2018

Uh oh!

azuresdkciprbot commented May 2, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented May 2, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

assafi commented May 1, 2018 •

edited

Loading

msftclas commented May 1, 2018 •

edited

Loading

AutorestCI commented May 1, 2018 •

edited

Loading

AutorestCI commented May 1, 2018 •

edited

Loading

AutorestCI commented May 1, 2018 •

edited

Loading

AutorestCI commented May 1, 2018 •

edited

Loading