Adding indexing parameters to the swagger for Cognitive Search by jennifermarsman · Pull Request #10349 · Azure/azure-rest-api-specs

jennifermarsman · 2020-08-05T17:26:50Z

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.

… V2 SDK. These weren't referenced in the examples.

…t-api-specs

…to false for failOn* properties, and removed en-us locale from URL

Add swagger spec for indexer execution environment

…ermarsman/azure-rest-api-specs into jennmar/indexerParameters

Add swagger spec for indexer execution environment in 2 new API versions

…f swagger

… by default

…lable

…t-api-specs

openapi-sdkautomation · 2020-08-06T23:19:11Z

azure-sdk-for-java - 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-08-06T23:19:11Z

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-08-06T23:19:12Z

azure-sdk-for-python - 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-08-06T23:19:12Z

azure-sdk-for-js - 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-08-06T23:19:13Z

azure-sdk-for-go - 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-08-06T23:19:14Z

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

openapi-sdkautomation · 2020-08-06T23:19:14Z

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

…meExtensions

azure-pipelines · 2020-08-07T14:40:54Z

Azure Pipelines successfully started running 1 pipeline(s).

jennifermarsman · 2020-08-07T14:47:46Z

This PR should replace #9900.

jennifermarsman · 2020-08-07T14:59:55Z

The remaining BreakingChange errors are for "1034 - AddedRequiredProperty", but the properties added are all optional in a Configuration property bag.

specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json

… configuration

azure-pipelines · 2020-09-11T16:02:06Z

Azure Pipelines successfully started running 1 pipeline(s).

openapi-sdkautomation · 2020-09-11T16:06:12Z

azure-resource-manager-schemas - 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

heaths · 2020-09-11T16:22:26Z

specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json

        }
      },
-      "description": "Represents parameters for indexer execution."
+      "description": "Represents parameters for indexer execution.",


Actually line 5790, but GitHub won't let me comment on surrounding code 😣: add a $ref to this model from configuration.

Oh sorry, I thought you wanted them completely decoupled by leaving the configuration's type as object.

This will be a breaking change then, no?

Fixed in commit 8c52a20

azure-pipelines · 2020-09-11T18:16:45Z

Azure Pipelines successfully started running 1 pipeline(s).

heaths

Looks good, as long as it doesn't generating any breaking change warnings with the service implementation.

specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json

tjprescott · 2020-09-14T17:11:39Z

Looks good, as long as it doesn't generating any breaking change warnings with the service implementation.

@heaths it looks like this is generating Breaking Change warnings.

Specifically, lots of added required properties.

johanste · 2020-09-14T17:54:22Z

@tjprescott, I don't see any of the newly added properties being required. But it is Monday. Am I missing something?

tjprescott · 2020-09-14T18:04:16Z

@tjprescott, I don't see any of the newly added properties being required. But it is Monday. Am I missing something?

True, I don't see any of them marked required, and they all seem to have defaults. @johanste who would be the right person to investigate this from the tooling side?

johanste · 2020-09-14T18:09:00Z

@tjprescott, the openapihub has a teams support channel. I'd start there.

jennifermarsman and others added 30 commits March 4, 2020 21:13

Removed color and imageType from the visualFeature enumeration in the…

74a3235

… V2 SDK. These weren't referenced in the examples.

Merge branch 'master' of https://github.com/jennifermarsman/azure-res…

5d687b5

…t-api-specs

Merge remote-tracking branch 'upstream/master'

535fbc9

Merge remote-tracking branch 'upstream/master'

e5cb73d

Added indexing parameters to the swagger for Cognitive Search

bf3f6b8

Moved properties under configuration

dfe05df

Removed bad formatting so JSON is valid

67f1001

Added 3 words to custom-words list

01ec186

Marking IndexingParameter extra properties as not required

fa9fe40

Merge remote-tracking branch 'upstream/master'

b6cce99

Merge branch 'master' into jennmar/indexerParameters

a2c4239

Removed duplicate type definitions with $ref, changed default values …

18b17f8

…to false for failOn* properties, and removed en-us locale from URL

Add swagger spec for indexer execution environment

d5efa22

Change the default value to 'standard'

18bee0a

Merge pull request #1 from arv100kri/arjagann/execution-environment

1c031d5

Add swagger spec for indexer execution environment

Updating 2020 API swaggers with IndexingParameters in Cognitive Search

1b50082

Merge branch 'jennmar/indexerParameters' of https://github.com/jennif…

327426f

…ermarsman/azure-rest-api-specs into jennmar/indexerParameters

