Changing customConfig to a string

[q3blend]

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.

[AutorestCI]

Automation for azure-sdk-for-python

A PR has been created for you:
Azure/azure-sdk-for-python#3260

[AutorestCI]

Automation for azure-sdk-for-node

A PR has been created for you:
Azure/azure-sdk-for-node#3485

[AutorestCI]

Automation for azure-sdk-for-java

A PR has been created for you:
Azure/azure-sdk-for-java#2360

[AutorestCI]

Automation for azure-sdk-for-ruby

A PR has been created for you:
Azure/azure-sdk-for-ruby#1618

[AutorestCI]

Automation for azure-sdk-for-go

A PR has been created for you:
Azure/azure-sdk-for-go#2612

[azuresdkci]

Can one of the admins verify this patch?

[yangyuan]

LGTM except title change.

[q3blend]

Updated the title

[yangyuan]

LGTM

[q3blend]

Can you please merge this?

[yangyuan]

@q3blend, Azure SDK team can merge this.

ping.. @sarangan12

[sarangan12]

@q3blend By changing the data type, this will be a breaking change is several SDKs. Now, if you release a new version and change it, I dont mind. But, changing it in an existing version is definitely a breaking change and will impact the SDK customers. Why is this happening? Has this been approved?

[q3blend]

This is because on the API side the customConfig parameter was changed from int to string (guid), but it is still backward compatible. The change is already out there and the documentation is updated:
https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-custom-search-api-v7-reference

What do you mean by a new version? As in bumping the version of the swagger spec to 1.1? I do not mind that either.

[sarangan12]

@q3blend As mentioned earlier this change will cause SDK users a breaking change.

Per Microsoft guidelines, such changes could be introduced only in new versions i.e. if you have 2018-01-01 version of service and you would like to introduce a breaking change you could do it in 2018-02-01 and not the same version. (This has nothing to do with Swagger versions)

For this specific PR, since you have already deployed the changes in production side, I will approve it and merge it. But, in the future, such changes will be reported in the 360 report as breaking changes.