Microsoft.Search RP Supports New 2024-06-01-Preview API #29104
Merged
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
Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from preview/2024-03-01-preview to preview/2024-06-01-preview.
efrainretana
requested review from
tjacobhi,
conor-joplin and
BevLoh
as code owners
…into efrainretana/2024-06-01-Preview
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.9) | new version | base version |
|---|---|---|
| search.json | 2024-06-01-preview(a2fe037) | 2023-11-01(main) |
| search.json | 2024-06-01-preview(a2fe037) | 2024-03-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version is removing enum value(s) 'succeeded, provisioning, failed' from the old version. New: Microsoft.Search/preview/2024-06-01-preview/search.json#L2491:9 Old: Microsoft.Search/preview/2024-03-01-preview/search.json#L2485:9 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-preview-2024-06 | package-preview-2024-06(a2fe037) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L58 |
|
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L121 |
|
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L196 |
|
Synchronous delete operations must have responses with 200, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L303 |
|
Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L348 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L348 |
|
The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L360 |
|
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L510 |
|
Properties of a PATCH request body must not have default value, property:replicaCount. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L510 |
|
Properties of a PATCH request body must not have default value, property:partitionCount. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L510 |
|
Properties of a PATCH request body must not have default value, property:hostingMode. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L510 |
|
Properties of a PATCH request body must not have default value, property:publicNetworkAccess. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L510 |
|
Synchronous delete operations must have responses with 200, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L586 |
|
Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L624 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L624 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L722 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L736 |
|
provisioningState property must be set to readOnly. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L782 |
|
provisioningState property must be set to readOnly. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L831 |
|
Synchronous delete operations must have responses with 200, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L843 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L877 |
|
The delete response body must be empty. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L880 |
|
provisioningState property must be set to readOnly. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L880 |
|
Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L884 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L884 |
|
The resource name parameter 'sharedPrivateLinkResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L947 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L948 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L948 |
|
provisioningState property must be set to readOnly. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L998 |
|
A 202 response should include an Location response header. Location: Microsoft.Search/preview/2024-06-01-preview/search.json#L1002 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMReview
new-api-version
resource-manager
WaitForARMFeedback
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
This was referenced May 15, 2024
…source access rules
timothyta12
reviewed
May 16, 2024
specification/search/resource-manager/Microsoft.Search/preview/2024-06-01-preview/search.json
Outdated
Show resolved
Hide resolved
JeffreyRichter
added
the
BreakingChange-Approved-UserImpact
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
AzureRestAPISpecReview
added
the
WaitForARMFeedback
|
Awaiting review for ARM reviewer. Current position # 46. ETA: 5 days |
|
Current position # 45. ETA: 5 days |
|
Current position # 37. ETA: 4 days |
|
Received guidance from Razvan around updating our common types: We asked if it was possible to return null SystemData or omit from response while the implementation is complete. His suggestion: Don't upgrade common types until implementation is ready, as this can provide inaccurate data and some confusion (or not great experience). His suggestion was to upgrade to common type that does not use new system data properly (Such as v3). Unfortunately, we are trying to use v5 to make use of -> NSP definition, UserAssignedIdentity definition, and Resource definition which is only accessible in v5>=. |
…into efrainretana/2024-06-01-Preview
|
Current position # 28. ETA: 3 days |
razvanbadea-msft
added
the
ARMSignedOff
openapi-pipeline-app
bot
removed
the
WaitForARMFeedback
|
/pr RequestMerge |
razvanbadea-msft
approved these changes
May 25, 2024
Francisco-Gamino
pushed a commit
to Francisco-Gamino/azure-rest-api-specs
that referenced
this pull request
Jun 5, 2024
* Copy files from preview/2024-03-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-06-01-preview Updated the API version from preview/2024-03-01-preview to preview/2024-06-01-preview. * Added tag for 2024-06-01-preview in readme file * Add new features for bypass and resourceAccessRules * Prettier fixes * Accumulated fixes * Fix common types, error definition * typo in version * Update examples for provisioning state, add new update example for resource access rules * Add missing example ref * Remove resource access rules, unneeded. Update Bypass description * Fix casing * revert to v2 common types per guidance * revert to v2 common types per guidance
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.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.