-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Search] Rename types for better SDK code #16039
Conversation
Hi, @Mohit-Chakraborty Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
Swagger pipeline can not start as the pull request has merge conflicts. |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger pipeline can not start as the pull request has merge conflicts. |
Swagger Validation Report
|
Rule | Message |
---|---|
Runtime Exception |
"new":"https://github.com/Azure/azure-rest-api-specs/blob/64569c4a979e29be21bc844179edc32b61167e6e/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview", "details":"Command failed: node /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@azure/oad@0.9.0/node_modules/autorest/dist/app.js /tmp/readme.oad.old.md --tag=oad-default-tag --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp\nFATAL: swagger-document/compose - FAILED\nFATAL: Error: '$["x-ms-parameterized-host"].hostTemplate' has incompatible values (---\n'endpoint/indexes(''indexName'')'\n, ---\n'endpoint'\n).\n Error: '$["x-ms-parameterized-host"].hostTemplate' has incompatible values (---\n'endpoint/indexes(''indexName'')'\n, ---\n'endpoint'\n).\n" |
️⚠️
LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
Rule | Message |
---|---|
The operation 'Indexers_Run' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L412 |
|
'keysOrIds' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L358 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
cc: @tg-msft |
specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/searchindex.json
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving for the enum type name changes.
Remove 'global' prefix from default flags on custom entities
Change property name storageContainer->storageContainerName
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm really happy we're making these changes in the swagger rather than per language!
@@ -1455,7 +1455,7 @@ | |||
"lexicon" | |||
], | |||
"x-ms-enum": { | |||
"name": "Speller", | |||
"name": "QuerySpellerType", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does Type
add anything to this name? Most enums are better without an extra Type
at the end.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are right - in our discussion we only decided on QueryAnswerType
rename for the Answers
parameter.
We have 3 params that are similar in nature and usage and it would be good to keep them consistently named - Speller
->QuerySpellerType
, Answers
->QueryAnswerType
and Captions
->QueryCaptionType
- all extensible enums.
One pro of adding the suffix Type
is that the param can otherwise be misunderstood as containing part of a result object. It is best illustrated for QueryAnswer
and QueryCaption
. We could leave the third as QuerySpeller
or tack on Type
there too to make all 3 names closely grouped.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tg-msft - what do you think?
Also, do you know how should I go forward with this PR with the validation errors regarding changes in an existing swagger? Do I need to send an email, or can I tag folks here?
specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/searchservice.json
Outdated
Show resolved
Hide resolved
I discussed the failures with 'Arthur Ning' and here is his reply - "Hi Mohit, it is known issue in tools, we are fixing it. if you are urgent, you can ignore it as seems rename enum type name is not a breaking for API. it is only impact SDK client. if not urgent, you can wait for few days which we may fix it." @lmazuel, may we go ahead and merge this PR? Any additional steps you suggest? |
* Update comment.yml for publish pr (#16166) * Update comment.yml * Update comment.yml * Bump dependencies (#16170) * bump avocado * bump mocha * remove submodule (#16171) * add azure-resource-manager-schema to servicelinker (#16176) Co-authored-by: Nan Jiang <naji@microsoft.com> * Update pr assignment config (#16175) * [Synapse] - fix scheme for Artifacts and update readme to include KQL scripts for October release (#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 <dongwwa@microsoft.com> * fix (#16164) Merging the change to have accurate Swagger * Remove requirement of identity field in the request for TURN. (#15966) * Remove requirement of identity field in the request. * Update PR * Address comment * change api version in readme for sdk release (#16187) * Add blockchain to latest profile * Add additional types * api version change Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Ping Zhu <pizh@Pings-MacBook-Pro.local> * [Search] Rename types for better SDK code (#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 (#16143) Co-authored-by: Roslyn Lu <roslu@microsoft.com> * Fix schemas readme files (#16207) * Fix schemas readme files * fix ref * add resourcemanager in module-name (#16206) * add resourcemanager in module-name * add go track2 repo in readme.md * fix * Minor description update for createorupdate & update slot (#15457) * add scmMinTlsVersion * modify description for createorupdate & update slot for all API versions Co-authored-by: Edwin Diaz <eddiazme@microsoft.com> * [Hub Generated] Review request for Microsoft.Security to add version preview/2021-08-01-preview (#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 <adamho@microsoft.com> * Yifanzhou/api version change (#16191) * remove Catalog * update 2021-05-01-preview * delete 2021-09-01 * Update readme.md * Update purviewcatalog.json * change read-only property (#16209) Co-authored-by: Parv Saxena <pasaxena@microsoft.com> * Update account.json - make CollectionReferece type writable (#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. (#16227) * Introduce new API version for Microsoft.ProviderHub 2021-09-01-preview (#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 <lakshv@microsoft.com> Co-authored-by: He Huang <47040595+hjhhh3000vitae@users.noreply.github.com> * fluidrelay_readme_config (#16192) fluidrelay_readme_config * Add community gallery proxy resource (#16043) * [Hub Generated] Public private branch 'dev-storagecache-Microsoft.StorageCache-2021-09-01' (#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 <80353400+rebecca337@users.noreply.github.com> Co-authored-by: Rebecca Dupuis <rdupuis@microsoft.com> * Fix S360 bugs for swagger FSPG 2020-02-14-preview, 2021-06-01-preview and 2021-06-01 APIs (#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 (#16116) * add email reminder to synapse * fix for comment * ServiceBus add batch tag (#16229) * add code owner to synapse (#16230) * [Datafactory] Power Query model changes for multiple queries (#16158) * [Synapse] Add release tag for management SDK Oct. release (#16213) * update release tag * fix for avocado Co-authored-by: Tianen <347142915@qq.com> Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com> Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> Co-authored-by: najian <jiangnan8924@gmail.com> Co-authored-by: Nan Jiang <naji@microsoft.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Dongwei Wang <bean0idear@163.com> Co-authored-by: Dongwei Wang <dongwwa@microsoft.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: AriZavala2 <77034370+AriZavala2@users.noreply.github.com> Co-authored-by: PingZhu2232 <36140352+PingZhu2232@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Ping Zhu <pizh@Pings-MacBook-Pro.local> Co-authored-by: Mohit Chakraborty <8271806+Mohit-Chakraborty@users.noreply.github.com> Co-authored-by: Roslyn Lu <roslyn.lu@gmail.com> Co-authored-by: Roslyn Lu <roslu@microsoft.com> Co-authored-by: JiahuiPeng <46921893+804873052@users.noreply.github.com> Co-authored-by: edwin-msft <71858592+edwin-msft@users.noreply.github.com> Co-authored-by: Edwin Diaz <eddiazme@microsoft.com> Co-authored-by: dochollidayxx <dochollidayxx@gmail.com> Co-authored-by: Adam Holliday <adamho@microsoft.com> Co-authored-by: yifan-zhou922 <78060542+yifan-zhou922@users.noreply.github.com> Co-authored-by: Parv Saxena <psaxena6@jhu.edu> Co-authored-by: Parv Saxena <pasaxena@microsoft.com> Co-authored-by: hvermis <hvermis@microsoft.com> Co-authored-by: xuepingd <75347475+xuepingd@users.noreply.github.com> Co-authored-by: laxmankumar12 <vlk_laxman@yahoo.com> Co-authored-by: REDMOND\lakshv <lakshv@microsoft.com> Co-authored-by: He Huang <47040595+hjhhh3000vitae@users.noreply.github.com> Co-authored-by: Zed Lei <59104634+RAY-316@users.noreply.github.com> Co-authored-by: kangsun-ctrl <69279251+kangsun-ctrl@users.noreply.github.com> Co-authored-by: brpanask <64860651+brpanask@users.noreply.github.com> Co-authored-by: rebecca337 <80353400+rebecca337@users.noreply.github.com> Co-authored-by: Rebecca Dupuis <rdupuis@microsoft.com> Co-authored-by: xunsun-commits <84804232+xunsun-commits@users.noreply.github.com> Co-authored-by: Wan Yang <wanyang@microsoft.com> Co-authored-by: soma-ms <84877933+soma-ms@users.noreply.github.com>
* 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 (#16236) * Update comment.yml for publish pr (#16166) * Update comment.yml * Update comment.yml * Bump dependencies (#16170) * bump avocado * bump mocha * remove submodule (#16171) * add azure-resource-manager-schema to servicelinker (#16176) Co-authored-by: Nan Jiang <naji@microsoft.com> * Update pr assignment config (#16175) * [Synapse] - fix scheme for Artifacts and update readme to include KQL scripts for October release (#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 <dongwwa@microsoft.com> * fix (#16164) Merging the change to have accurate Swagger * Remove requirement of identity field in the request for TURN. (#15966) * Remove requirement of identity field in the request. * Update PR * Address comment * change api version in readme for sdk release (#16187) * Add blockchain to latest profile * Add additional types * api version change Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Ping Zhu <pizh@Pings-MacBook-Pro.local> * [Search] Rename types for better SDK code (#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 (#16143) Co-authored-by: Roslyn Lu <roslu@microsoft.com> * Fix schemas readme files (#16207) * Fix schemas readme files * fix ref * add resourcemanager in module-name (#16206) * add resourcemanager in module-name * add go track2 repo in readme.md * fix * Minor description update for createorupdate & update slot (#15457) * add scmMinTlsVersion * modify description for createorupdate & update slot for all API versions Co-authored-by: Edwin Diaz <eddiazme@microsoft.com> * [Hub Generated] Review request for Microsoft.Security to add version preview/2021-08-01-preview (#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 <adamho@microsoft.com> * Yifanzhou/api version change (#16191) * remove Catalog * update 2021-05-01-preview * delete 2021-09-01 * Update readme.md * Update purviewcatalog.json * change read-only property (#16209) Co-authored-by: Parv Saxena <pasaxena@microsoft.com> * Update account.json - make CollectionReferece type writable (#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. (#16227) * Introduce new API version for Microsoft.ProviderHub 2021-09-01-preview (#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 <lakshv@microsoft.com> Co-authored-by: He Huang <47040595+hjhhh3000vitae@users.noreply.github.com> * fluidrelay_readme_config (#16192) fluidrelay_readme_config * Add community gallery proxy resource (#16043) * [Hub Generated] Public private branch 'dev-storagecache-Microsoft.StorageCache-2021-09-01' (#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 <80353400+rebecca337@users.noreply.github.com> Co-authored-by: Rebecca Dupuis <rdupuis@microsoft.com> * Fix S360 bugs for swagger FSPG 2020-02-14-preview, 2021-06-01-preview and 2021-06-01 APIs (#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 (#16116) * add email reminder to synapse * fix for comment * ServiceBus add batch tag (#16229) * add code owner to synapse (#16230) * [Datafactory] Power Query model changes for multiple queries (#16158) * [Synapse] Add release tag for management SDK Oct. release (#16213) * update release tag * fix for avocado Co-authored-by: Tianen <347142915@qq.com> Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com> Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> Co-authored-by: najian <jiangnan8924@gmail.com> Co-authored-by: Nan Jiang <naji@microsoft.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Dongwei Wang <bean0idear@163.com> Co-authored-by: Dongwei Wang <dongwwa@microsoft.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: AriZavala2 <77034370+AriZavala2@users.noreply.github.com> Co-authored-by: PingZhu2232 <36140352+PingZhu2232@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Ping Zhu <pizh@Pings-MacBook-Pro.local> Co-authored-by: Mohit Chakraborty <8271806+Mohit-Chakraborty@users.noreply.github.com> Co-authored-by: Roslyn Lu <roslyn.lu@gmail.com> Co-authored-by: Roslyn Lu <roslu@microsoft.com> Co-authored-by: JiahuiPeng <46921893+804873052@users.noreply.github.com> Co-authored-by: edwin-msft <71858592+edwin-msft@users.noreply.github.com> Co-authored-by: Edwin Diaz <eddiazme@microsoft.com> Co-authored-by: dochollidayxx <dochollidayxx@gmail.com> Co-authored-by: Adam Holliday <adamho@microsoft.com> Co-authored-by: yifan-zhou922 <78060542+yifan-zhou922@users.noreply.github.com> Co-authored-by: Parv Saxena <psaxena6@jhu.edu> Co-authored-by: Parv Saxena <pasaxena@microsoft.com> Co-authored-by: hvermis <hvermis@microsoft.com> Co-authored-by: xuepingd <75347475+xuepingd@users.noreply.github.com> Co-authored-by: laxmankumar12 <vlk_laxman@yahoo.com> Co-authored-by: REDMOND\lakshv <lakshv@microsoft.com> Co-authored-by: He Huang <47040595+hjhhh3000vitae@users.noreply.github.com> Co-authored-by: Zed Lei <59104634+RAY-316@users.noreply.github.com> Co-authored-by: kangsun-ctrl <69279251+kangsun-ctrl@users.noreply.github.com> Co-authored-by: brpanask <64860651+brpanask@users.noreply.github.com> Co-authored-by: rebecca337 <80353400+rebecca337@users.noreply.github.com> Co-authored-by: Rebecca Dupuis <rdupuis@microsoft.com> Co-authored-by: xunsun-commits <84804232+xunsun-commits@users.noreply.github.com> Co-authored-by: Wan Yang <wanyang@microsoft.com> Co-authored-by: soma-ms <84877933+soma-ms@users.noreply.github.com> * 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 (#16184) * Update comment.yml for publish pr (#16166) * Update comment.yml * Update comment.yml * Bump dependencies (#16170) * bump avocado * bump mocha * remove submodule (#16171) * add azure-resource-manager-schema to servicelinker (#16176) Co-authored-by: Nan Jiang <naji@microsoft.com> * Update pr assignment config (#16175) * [Synapse] - fix scheme for Artifacts and update readme to include KQL scripts for October release (#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 <dongwwa@microsoft.com> * fix (#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 <347142915@qq.com> Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com> Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> Co-authored-by: najian <jiangnan8924@gmail.com> Co-authored-by: Nan Jiang <naji@microsoft.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Dongwei Wang <bean0idear@163.com> Co-authored-by: Dongwei Wang <dongwwa@microsoft.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: Tianen <347142915@qq.com> Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com> Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> Co-authored-by: najian <jiangnan8924@gmail.com> Co-authored-by: Nan Jiang <naji@microsoft.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Dongwei Wang <bean0idear@163.com> Co-authored-by: Dongwei Wang <dongwwa@microsoft.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: AriZavala2 <77034370+AriZavala2@users.noreply.github.com> Co-authored-by: PingZhu2232 <36140352+PingZhu2232@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Ping Zhu <pizh@Pings-MacBook-Pro.local> Co-authored-by: Mohit Chakraborty <8271806+Mohit-Chakraborty@users.noreply.github.com> Co-authored-by: Roslyn Lu <roslyn.lu@gmail.com> Co-authored-by: Roslyn Lu <roslu@microsoft.com> Co-authored-by: JiahuiPeng <46921893+804873052@users.noreply.github.com> Co-authored-by: edwin-msft <71858592+edwin-msft@users.noreply.github.com> Co-authored-by: Edwin Diaz <eddiazme@microsoft.com> Co-authored-by: dochollidayxx <dochollidayxx@gmail.com> Co-authored-by: Adam Holliday <adamho@microsoft.com> Co-authored-by: yifan-zhou922 <78060542+yifan-zhou922@users.noreply.github.com> Co-authored-by: Parv Saxena <psaxena6@jhu.edu> Co-authored-by: Parv Saxena <pasaxena@microsoft.com> Co-authored-by: hvermis <hvermis@microsoft.com> Co-authored-by: xuepingd <75347475+xuepingd@users.noreply.github.com> Co-authored-by: laxmankumar12 <vlk_laxman@yahoo.com> Co-authored-by: REDMOND\lakshv <lakshv@microsoft.com> Co-authored-by: He Huang <47040595+hjhhh3000vitae@users.noreply.github.com> Co-authored-by: Zed Lei <59104634+RAY-316@users.noreply.github.com> Co-authored-by: kangsun-ctrl <69279251+kangsun-ctrl@users.noreply.github.com> Co-authored-by: brpanask <64860651+brpanask@users.noreply.github.com> Co-authored-by: rebecca337 <80353400+rebecca337@users.noreply.github.com> Co-authored-by: Rebecca Dupuis <rdupuis@microsoft.com> Co-authored-by: xunsun-commits <84804232+xunsun-commits@users.noreply.github.com> Co-authored-by: Wan Yang <wanyang@microsoft.com> Co-authored-by: soma-ms <84877933+soma-ms@users.noreply.github.com>
* 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
* 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 <naji@microsoft.com> * 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 <dongwwa@microsoft.com> * 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 <markcowl@microsoft.com> Co-authored-by: Ping Zhu <pizh@Pings-MacBook-Pro.local> * [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 <roslu@microsoft.com> * 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 <eddiazme@microsoft.com> * [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 <adamho@microsoft.com> * 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 <pasaxena@microsoft.com> * 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 <lakshv@microsoft.com> Co-authored-by: He Huang <47040595+hjhhh3000vitae@users.noreply.github.com> * 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 <80353400+rebecca337@users.noreply.github.com> Co-authored-by: Rebecca Dupuis <rdupuis@microsoft.com> * 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 <347142915@qq.com> Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com> Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> Co-authored-by: najian <jiangnan8924@gmail.com> Co-authored-by: Nan Jiang <naji@microsoft.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Dongwei Wang <bean0idear@163.com> Co-authored-by: Dongwei Wang <dongwwa@microsoft.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: AriZavala2 <77034370+AriZavala2@users.noreply.github.com> Co-authored-by: PingZhu2232 <36140352+PingZhu2232@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Ping Zhu <pizh@Pings-MacBook-Pro.local> Co-authored-by: Mohit Chakraborty <8271806+Mohit-Chakraborty@users.noreply.github.com> Co-authored-by: Roslyn Lu <roslyn.lu@gmail.com> Co-authored-by: Roslyn Lu <roslu@microsoft.com> Co-authored-by: JiahuiPeng <46921893+804873052@users.noreply.github.com> Co-authored-by: edwin-msft <71858592+edwin-msft@users.noreply.github.com> Co-authored-by: Edwin Diaz <eddiazme@microsoft.com> Co-authored-by: dochollidayxx <dochollidayxx@gmail.com> Co-authored-by: Adam Holliday <adamho@microsoft.com> Co-authored-by: yifan-zhou922 <78060542+yifan-zhou922@users.noreply.github.com> Co-authored-by: Parv Saxena <psaxena6@jhu.edu> Co-authored-by: Parv Saxena <pasaxena@microsoft.com> Co-authored-by: hvermis <hvermis@microsoft.com> Co-authored-by: xuepingd <75347475+xuepingd@users.noreply.github.com> Co-authored-by: laxmankumar12 <vlk_laxman@yahoo.com> Co-authored-by: REDMOND\lakshv <lakshv@microsoft.com> Co-authored-by: He Huang <47040595+hjhhh3000vitae@users.noreply.github.com> Co-authored-by: Zed Lei <59104634+RAY-316@users.noreply.github.com> Co-authored-by: kangsun-ctrl <69279251+kangsun-ctrl@users.noreply.github.com> Co-authored-by: brpanask <64860651+brpanask@users.noreply.github.com> Co-authored-by: rebecca337 <80353400+rebecca337@users.noreply.github.com> Co-authored-by: Rebecca Dupuis <rdupuis@microsoft.com> Co-authored-by: xunsun-commits <84804232+xunsun-commits@users.noreply.github.com> Co-authored-by: Wan Yang <wanyang@microsoft.com> Co-authored-by: soma-ms <84877933+soma-ms@users.noreply.github.com> * 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 <naji@microsoft.com> * 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 <dongwwa@microsoft.com> * 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 <347142915@qq.com> Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com> Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> Co-authored-by: najian <jiangnan8924@gmail.com> Co-authored-by: Nan Jiang <naji@microsoft.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Dongwei Wang <bean0idear@163.com> Co-authored-by: Dongwei Wang <dongwwa@microsoft.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: Tianen <347142915@qq.com> Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com> Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> Co-authored-by: najian <jiangnan8924@gmail.com> Co-authored-by: Nan Jiang <naji@microsoft.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Dongwei Wang <bean0idear@163.com> Co-authored-by: Dongwei Wang <dongwwa@microsoft.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: AriZavala2 <77034370+AriZavala2@users.noreply.github.com> Co-authored-by: PingZhu2232 <36140352+PingZhu2232@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Ping Zhu <pizh@Pings-MacBook-Pro.local> Co-authored-by: Mohit Chakraborty <8271806+Mohit-Chakraborty@users.noreply.github.com> Co-authored-by: Roslyn Lu <roslyn.lu@gmail.com> Co-authored-by: Roslyn Lu <roslu@microsoft.com> Co-authored-by: JiahuiPeng <46921893+804873052@users.noreply.github.com> Co-authored-by: edwin-msft <71858592+edwin-msft@users.noreply.github.com> Co-authored-by: Edwin Diaz <eddiazme@microsoft.com> Co-authored-by: dochollidayxx <dochollidayxx@gmail.com> Co-authored-by: Adam Holliday <adamho@microsoft.com> Co-authored-by: yifan-zhou922 <78060542+yifan-zhou922@users.noreply.github.com> Co-authored-by: Parv Saxena <psaxena6@jhu.edu> Co-authored-by: Parv Saxena <pasaxena@microsoft.com> Co-authored-by: hvermis <hvermis@microsoft.com> Co-authored-by: xuepingd <75347475+xuepingd@users.noreply.github.com> Co-authored-by: laxmankumar12 <vlk_laxman@yahoo.com> Co-authored-by: REDMOND\lakshv <lakshv@microsoft.com> Co-authored-by: He Huang <47040595+hjhhh3000vitae@users.noreply.github.com> Co-authored-by: Zed Lei <59104634+RAY-316@users.noreply.github.com> Co-authored-by: kangsun-ctrl <69279251+kangsun-ctrl@users.noreply.github.com> Co-authored-by: brpanask <64860651+brpanask@users.noreply.github.com> Co-authored-by: rebecca337 <80353400+rebecca337@users.noreply.github.com> Co-authored-by: Rebecca Dupuis <rdupuis@microsoft.com> Co-authored-by: xunsun-commits <84804232+xunsun-commits@users.noreply.github.com> Co-authored-by: Wan Yang <wanyang@microsoft.com> Co-authored-by: soma-ms <84877933+soma-ms@users.noreply.github.com>
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.