Add swagger spec for indexer execution environment in 2 new API versions

f232143

Merge pull request #2 from arv100kri/arjagann/indexer-parameters

75ff568

Add swagger spec for indexer execution environment in 2 new API versions

Added default value for queryTimeout parameter

a589333

Removing indexing parameter changes from 2019-05-06-preview version o…

5669fec

…f swagger

Removed x-nullable from indexing parameter enums

bb01e69

Removed the required: false since everything is optional/not required…

096a86b

… by default

Marked batchSize, maxFailedItems, and maxFailedItemsPerBatch as x-nul…

2a090f1

…lable

Added x-nullable to configuration parameters

51750c6

Merge branch 'master' of https://github.com/jennifermarsman/azure-res…

be64505

…t-api-specs

Added indexing parameters to the swagger for Cognitive Search

5c3f426

Moved properties under configuration

b439d16

Removed bad formatting so JSON is valid

2c58200

Added 3 words to custom-words list

29fd239

Added default values for excludedFileNameExtensions and indexedFileNa…

6a024fe

…meExtensions

jennifermarsman changed the title ~~[NotReadyForReview] Adding indexing parameters to the swagger for Cognitive Search~~ Adding indexing parameters to the swagger for Cognitive Search Aug 7, 2020

heaths reviewed Aug 7, 2020

View reviewed changes

specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json Outdated Show resolved Hide resolved

heaths mentioned this pull request Aug 7, 2020

Generator does not support property bag with well-known properties Azure/autorest.csharp#862

Open

3 tasks

heaths requested changes Sep 10, 2020

View reviewed changes

specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json Outdated Show resolved Hide resolved

Moved indexing parameters configuration to a separate model not under…

e9ae5e7

… configuration

jennifermarsman requested a review from heaths September 11, 2020 16:04

heaths requested changes Sep 11, 2020

View reviewed changes

Referencing the IndexingParametersConfiguration from configuration

8c52a20

heaths approved these changes Sep 11, 2020

View reviewed changes

johanste reviewed Sep 11, 2020

View reviewed changes

specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json Show resolved Hide resolved

lmazuel merged commit d61b283 into Azure:master Sep 25, 2020

Comments

Conversation

jennifermarsman commented Aug 5, 2020

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

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

Uh oh!

azure-sdk-for-java - Release

Uh oh!

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

Uh oh!

Trenton Generation - Release

Uh oh!

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

Uh oh!

azure-sdk-for-python - Release

Uh oh!

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

Uh oh!

azure-sdk-for-js - Release

Uh oh!

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

Uh oh!

azure-sdk-for-go - Release

Uh oh!

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

Uh oh!

azure-sdk-for-python-track2 - Release

Uh oh!

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

Uh oh!

Azure CLI Extension Generation - Release

Uh oh!

azure-pipelines bot commented Aug 7, 2020

Uh oh!

jennifermarsman commented Aug 7, 2020

Uh oh!

jennifermarsman commented Aug 7, 2020

Uh oh!

Uh oh!

Uh oh!

azure-pipelines bot commented Sep 11, 2020

Uh oh!

openapi-sdkautomation bot commented Sep 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

azure-resource-manager-schemas - Release

Uh oh!

heaths Sep 11, 2020

Choose a reason for hiding this comment

Uh oh!

jennifermarsman Sep 11, 2020

Choose a reason for hiding this comment

Uh oh!

jennifermarsman Sep 11, 2020

Choose a reason for hiding this comment

Uh oh!

jennifermarsman Sep 11, 2020

Choose a reason for hiding this comment

Uh oh!

azure-pipelines bot commented Sep 11, 2020

Uh oh!

heaths left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tjprescott commented Sep 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johanste commented Sep 14, 2020

Uh oh!

tjprescott commented Sep 14, 2020

Uh oh!

johanste commented Sep 14, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

openapi-sdkautomation bot commented Aug 6, 2020 •

edited

Loading

openapi-sdkautomation bot commented Aug 6, 2020 •

edited

Loading

openapi-sdkautomation bot commented Aug 6, 2020 •

edited

Loading

openapi-sdkautomation bot commented Aug 6, 2020 •

edited

Loading

openapi-sdkautomation bot commented Aug 6, 2020 •

edited

Loading

openapi-sdkautomation bot commented Aug 6, 2020 •

edited

Loading

openapi-sdkautomation bot commented Aug 6, 2020 •

edited

Loading

openapi-sdkautomation bot commented Sep 11, 2020 •

edited

Loading

tjprescott commented Sep 14, 2020 •

edited

Loading