Skip to content

Commit 8827844

Browse files
authored
Merge pull request #107344 from HeidiSteen/heidist-api
[Azure Cognitive Search] TOC and version bump (management REST API)
2 parents 354023f + dc620f6 commit 8827844

File tree

5 files changed

+23
-23
lines changed

5 files changed

+23
-23
lines changed

articles/search/TOC.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@
361361
href: /rest/api/searchservice
362362
- name: Search 2019-05-06-Preview
363363
href: /rest/api/searchservice/index-2019-05-06-preview
364-
- name: Management 2015-08-15
364+
- name: Management 2020-03-13
365365
href: /rest/api/searchmanagement
366366
- name: Management 2019-10-01-Preview
367367
href: /rest/api/searchmanagement/index-2019-10-01-preview

articles/search/search-api-versions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ As a rule, the Azure Cognitive Search team publishes new versions only when nece
2020
The same rule applies for SDK updates. The Azure Cognitive Search SDK follows the [semantic versioning](https://semver.org/) rules, which means that its version has three parts: major, minor, and build number (for example, 1.1.0). A new major version of the SDK is released only for changes that break backward compatibility. Non-breaking feature updates will increment the minor version, and bug fixes will only increase the build version.
2121

2222
> [!NOTE]
23-
> Your Azure Cognitive Search service instance supports several REST API versions, including the latest one. You can continue to use a version when it is no longer the latest one, but we recommend that you migrate your code to use the newest version. When using the REST API, you must specify the API version in every request via the api-version parameter. When using the .NET SDK, the version of the SDK youre using determines the corresponding version of the REST API. If you are using an older SDK, you can continue to run that code with no changes even if the service is upgraded to support a newer API version.
23+
> Your Azure Cognitive Search service instance supports several REST API versions, including the latest one. You can continue to use a version when it is no longer the latest one, but we recommend that you migrate your code to use the newest version. When using the REST API, you must specify the API version in every request via the api-version parameter. When using the .NET SDK, the version of the SDK you're using determines the corresponding version of the REST API. If you are using an older SDK, you can continue to run that code with no changes even if the service is upgraded to support a newer API version.
2424
2525
## Snapshot of current versions
2626
Below is a snapshot of the current versions of all programming interfaces to Azure Cognitive Search.
@@ -33,7 +33,7 @@ Below is a snapshot of the current versions of all programming interfaces to Azu
3333
| [Service REST API](https://docs.microsoft.com/rest/api/searchservice/) |2019-05-06 |Generally Available |
3434
| [Service REST API 2019-05-06-Preview](search-api-preview.md) |2019-05-06-Preview |Preview |
3535
| [.NET Management SDK](https://aka.ms/search-mgmt-sdk) |3.0 |Generally Available |
36-
| [Management REST API](https://docs.microsoft.com/rest/api/searchmanagement/) |2015-08-19 |Generally Available |
36+
| [Management REST API](https://docs.microsoft.com/rest/api/searchmanagement/) |2020-03-13|Generally Available |
3737

3838
For the REST APIs, including the `api-version` on each call is required. Using `api-version` makes it easy to target a specific version, such as a preview API. The following example illustrates how the `api-version` parameter is specified:
3939

@@ -47,7 +47,7 @@ For the REST APIs, including the `api-version` on each call is required. Using `
4747
Generally available (or GA) APIs can be used in production and are subject to Azure service level agreements. Preview versions have experimental features that are not always migrated to a GA version. **You are strongly advised to avoid using preview APIs in production applications.**
4848

4949
## Update to the latest version of the REST API by October 15, 2020
50-
The following versions of the Azure Cognitive Search REST API will be retired and no longer supported as of October 15, 2020: **2014-07-31-Preview**, **2014-10-20-Preview**, **2015-02-28-Preview**, and **2015-02-28**. In addition, versions of the Azure Cognitive Search .Net SDK older than **3.0.0-rc** will also be retired since they target one of these REST API versions. After this date, applications that use any of the deprecated REST API or SDK versions will no longer work and must be upgraded. As with any change of this type, we are giving 12 months' notice, so you have adequate time to adjust. To continue using Azure Cognitive Search, please migrate existing code that targets the [REST API](search-api-migration.md) to [REST API version 2019-05-06](https://docs.microsoft.com/rest/api/searchservice/) or newer or the .Net SDK to [version 3.0](search-dotnet-sdk-migration.md) or newer by October 15, 2020. If you have any questions about updating to the latest version, please send mail to [email protected] by May 15, 2020 to ensure you have enough time to update your code.
50+
The following versions of the Azure Cognitive Search REST API will be retired and no longer supported as of October 15, 2020: **2014-07-31-Preview**, **2014-10-20-Preview**, **2015-02-28-Preview**, and **2015-02-28**. In addition, versions of the Azure Cognitive Search .NET SDK older than **3.0.0-rc** will also be retired since they target one of these REST API versions. After this date, applications that use any of the deprecated REST API or SDK versions will no longer work and must be upgraded. As with any change of this type, we are giving 12 months' notice, so you have adequate time to adjust. To continue using Azure Cognitive Search, please migrate existing code that targets the [REST API](search-api-migration.md) to [REST API version 2019-05-06](https://docs.microsoft.com/rest/api/searchservice/) or newer or the .NET SDK to [version 3.0](search-dotnet-sdk-migration.md) or newer by October 15, 2020. If you have any questions about updating to the latest version, please send mail to [email protected] by May 15, 2020 to ensure you have enough time to update your code.
5151

5252
## About Preview and Generally Available versions
5353
Azure Cognitive Search always pre-releases experimental features through the REST API first, then through prerelease versions of the .NET SDK.

0 commit comments

Comments
 (0)