forked from Azure/azure-rest-api-specs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Azure Search] Updating AutoRest config files (Azure#2465)
Fixed client name in the management plane config. Split the data plane config into three files: - readme.md: Contains the config settings common to both data plane specs. - readme.index.md: Contains config settings specific to SearchIndexClient. - readme.service.md: Contains config settings specific to SearchServiceClient. This was necessary in order to get the Swagger validator to run correctly, since otherwise it was combining the specs into one and crashing because they both contain x-ms-parameterized-host. The intent is to have separate specs, since the Azure Search data plane SDK is comprised of two separate clients (one statically-typed for the base resources, and one dynamically-typed for customer-specific index schemas).
- Loading branch information
1 parent
7a519c4
commit 7fc5160
Showing
4 changed files
with
160 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# SearchIndexClient | ||
|
||
> see https://aka.ms/autorest | ||
This is the AutoRest configuration file for SearchIndexClient. | ||
|
||
|
||
|
||
--- | ||
## Getting Started | ||
To build the SDK for SearchIndexClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: | ||
|
||
> `autorest --index` | ||
To see additional help and options, run: | ||
|
||
> `autorest --help` | ||
--- | ||
|
||
## Configuration | ||
|
||
### Tag: package-2016-09-preview | ||
|
||
These settings apply only when `--tag=package-2016-09-preview` is specified on the command line. | ||
|
||
``` yaml $(tag) == 'package-2016-09-preview' | ||
input-file: | ||
- Microsoft.Search/preview/2016-09-01-preview/searchindex.json | ||
``` | ||
### Tag: package-2016-09 | ||
These settings apply only when `--tag=package-2016-09` is specified on the command line. | ||
|
||
``` yaml $(tag) == 'package-2016-09' | ||
input-file: | ||
- Microsoft.Search/preview/2016-09-01/searchindex.json | ||
``` | ||
|
||
### Tag: package-2015-02-preview | ||
|
||
These settings apply only when `--tag=package-2015-02-preview` is specified on the command line. | ||
|
||
``` yaml $(tag) == 'package-2015-02-preview' | ||
input-file: | ||
- Microsoft.Search/preview/2015-02-28-preview/searchindex.json | ||
``` | ||
|
||
### Tag: package-2015-02 | ||
|
||
These settings apply only when `--tag=package-2015-02` is specified on the command line. | ||
|
||
``` yaml $(tag) == 'package-2015-02' | ||
input-file: | ||
- Microsoft.Search/preview/2015-02-28/searchindex.json | ||
``` | ||
|
||
|
||
--- | ||
# Code Generation | ||
|
||
!!! READ THIS !!! | ||
This swagger is not yet ready for languages other than C#. | ||
!!! READ THIS !!! | ||
|
||
## C# | ||
|
||
These settings apply only when `--csharp` is specified on the command line. | ||
Please also specify `--csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>`. | ||
|
||
``` yaml $(csharp) | ||
csharp: | ||
output-folder: $(csharp-sdks-folder)/Search/DataPlane/Microsoft.Azure.Search/GeneratedSearchIndex | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# SearchServiceClient | ||
|
||
> see https://aka.ms/autorest | ||
This is the AutoRest configuration file for SearchServiceClient. | ||
|
||
|
||
|
||
--- | ||
## Getting Started | ||
To build the SDK for SearchServiceClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: | ||
|
||
> `autorest --service` | ||
To see additional help and options, run: | ||
|
||
> `autorest --help` | ||
--- | ||
|
||
## Configuration | ||
|
||
### Tag: package-2016-09-preview | ||
|
||
These settings apply only when `--tag=package-2016-09-preview` is specified on the command line. | ||
|
||
``` yaml $(tag) == 'package-2016-09-preview' | ||
input-file: | ||
- Microsoft.Search/preview/2016-09-01-preview/searchservice.json | ||
``` | ||
### Tag: package-2016-09 | ||
These settings apply only when `--tag=package-2016-09` is specified on the command line. | ||
|
||
``` yaml $(tag) == 'package-2016-09' | ||
input-file: | ||
- Microsoft.Search/preview/2016-09-01/searchservice.json | ||
``` | ||
|
||
### Tag: package-2015-02-preview | ||
|
||
These settings apply only when `--tag=package-2015-02-preview` is specified on the command line. | ||
|
||
``` yaml $(tag) == 'package-2015-02-preview' | ||
input-file: | ||
- Microsoft.Search/preview/2015-02-28-preview/searchservice.json | ||
``` | ||
|
||
### Tag: package-2015-02 | ||
|
||
These settings apply only when `--tag=package-2015-02` is specified on the command line. | ||
|
||
``` yaml $(tag) == 'package-2015-02' | ||
input-file: | ||
- Microsoft.Search/preview/2015-02-28/searchservice.json | ||
``` | ||
|
||
|
||
--- | ||
# Code Generation | ||
|
||
!!! READ THIS !!! | ||
This swagger is not yet ready for languages other than C#. | ||
!!! READ THIS !!! | ||
|
||
## C# | ||
|
||
These settings apply only when `--csharp` is specified on the command line. | ||
Please also specify `--csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>`. | ||
|
||
``` yaml $(csharp) | ||
csharp: | ||
output-folder: $(csharp-sdks-folder)/Search/DataPlane/Microsoft.Azure.Search/GeneratedSearchService | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters