[Azure Search] Introduce a few breaking changes in swagger specifications by arv100kri · Pull Request #6934 · Azure/azure-rest-api-specs

arv100kri · 2019-08-12T21:01:26Z

This PR attempts at bringing the swagger spec in line with the REST API behavior, which intentionally introduces a few breaking changes (which will follow in a subsequent major version SDK update)

Skills can now optionally take in a name property
WebApiSkill has an optional degreeOfParallelism property, which can allow customers to specify how many API calls (if non-null, non-zero) can be made in parallel to their endpoint
Add more information to indexer execution's errors and warnings

Latest improvements:

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 have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and have all been fixed in this PR.
The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
adding/removing APIs.
adding/removing properties.
adding/removing API-version.
adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Please follow the link to find more details on API review process.

openapi-sdkautomation · 2019-08-12T21:01:29Z

In Testing, Please Ignore

[Logs] (Generated from 3d983e6, Iteration 5)

No readme.md specification configuration files were found that are associated with the files modified in this pull request.

azuresdkci · 2019-08-12T21:01:56Z

Can one of the admins verify this patch?

AutorestCI · 2019-08-12T21:02:06Z

Automation for azure-sdk-for-go

Nothing to generate for azure-sdk-for-go

AutorestCI · 2019-08-12T21:02:27Z

Automation for azure-sdk-for-python

Nothing to generate for azure-sdk-for-python

...oft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateSkillset.json

...Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexerStatus.json

...ne/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListSkillsets.json

brjohnstmsft · 2019-08-15T21:49:00Z

