azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Dev search microsoft.search 2022 09 01
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
- What's the purpose of the update?
- [ ] new service onboarding
- [X] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
It is already deployed to production environment, It has been tested in canary.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
As soon as possible, may be January 2023?
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [X] I commit to follow the Breaking Change Policy of "no breaking changes"
- [X] I have reviewed the documentation for the workflow.
- [X] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
Otherwise your PR may be subject to ARM review requirements. Complete the following:
-
[X] Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] 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. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
-
[X] 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.
-
[X] 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.
Hi, @enjaimes Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @enjaimes your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 17 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| search.json | 2022-09-01(63d6de9) | 2020-08-01(main) |
| search.json | 2022-09-01(63d6de9) | 2021-04-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 2 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-09 | package-2022-09(63d6de9) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: PutRequestResponseScheme | A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Services_CreateOrUpdate' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.Search/stable/2022-09-01/search.json#L361 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Search/stable/2022-09-01/search.json#L2122 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.Search/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Search/stable/2022-09-01/search.json#L57 |
|
The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/stable/2022-09-01/search.json#L73 |
|
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.Search/stable/2022-09-01/search.json#L121 |
|
The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/stable/2022-09-01/search.json#L121 |
|
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.Search/stable/2022-09-01/search.json#L196 |
|
The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/stable/2022-09-01/search.json#L196 |
|
The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/stable/2022-09-01/search.json#L251 |
|
The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/stable/2022-09-01/search.json#L302 |
|
Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Search/stable/2022-09-01/search.json#L348 |
|
The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/stable/2022-09-01/search.json#L360 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Search/stable/2022-09-01/search.json#L361 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.Search/stable/2022-09-01/search.json#L488 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.Search/stable/2022-09-01/search.json#L488 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.Search/stable/2022-09-01/search.json#L488 |
|
Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Search/stable/2022-09-01/search.json#L606 |
|
The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/stable/2022-09-01/search.json#L666 |
|
The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/stable/2022-09-01/search.json#L717 |
|
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/stable/2022-09-01/search.json#L717 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Search/stable/2022-09-01/search.json#L859 |
|
The delete response body must be empty. Location: Microsoft.Search/stable/2022-09-01/search.json#L862 |
|
Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Search/stable/2022-09-01/search.json#L866 |
|
The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/stable/2022-09-01/search.json#L878 |
|
The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/stable/2022-09-01/search.json#L929 |
|
The resource name parameter 'sharedPrivateLinkResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/stable/2022-09-01/search.json#L929 |
|
A 'put' operation 'SharedPrivateLinkResources_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.Search/stable/2022-09-01/search.json#L930 |
|
An async PUT operation must return 201. Location: Microsoft.Search/stable/2022-09-01/search.json#L977 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.Search/stable/2022-09-01/search.json#L984 |
|
A 202 response should include an Location response header. Location: Microsoft.Search/stable/2022-09-01/search.json#L984 |
|
An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Search/stable/2022-09-01/search.json#L1044 |
|
A 202 response should include an Location response header. Location: Microsoft.Search/stable/2022-09-01/search.json#L1083 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 25 Errors, 0 Warnings failed [Detail]
Tag package-2022-09; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 22, untested: 0, failed: 12, passed: 10
Service API Readiness Test failed. Check pipeline artifact for detail report.
| Rule | Message |
|---|---|
|
"Enum does not match case for: Enabled" |
|
"Additional properties not allowed: bypass" |
|
"Additional properties not allowed: eTag" |
|
"Enum does not match case for: Enabled" |
|
"Additional properties not allowed: bypass" |
|
"Additional properties not allowed: eTag" |
|
"Enum does not match case for: Enabled" |
|
"Additional properties not allowed: bypass" |
|
"Enum does not match case for: Enabled" |
|
"Additional properties not allowed: bypass" |
|
"statusCode: 400, errorCode: Unknown, errorMessage: "error":"code":"", "message":"Service update operations are not allowed at this time" RequestId: aedf4a36-b6b8-49ed-951b-58493a8d357b" |
|
"statusCode: 404, errorCode: undefined, errorMessage: undefined" |
|
"Invalid Content-Type (application/octet-stream). These are supported: application/json" |
|
"Body is required in response but not provided" |
|
"statusCode: 404, errorCode: undefined, errorMessage: undefined" |
|
"Invalid Content-Type (application/octet-stream). These are supported: application/json" |
|
"Body is required in response but not provided" |
|
"Additional properties not allowed: isDataAction" |
|
"Additional properties not allowed: origin" |
|
"Additional properties not allowed: properties" |
|
"statusCode: 500, errorCode: InternalServerError, errorMessage: An error has occured. RequestId: 221d661d-8965-46d0-adac-71b376c1e44d" |
|
"statusCode: 400, errorCode: , errorMessage: Invalid value specified for the 'keyKind' parameter. Please specify either 'primary' or 'secondary'.\r\nParameter name: keyKind" |
|
"No enum match for: keykindzu9ite" |
|
"statusCode: 404, errorCode: undefined, errorMessage: undefined" |
|
"statusCode: 400, errorCode: BadRequest, errorMessage: Cannot delete shared private link resource 'sharedpr8eploj' as it is still being provisioned. Try again later. RequestId: 31841a7e-3079-408c-b5b7-3156c9cae2c8" |
️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 20450db14856ccac2af2c28de56fd436c63bb726. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
️✔️Azure.ResourceManager.Search [View full logs] [Release SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from 20450db14856ccac2af2c28de56fd436c63bb726. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] notice cmderr [automation_generate.sh] npm notice New major version of npm available! 8.19.2 -> 9.3.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.3.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-search [View full logs] [Release SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Model PrivateEndpointConnectionProperties has a new parameter group_id info [Changelog] - Model PrivateEndpointConnectionProperties has a new parameter provisioning_state info [Changelog] - Model SearchService has a new parameter auth_options info [Changelog] - Model SearchService has a new parameter disable_local_auth info [Changelog] - Model SearchService has a new parameter encryption_with_cmk info [Changelog] - Model SearchServiceUpdate has a new parameter auth_options info [Changelog] - Model SearchServiceUpdate has a new parameter disable_local_auth info [Changelog] - Model SearchServiceUpdate has a new parameter encryption_with_cmk
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs]Release - Generate from 20450db14856ccac2af2c28de56fd436c63bb726. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json cmderr [init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-search [View full logs] [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 20450db14856ccac2af2c28de56fd436c63bb726. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/search/armsearch [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Struct `CloudError` has been removed info [Changelog] - Struct `CloudErrorBody` has been removed info [Changelog] - Struct `ListQueryKeysResult` has been removed info [Changelog] - Struct `PrivateEndpointConnectionListResult` has been removed info [Changelog] - Struct `PrivateLinkResourcesResult` has been removed info [Changelog] - Struct `ServiceListResult` has been removed info [Changelog] - Struct `SharedPrivateLinkResourceListResult` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New value `SearchServiceStatusStopped` added to type alias `SearchServiceStatus` info [Changelog] - New type alias `AADAuthFailureMode` with values `AADAuthFailureModeHttp401WithBearerChallenge`, `AADAuthFailureModeHttp403` info [Changelog] - New type alias `PrivateLinkServiceConnectionProvisioningState` with values `PrivateLinkServiceConnectionProvisioningStateCanceled`, `PrivateLinkServiceConnectionProvisioningStateDeleting`, `PrivateLinkServiceConnectionProvisioningStateFailed`, `PrivateLinkServiceConnectionProvisioningStateIncomplete`, `PrivateLinkServiceConnectionProvisioningStateSucceeded`, `PrivateLinkServiceConnectionProvisioningStateUpdating` info [Changelog] - New type alias `SearchEncryptionComplianceStatus` with values `SearchEncryptionComplianceStatusCompliant`, `SearchEncryptionComplianceStatusNonCompliant` info [Changelog] - New type alias `SearchEncryptionWithCmk` with values `SearchEncryptionWithCmkDisabled`, `SearchEncryptionWithCmkEnabled`, `SearchEncryptionWithCmkUnspecified` info [Changelog] - New struct `DataPlaneAADOrAPIKeyAuthOption` info [Changelog] - New struct `DataPlaneAuthOptions` info [Changelog] - New struct `EncryptionWithCmk` info [Changelog] - New field `GroupID` in struct `PrivateEndpointConnectionProperties` info [Changelog] - New field `ProvisioningState` in struct `PrivateEndpointConnectionProperties` info [Changelog] - New field `AuthOptions` in struct `ServiceProperties` info [Changelog] - New field `DisableLocalAuth` in struct `ServiceProperties` info [Changelog] - New field `EncryptionWithCmk` in struct `ServiceProperties` info [Changelog] info [Changelog] Total 14 breaking change(s), 26 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 20450db14856ccac2af2c28de56fd436c63bb726. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️@azure/arm-search [View full logs] [Release SDK Changes]info [Changelog] **Features** info [Changelog] info [Changelog] - Added Interface DataPlaneAadOrApiKeyAuthOption info [Changelog] - Added Interface DataPlaneAuthOptions info [Changelog] - Added Interface EncryptionWithCmk info [Changelog] - Added Type Alias AadAuthFailureMode info [Changelog] - Added Type Alias PrivateLinkServiceConnectionProvisioningState info [Changelog] - Added Type Alias SearchEncryptionComplianceStatus info [Changelog] - Added Type Alias SearchEncryptionWithCmk info [Changelog] - Interface PrivateEndpointConnectionProperties has a new optional parameter groupId info [Changelog] - Interface PrivateEndpointConnectionProperties has a new optional parameter provisioningState info [Changelog] - Interface SearchService has a new optional parameter authOptions info [Changelog] - Interface SearchService has a new optional parameter disableLocalAuth info [Changelog] - Interface SearchService has a new optional parameter encryptionWithCmk info [Changelog] - Interface SearchServiceUpdate has a new optional parameter authOptions info [Changelog] - Interface SearchServiceUpdate has a new optional parameter disableLocalAuth info [Changelog] - Interface SearchServiceUpdate has a new optional parameter encryptionWithCmk info [Changelog] - Added Enum KnownPrivateLinkServiceConnectionProvisioningState
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs]Release - Generate from 20450db14856ccac2af2c28de56fd436c63bb726. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile warn File azure-resource-manager-schemas_tmp/initOutput.json not found to read command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
️✔️search [View full logs] [Release Schema Changes]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 20450db14856ccac2af2c28de56fd436c63bb726. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
️✔️Az.Search [View full logs] [Release SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/search/armsearch | https://apiview.dev/Assemblies/Review/454dd9f2f0cf4b51a249328889f7cb75 |
| .Net | Azure.ResourceManager.Search | https://apiview.dev/Assemblies/Review/8896f69d04054c659f775d457153330e |
| JavaScript | @azure/arm-search | https://apiview.dev/Assemblies/Review/1803a057e6e442c19fae4785a689f69a |
Hi, @enjaimes, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
