Normalizer api specs #12983
Merged
Normalizer api specs #12983
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
Merge Azure/azure-rest-api-specs into ishansrivastava90 fork
ishansrivastava90
requested review from
AlexGhiondea,
arv100kri,
bleroy,
brjohnstmsft and
heaths
as code owners
|
Hi, @ishansrivastava90 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 Validation Report
|
| Rule | Message |
|---|---|
|
The new version has a new property 'normalizers' in response that was not found in the old version. New: Azure.Search/preview/2020-06-30-Preview/searchservice.json#L7035:7 Old: Azure.Search/preview/2020-06-30-Preview/searchservice.json#L6932:7 |
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 125 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"search/data-plane/Azure.Search/readme.md", "tag":"package-2020-06-searchservice-preview", "details":"The schema 'AnalyzeRequest' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"search/data-plane/Azure.Search/readme.md", "tag":"package-2020-06-searchservice-preview", "details":"The schema 'AnalyzeResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"search/data-plane/Azure.Search/readme.md", "tag":"package-2020-06-searchservice-preview", "details":"The schema 'AnalyzedTokenInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"search/data-plane/Azure.Search/readme.md", "tag":"package-2020-06-searchservice-preview", "details":"The schema 'LexicalAnalyzer' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"search/data-plane/Azure.Search/readme.md", "tag":"package-2020-06-searchservice-preview", "details":"The schema 'CustomAnalyzer' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"search/data-plane/Azure.Search/readme.md", "tag":"package-2020-06-searchservice-preview", "details":"The schema 'PatternAnalyzer' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"search/data-plane/Azure.Search/readme.md", "tag":"package-2020-06-searchservice-preview", "details":"The schema 'LuceneStandardAnalyzer' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"search/data-plane/Azure.Search/readme.md", "tag":"package-2020-06-searchservice-preview", "details":"The schema 'StopAnalyzer' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"search/data-plane/Azure.Search/readme.md", "tag":"package-2020-06-searchservice-preview", "details":"The schema 'LexicalNormalizer' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"search/data-plane/Azure.Search/readme.md", "tag":"package-2020-06-searchservice-preview", "details":"The schema 'CustomNormalizer' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
|
@brjohnstmsft @heaths This PR mimics the one created earlier and was pending the feature to be deployed. |
|
@ishansrivastava90 Do you have a link to the other PR you mentioned? |
@brjohnstmsft Here's the original PR - |
brjohnstmsft
approved these changes
Feb 24, 2021
|
@Mohit-Chakraborty @heaths Checking in. Are there any updates on this change? |
Mohit-Chakraborty
approved these changes
Mar 3, 2021
|
@johanste , what do you think about the breaking nature of this change? |
@Mohit-Chakraborty |
|
@ishansrivastava90 Per the new breaking change guidelines, this would be considered a breaking change, if it were in a GA version. But since this is a preview version, I'm not sure why the build is even flagging this as anything other than a warning. |
|
New guidelines are that previews must be versioned and continue support for 90 days. That said, I know you've been operating this way "forever". @JeffreyRichter @johanste Search has been updating previews like this and we really haven't heard any customer complaints via the SDK. Is this okay to ignore the breaking change for adding an optional response property in a preview version? |
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
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
Please ensure to add changelog with this PR by answering the following questions.
What's the purpose of the update?
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
Public Preview in March 2021; Generally Available in mid-2021
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
March, 2021
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
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.