@arv100kri Please ensure that the example changes pass validation (not sure at a glance that they're failing validation because there are other known issues with validating our Swagger right now).

arv100kri · 2019-08-16T01:32:36Z

@arv100kri Please ensure that the example changes pass validation (not sure at a glance that they're failing validation because there are other known issues with validating our Swagger right now).

It's the same "base" set of validations errors for the various enum types

...cation/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/searchservice.json

yaohaizh · 2019-08-20T02:47:42Z

@arv100kri The model validation failed with https://dev.azure.com/azure-sdk/public/_build/results?buildId=90022&view=logs&j=8d2f9c49-cd83-5a9d-f3fe-2fd651afa742&t=43324f1f-6724-5d61-785f-f0ac9fd256a1&l=272 Please help fix it. Meanwhile, we need Azure API board review this. Thanks.

brjohnstmsft · 2019-08-20T16:15:12Z

@yaohaizh Those validation failures are the result of a known issue. See this for context: #5665 (comment)

Regarding Azure API review board -- This PR is a change that brings our Swagger in line with the API that's actually deployed in production. Is a review still required in this case?

yaohaizh · 2019-08-21T01:42:56Z

As talked with @brjohnstmsft , the change is already deployed and the change reflect the service deployed. Given this, @yungezz , could you help merge this since it is blocked by model validation.

yungezz · 2019-08-21T02:14:19Z

checked with @yaohaizh, this PR is ready for merge. ModelValidation error is an known issue.

* 2020-12-01-preview * readme * validation fixes * PR fixes * fixes * fixes * fixes * fixes * try fix warnings * PR comments * PR comments * PR comments * PR comments * rename Microsoft.Portal to Microsoft.PortalServices * rename Microsoft.Portal to Microsoft.PortalServices * linting * fix lint Co-authored-by: Ryan Benson <rbenson@microsoft.com>

Arvind Krishnaa Jagannathan added 3 commits August 8, 2019 13:07

Add the 'Name' parameter to skills

2635a40

Add 'degreeOfParallelism' parameter to WebApiSkill

3efd7cb

Add structured errors and warnings for IndexerExecutionInfo

2bce8bf

arv100kri requested a review from brjohnstmsft August 12, 2019 21:01

arv100kri marked this pull request as ready for review August 12, 2019 21:01

azuresdkci assigned sarangan12 Aug 12, 2019

azuresdkci requested a review from sarangan12 August 12, 2019 21:02

arv100kri mentioned this pull request Aug 12, 2019

[Azure Search] Introduce last of the breaking changes for Azure search major version revision Azure/azure-sdk-for-net#7265

Merged

sarangan12 removed their assignment Aug 14, 2019

sarangan12 removed their request for review August 14, 2019 13:24

sarangan12 added the Reassign label Aug 14, 2019

azuresdkci removed the Reassign label Aug 14, 2019

azuresdkci assigned sarangan12 Aug 14, 2019

azuresdkci requested a review from sarangan12 August 14, 2019 13:39

brjohnstmsft suggested changes Aug 15, 2019

View reviewed changes

Arvind Krishnaa Jagannathan added 2 commits August 15, 2019 18:21

Indicate that skill names are prefixed with '#' by default

c42403c

Update indexer status documentation links

3d983e6

arv100kri requested a review from brjohnstmsft August 16, 2019 01:33

brjohnstmsft approved these changes Aug 16, 2019

View reviewed changes

...cation/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/searchservice.json Show resolved Hide resolved

PhoenixHe-NV mentioned this pull request Aug 16, 2019

[Mirror] [Azure Search] Introduce a few breaking changes in swagger specifications test-repo-tih/azure-rest-api-specs#110

Closed

sarangan12 removed their request for review August 19, 2019 05:58

sarangan12 removed their assignment Aug 19, 2019

sarangan12 added the Reassign label Aug 19, 2019

bsiegel removed the Reassign label Aug 19, 2019

bsiegel added the Reassign label Aug 19, 2019

bsiegel assigned yaohaizh Aug 19, 2019

bsiegel removed the Reassign label Aug 19, 2019

yaohaizh added the APIStewardshipBoard-ReviewRequested This should be reviewed by the Azure API Stewardship team in partnership with the service team. label Aug 20, 2019

yaohaizh approved these changes Aug 21, 2019

View reviewed changes

yungezz added the potential-sdk-breaking-change label Aug 21, 2019

yungezz merged commit ea2dbe5 into Azure:master Aug 21, 2019

yaohaizh removed the APIStewardshipBoard-ReviewRequested This should be reviewed by the Azure API Stewardship team in partnership with the service team. label Aug 21, 2019

brjohnstmsft mentioned this pull request Oct 1, 2019

[Azure Search] Add missing $select parameter to List APIs #7371

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Azure Search] Introduce a few breaking changes in swagger specifications#6934

[Azure Search] Introduce a few breaking changes in swagger specifications#6934
yungezz merged 5 commits intoAzure:masterfrom
arv100kri:arv100kri/skillset-breaking-changes

arv100kri commented Aug 12, 2019 •

edited

Loading

Uh oh!

openapi-sdkautomation bot commented Aug 12, 2019 •

edited

Loading

Uh oh!

azuresdkci commented Aug 12, 2019

Uh oh!

AutorestCI commented Aug 12, 2019 •

edited

Loading

Uh oh!

AutorestCI commented Aug 12, 2019 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brjohnstmsft commented Aug 15, 2019

Uh oh!

arv100kri commented Aug 16, 2019

Uh oh!

Uh oh!

yaohaizh commented Aug 20, 2019

Uh oh!

brjohnstmsft commented Aug 20, 2019

Uh oh!

yaohaizh commented Aug 21, 2019

Uh oh!

yungezz commented Aug 21, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Conversation

arv100kri commented Aug 12, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Latest improvements:

Contribution checklist:

ARM API Review Checklist

Uh oh!

openapi-sdkautomation bot commented Aug 12, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

In Testing, Please Ignore

[Logs] (Generated from 3d983e6, Iteration 5)

Uh oh!

azuresdkci commented Aug 12, 2019

Uh oh!

AutorestCI commented Aug 12, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-go

Uh oh!

AutorestCI commented Aug 12, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-python

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brjohnstmsft commented Aug 15, 2019

Uh oh!

arv100kri commented Aug 16, 2019

Uh oh!

Uh oh!

yaohaizh commented Aug 20, 2019

Uh oh!

brjohnstmsft commented Aug 20, 2019

Uh oh!

yaohaizh commented Aug 21, 2019

Uh oh!

yungezz commented Aug 21, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

arv100kri commented Aug 12, 2019 •

edited

Loading

openapi-sdkautomation bot commented Aug 12, 2019 •

edited

Loading

AutorestCI commented Aug 12, 2019 •

edited

Loading

AutorestCI commented Aug 12, 2019 •

edited

Loading