[Azure Cognitive Search][Resource Manager]: Add Swagger API for 2021-04-01-Preview API version #14313
Conversation
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
|
Hi, @arv100kri 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. [email protected] |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L2155 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1992 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L2144 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response of operation:'Services_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L517 |
|
The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L771 |
|
The response of operation:'SharedPrivateLinkResources_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L990 |
|
The response of operation:'Services_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L344 |
|
The response of operation:'PrivateEndpointConnections_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L713 |
|
The response of operation:'SharedPrivateLinkResources_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L925 |
|
The response of operation:'Services_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L434 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L854 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1077 |
|
Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L331 |
️️✔️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: 4 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- current:preview/2021-04-01-preview/search.json compared with base:preview/2020-08-01-preview/search.json
- current:preview/2021-04-01-preview/search.json compared with base:stable/2020-08-01/search.json
| Rule | Message |
|---|---|
|
The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Search/preview/2021-04-01-preview/search.json#L1940:9 Old: Microsoft.Search/stable/2020-08-01/search.json#L1740:9 |
|
The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Search/preview/2021-04-01-preview/search.json#L2323:9 Old: Microsoft.Search/stable/2020-08-01/search.json#L1941:9 |
The following breaking changes are detected by comparison with latest preview version:
| Rule | Message |
|---|---|
|
The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Search/preview/2021-04-01-preview/search.json#L1940:9 Old: Microsoft.Search/preview/2020-08-01-preview/search.json#L1740:9 |
|
The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Search/preview/2021-04-01-preview/search.json#L2323:9 Old: Microsoft.Search/preview/2020-08-01-preview/search.json#L1941:9 |
️️✔️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
|:speech_balloon: AutorestCore/Exception|"readme":"search/resource-manager/readme.md",
"tag":"package-2021-04-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"search/resource-manager/readme.md",
"tag":"package-2021-04-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"search/resource-manager/readme.md",
"tag":"package-2021-04-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️[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).
|
[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 Generation Artifacts
|
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @arv100kri your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @ |
|
Hi @arv100kri, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced May 7, 2021
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
When you are ready for ARM review, please upgrade your PR from Draft to Open. |
majastrz
added
ARMChangesRequested
majastrz
added
ARMSignedOff
|
Hi @arv100kri, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
johanste
added
the
Approved-BreakingChange
ArcturusZhang
approved these changes
Jun 10, 2021
This was referenced Jun 10, 2021
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Jun 10, 2021
…agger API for 2021-04-01-Preview API version (#1751) Create to sync Azure/azure-rest-api-specs#14313 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/master...AzureSDKAutomation:sdkAuto/search?expand=1)
asager
pushed a commit
to asager/azure-rest-api-specs
that referenced
this pull request
Jun 24, 2021
…04-01-Preview API version (Azure#14313) * Add 2021-04-01-Preview as an exact copy of 2020-08-01-Preview * Add new properties to swagger * User Assigned Identity support * Semantic search * New auth options * Enforcement of CMK * Data exfiltration disablement * Fix-up of S360 violations * Add examples * Fix R2026 - AvoidAnonymousTypes for UserAssignedIdentities * Update readme files * Make public network access extensible enum * Case change byPass -> bypass * Make some enum values extensible Co-authored-by: Arvind Krishnaa Jagannathan <[email protected]>
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
…04-01-Preview API version (Azure#14313) * Add 2021-04-01-Preview as an exact copy of 2020-08-01-Preview * Add new properties to swagger * User Assigned Identity support * Semantic search * New auth options * Enforcement of CMK * Data exfiltration disablement * Fix-up of S360 violations * Add examples * Fix R2026 - AvoidAnonymousTypes for UserAssignedIdentities * Update readme files * Make public network access extensible enum * Case change byPass -> bypass * Make some enum values extensible Co-authored-by: Arvind Krishnaa Jagannathan <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Description of changes
Adding new properties that can be included during search service creation/update
Added a new property to the response of the
OperationsAPI that indicates whether an operation is a data plane operation or not.Please ensure to add changelog with 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
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from 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.