July Release Search SDK Code Changes #16227

sarangan12 · 2021-07-06T18:06:09Z

This PR is for the July release of the search-documents SDK. Basically, this PR does 2 things:

Regenerate SDK based on latest swaggers (and update the custom layer as required)
Add TokenCredential to the constructor.

Updating the SDK to latest version of generator has been moved to next release.

@xirzec Please review and approve the PR.

ramya-rao-a · 2021-07-07T16:07:26Z

sdk/search/search-documents/CHANGELOG.md

-### Key Bugs Fixed
-
-### Fixed
+  - Support for `TokenCredential` has been added.


Can we re-word this to convey that authentication via AAD is now supported?

xirzec

The API changes seem fine, though the | null still looks a bit odd to me.

Also I'm a little curious about how the shifting accepted values for apiVersion affect compatibility.

xirzec · 2021-07-07T17:30:22Z

sdk/search/search-documents/review/search-documents.api.md

+// @public
+export type EntityLinkingSkill = BaseSearchIndexerSkill & {
+    odatatype: "#Microsoft.Skills.Text.V3.EntityLinkingSkill";
+    defaultLanguageCode?: string | null;


I always ask this, but does null have a distinct meaning from omitting the property, like to remove it on a PATCH operation?

This update should have been done for this release. But, due to the time constraints spent in autorest, this has been moved out. This change, along with move to core V2 will be planned for the next release.

xirzec · 2021-07-07T17:32:26Z

sdk/search/search-documents/src/generated/data/models/index.ts

-  /** Api Version '2020-06-30-Preview' */
-  TwoThousandTwenty0630Preview = "2020-06-30-Preview"
+/** Known values of {@link ApiVersion20210430Preview} that the service accepts. */
+export const enum KnownApiVersion20210430Preview {


what's the point in this enum? It only has a single value (rather than listing all known/supported api versions) and from its name it doesn't seem like it would ever contain other values

xirzec · 2021-07-07T17:34:34Z

sdk/search/search-documents/src/searchClient.ts

-  operationOptionsToRequestOptionsBase
+  operationOptionsToRequestOptionsBase,
+  RequestPolicyFactory,
+  bearerTokenAuthenticationPolicy
 } from "@azure/core-http";


this reminds me - are we going to move search to corev2 soon?

Yes. It is in our roadmap. We should be able to move it for the August release.

xirzec · 2021-07-07T17:35:48Z

sdk/search/search-documents/src/searchIndexClient.ts

@@ -145,7 +152,7 @@ export class SearchIndexClient {
    let apiVersion = this.apiVersion;

    if (options.apiVersion) {
-      if (!["2020-06-30-Preview", "2020-06-30"].includes(options.apiVersion)) {
+      if (!["2020-06-30", "2021-04-30-Preview"].includes(options.apiVersion)) {


isn't this a breaking change? If the consumer passed in "2020-06-30-Preview" then after updating they'd get a runtime error

Yes. This was discussed among all the SDKs and agreed upon since this is a preview version.

check-enforcer · 2021-07-07T18:31:01Z

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run js - [service] - ci

sarangan12 · 2021-07-07T18:38:45Z

/check-enforcer override

Fixed an event name typo in its description. (Azure#16227)

Dev sql microsoft.sql 2021 05 01 preview release (Azure#16289) * add base for Microsoft.sql * Update Readme.md * update version in swagger example files * remove ss * update swagger files * update readme.md * add missing json files * update custom-words.txt to address the spelling check * remove 201 define in ServerUpdate.json * Sync sql 2021 05 01 with main branch (Azure#16236) * Update comment.yml for publish pr (Azure#16166) * Update comment.yml * Update comment.yml * Bump dependencies (Azure#16170) * bump avocado * bump mocha * remove submodule (Azure#16171) * add azure-resource-manager-schema to servicelinker (Azure#16176) Co-authored-by: Nan Jiang <[email protected]> * Update pr assignment config (Azure#16175) * [Synapse] - fix scheme for Artifacts and update readme to include KQL scripts for October release (Azure#16035) * [Synapse] - fix scheme for Notebook, Spark Job definition and SQL script * Update dataset, linked service and pipeline * Update release tag for october release * Correct type of result limit * Add arguments for SynapseSparkJobActivityTypeProperties Co-authored-by: Dongwei Wang <[email protected]> * fix (Azure#16164) Merging the change to have accurate Swagger * Remove requirement of identity field in the request for TURN. (Azure#15966) * Remove requirement of identity field in the request. * Update PR * Address comment * change api version in readme for sdk release (Azure#16187) * Add blockchain to latest profile * Add additional types * api version change Co-authored-by: Mark Cowlishaw <[email protected]> Co-authored-by: Ping Zhu <[email protected]> * [Search] Rename types for better SDK code (Azure#16039) * Rename types for better SDK code * Rename Speller and Captions search options * Reorder parameters to have consistency across APIs * Remove 'SearchIndexer' prefix from projection selectors Remove 'global' prefix from default flags on custom entities * Change enum name AdlsGen2->AzureDataLakeStorageGen2 Change property name storageContainer->storageContainerName * move additional .NET SDK renames to the REST spec * Revert changes in KnowledgeStore which has GAed * Revert changes in CustomEntityLookupSkill which has GAed * Revert changes in SIKSBlobProjectionSelector which has GAed * Revert changes in SearchIndexerDataSourceType which has GAed * Rename ignoreResetRequirements->skipIndexerResetRequirementForCache * fix validStreamingUnits (Azure#16143) Co-authored-by: Roslyn Lu <[email protected]> * Fix schemas readme files (Azure#16207) * Fix schemas readme files * fix ref * add resourcemanager in module-name (Azure#16206) * add resourcemanager in module-name * add go track2 repo in readme.md * fix * Minor description update for createorupdate & update slot (Azure#15457) * add scmMinTlsVersion * modify description for createorupdate & update slot for all API versions Co-authored-by: Edwin Diaz <[email protected]> * [Hub Generated] Review request for Microsoft.Security to add version preview/2021-08-01-preview (Azure#16096) * Adds base for updating Microsoft.Security from version stable/2021-07-01 to version 2021-08-01-preview * Updates readme * Updates API version in new specs and examples * First pass at Microsoft.Security/standards for review/preview * Addressing Round-1 feedback, adding missing descriptions and changing scoping to match ProxyResource type * First pass for Microsoft.Security\standardComponents * Changes to fix a typo in an example spec * Added Microsoft.Security/standardAssignments * Fix naming convention issue * Removed types based on Hila's feedback * Changes to data model for both API calls * Fix example errors and typos * Add systemData to Microsoft.Security/standards * Changes to fix systemData linting * un-nest systemData fields in examples * More systemData placement * Naming convention name to assignments from standardAssignment * Additional example added * Changes to address descriptive comments on field types * Add systemData readOnly * prettier-fix against examples * Cleaned types to ref standard v2 common-types entry similar to securityForIoT * Re-added v2 folder? * Missed a change here? * Cleanup of v2 type completely, updated readme.md * Adds suppression to readme * Adds suppression to readme * Change modification to suppress operations linting Co-authored-by: Adam Holliday <[email protected]> * Yifanzhou/api version change (Azure#16191) * remove Catalog * update 2021-05-01-preview * delete 2021-09-01 * Update readme.md * Update purviewcatalog.json * change read-only property (Azure#16209) Co-authored-by: Parv Saxena <[email protected]> * Update account.json - make CollectionReferece type writable (Azure#16208) * Update account.json Updating the CollectionReference to be writeable to unblock the customers. * Update account.json Need the default set in the client SDK * Fixed an event name typo in its description. (Azure#16227) * Introduce new API version for Microsoft.ProviderHub 2021-09-01-preview (Azure#15723) * Introduce new API version for Microsoft.ProviderHub 2021-09-01-preview * Add PrivateResourceProviderConfigurations * Add PrivateRP examples * Fix enum type. * Fix enum again * Prettier * Fix prettier error * Add readme.md + prettier * Fix * Fix avocado error * Modify interface * Fix issue * Make it private preview * Remove private RP changes * Update SKU settings Co-authored-by: REDMOND\lakshv <[email protected]> Co-authored-by: He Huang <[email protected]> * fluidrelay_readme_config (Azure#16192) fluidrelay_readme_config * Add community gallery proxy resource (Azure#16043) * [Hub Generated] Public private branch 'dev-storagecache-Microsoft.StorageCache-2021-09-01' (Azure#16152) * Adds base for updating Microsoft.StorageCache from version stable/2021-05-01 to version 2021-09-01 * Updates readme * Updates API version in new specs and examples * 2021-09-01 API * Fix LintDiff Co-authored-by: rebecca337 <[email protected]> Co-authored-by: Rebecca Dupuis <[email protected]> * Fix S360 bugs for swagger FSPG 2020-02-14-preview, 2021-06-01-preview and 2021-06-01 APIs (Azure#15946) * Changed FSPG RestartParameter.failoverMode from string to enum for API 2021-06-01, 2021-06-01-preview, and 2021-06-15-privatepreview * Change enum first letter to lower case * Change to upper case * Fix S360 bugs for swagger FSPG 2020-02-14-preview, 2021-06-01-preview and 2021-06-01 APIs * Add email reminder when PR makes changes in Synapse (Azure#16116) * add email reminder to synapse * fix for comment * ServiceBus add batch tag (Azure#16229) * add code owner to synapse (Azure#16230) * [Datafactory] Power Query model changes for multiple queries (Azure#16158) * [Synapse] Add release tag for management SDK Oct. release (Azure#16213) * update release tag * fix for avocado Co-authored-by: Tianen <[email protected]> Co-authored-by: Zhenglai Zhang <[email protected]> Co-authored-by: Lei Ni <[email protected]> Co-authored-by: najian <[email protected]> Co-authored-by: Nan Jiang <[email protected]> Co-authored-by: Ray Chen <[email protected]> Co-authored-by: Dongwei Wang <[email protected]> Co-authored-by: Dongwei Wang <[email protected]> Co-authored-by: msyyc <[email protected]> Co-authored-by: AriZavala2 <[email protected]> Co-authored-by: PingZhu2232 <[email protected]> Co-authored-by: Mark Cowlishaw <[email protected]> Co-authored-by: Ping Zhu <[email protected]> Co-authored-by: Mohit Chakraborty <[email protected]> Co-authored-by: Roslyn Lu <[email protected]> Co-authored-by: Roslyn Lu <[email protected]> Co-authored-by: JiahuiPeng <[email protected]> Co-authored-by: edwin-msft <[email protected]> Co-authored-by: Edwin Diaz <[email protected]> Co-authored-by: dochollidayxx <[email protected]> Co-authored-by: Adam Holliday <[email protected]> Co-authored-by: yifan-zhou922 <[email protected]> Co-authored-by: Parv Saxena <[email protected]> Co-authored-by: Parv Saxena <[email protected]> Co-authored-by: hvermis <[email protected]> Co-authored-by: xuepingd <[email protected]> Co-authored-by: laxmankumar12 <[email protected]> Co-authored-by: REDMOND\lakshv <[email protected]> Co-authored-by: He Huang <[email protected]> Co-authored-by: Zed Lei <[email protected]> Co-authored-by: kangsun-ctrl <[email protected]> Co-authored-by: brpanask <[email protected]> Co-authored-by: rebecca337 <[email protected]> Co-authored-by: Rebecca Dupuis <[email protected]> Co-authored-by: xunsun-commits <[email protected]> Co-authored-by: Wan Yang <[email protected]> Co-authored-by: soma-ms <[email protected]> * remove blank line * address comments * address the description comment * update the swagger * remove ManagedInstances_ListOutboundNetworkDependenciesByManagedInstance * Update from microsoft.sql 2021-05-01-preview to base branch (Azure#16184) * Update comment.yml for publish pr (Azure#16166) * Update comment.yml * Update comment.yml * Bump dependencies (Azure#16170) * bump avocado * bump mocha * remove submodule (Azure#16171) * add azure-resource-manager-schema to servicelinker (Azure#16176) Co-authored-by: Nan Jiang <[email protected]> * Update pr assignment config (Azure#16175) * [Synapse] - fix scheme for Artifacts and update readme to include KQL scripts for October release (Azure#16035) * [Synapse] - fix scheme for Notebook, Spark Job definition and SQL script * Update dataset, linked service and pipeline * Update release tag for october release * Correct type of result limit * Add arguments for SynapseSparkJobActivityTypeProperties Co-authored-by: Dongwei Wang <[email protected]> * fix (Azure#16164) Merging the change to have accurate Swagger * update swagger files * update readme.md * add missing json files * update custom-words.txt to address the spelling check * remove 201 define in ServerUpdate.json * remove blank line * address comments * address the description comment * update the swagger * remove ManagedInstances_ListOutboundNetworkDependenciesByManagedInstance Co-authored-by: Tianen <[email protected]> Co-authored-by: Zhenglai Zhang <[email protected]> Co-authored-by: Lei Ni <[email protected]> Co-authored-by: najian <[email protected]> Co-authored-by: Nan Jiang <[email protected]> Co-authored-by: Ray Chen <[email protected]> Co-authored-by: Dongwei Wang <[email protected]> Co-authored-by: Dongwei Wang <[email protected]> Co-authored-by: msyyc <[email protected]> Co-authored-by: Tianen <[email protected]> Co-authored-by: Zhenglai Zhang <[email protected]> Co-authored-by: Lei Ni <[email protected]> Co-authored-by: najian <[email protected]> Co-authored-by: Nan Jiang <[email protected]> Co-authored-by: Ray Chen <[email protected]> Co-authored-by: Dongwei Wang <[email protected]> Co-authored-by: Dongwei Wang <[email protected]> Co-authored-by: msyyc <[email protected]> Co-authored-by: AriZavala2 <[email protected]> Co-authored-by: PingZhu2232 <[email protected]> Co-authored-by: Mark Cowlishaw <[email protected]> Co-authored-by: Ping Zhu <[email protected]> Co-authored-by: Mohit Chakraborty <[email protected]> Co-authored-by: Roslyn Lu <[email protected]> Co-authored-by: Roslyn Lu <[email protected]> Co-authored-by: JiahuiPeng <[email protected]> Co-authored-by: edwin-msft <[email protected]> Co-authored-by: Edwin Diaz <[email protected]> Co-authored-by: dochollidayxx <[email protected]> Co-authored-by: Adam Holliday <[email protected]> Co-authored-by: yifan-zhou922 <[email protected]> Co-authored-by: Parv Saxena <[email protected]> Co-authored-by: Parv Saxena <[email protected]> Co-authored-by: hvermis <[email protected]> Co-authored-by: xuepingd <[email protected]> Co-authored-by: laxmankumar12 <[email protected]> Co-authored-by: REDMOND\lakshv <[email protected]> Co-authored-by: He Huang <[email protected]> Co-authored-by: Zed Lei <[email protected]> Co-authored-by: kangsun-ctrl <[email protected]> Co-authored-by: brpanask <[email protected]> Co-authored-by: rebecca337 <[email protected]> Co-authored-by: Rebecca Dupuis <[email protected]> Co-authored-by: xunsun-commits <[email protected]> Co-authored-by: Wan Yang <[email protected]> Co-authored-by: soma-ms <[email protected]>

July Release Search SDK Code Changes

cb2cdda

sarangan12 requested review from bterlson, chradek and xirzec as code owners July 6, 2021 18:06

ghost added the Search label Jul 6, 2021

sarangan12 added 2 commits July 6, 2021 16:00

Changes Part II

104d468

Update Changelog

9f64b28

sarangan12 changed the title ~~TEST PR~~ July Release Search SDK Code Changes Jul 6, 2021

ramya-rao-a reviewed Jul 7, 2021

View reviewed changes

xirzec approved these changes Jul 7, 2021

View reviewed changes

Minor update to changelog

3deeb55

sarangan12 merged commit d5d8b97 into Azure:main Jul 7, 2021

openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-js that referenced this pull request Sep 29, 2021

CodeGen from PR 16227 in Azure/azure-rest-api-specs

ae26ca4

Fixed an event name typo in its description. (Azure#16227)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

July Release Search SDK Code Changes #16227

July Release Search SDK Code Changes #16227

sarangan12 commented Jul 6, 2021 •

edited

Loading

ramya-rao-a Jul 7, 2021

sarangan12 Jul 7, 2021

xirzec left a comment

xirzec Jul 7, 2021

sarangan12 Jul 7, 2021

xirzec Jul 7, 2021

xirzec Jul 7, 2021

sarangan12 Jul 7, 2021

xirzec Jul 7, 2021

sarangan12 Jul 7, 2021

check-enforcer bot commented Jul 7, 2021

sarangan12 commented Jul 7, 2021

July Release Search SDK Code Changes #16227

July Release Search SDK Code Changes #16227

Conversation

sarangan12 commented Jul 6, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xirzec left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

check-enforcer bot commented Jul 7, 2021

What is Check Enforcer?

Why am I getting this message?

What should I do now?

What if I am onboarding a new service?

sarangan12 commented Jul 7, 2021

sarangan12 commented Jul 6, 2021 •

edited

Loading