[DO NOT MERGE] Add normalizer to latest preview API #11954

robertklee · 2020-12-04T18:00:08Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

This PR exposes normalizers to the 2020-06-30-Preview API version. The docs links still need to be updated after they are written and published.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
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.

early 2021 (@ishansrivastava90 and @Yahnoosh to confirm)

When you expect to publish swagger? Please provide date, or month to public if date is not available yet.

early 2021 (@ishansrivastava90 and @Yahnoosh to confirm)

If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

(@ishansrivastava90 and @Yahnoosh to confirm)

Contribution checklist:

I commit to follow the Breaking Change Policy of “no breaking changes
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

handing off to @ishansrivastava90 (was not able to get autoRest command to work)

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.
- Adding new API(s)
- Adding a new API version
- Adding a new service
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 API Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

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.

openapi-pipeline-app · 2020-12-04T18:00:13Z

Swagger Validation Report

️❌BreakingChange: 5 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.1)
- original: preview/2020-06-30-Preview/searchservice.json <---> new: preview/2020-06-30-Preview/searchservice.json

Rule	Message
`❌` 1041 - AddedPropertyInResponse	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#L7034:7 Old: Azure.Search/preview/2020-06-30-Preview/searchservice.json#L6931:7
`❌` 1041 - AddedPropertyInResponse	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#L7034:7 Old: Azure.Search/preview/2020-06-30-Preview/searchservice.json#L6931:7
`❌` 1041 - AddedPropertyInResponse	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#L7034:7 Old: Azure.Search/preview/2020-06-30-Preview/searchservice.json#L6931:7
`❌` 1041 - AddedPropertyInResponse	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#L7034:7 Old: Azure.Search/preview/2020-06-30-Preview/searchservice.json#L6931:7
`❌` 1041 - AddedPropertyInResponse	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#L7034:7 Old: Azure.Search/preview/2020-06-30-Preview/searchservice.json#L6931:7

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.5.0 , classic-openapi-validator v1.1.4 )
- data-plane/Azure.Search/readme.md tag:package-2020-06-searchservice-preview
Linted configuring files (Based on target branch, openapi-validator v1.5.0 , classic-openapi-validator v1.1.4 )
- data-plane/Azure.Search/readme.md tag:package-2020-06-searchservice-preview

️️✔️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.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2020-12-04T18:00:14Z

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2020-12-04T18:01:16Z

Hi, @robertklee Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json

brjohnstmsft · 2020-12-04T20:42:57Z

specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json

@@ -2873,6 +2918,44 @@
        "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html"
      }
    },
+    "CustomNormalizer": {
+      "discriminator": "@odata.type",


There doesn't appear to be any polymorphism here, so why do you need a discriminator? Does our API even require @odata.type for normalizer definitions?

you're right, I don't think we need the discriminator right now. I'll remove.

We do need @odata.type for normalizer definitions. We only support #Microsoft.Azure.Search.CustomNormalizer right now.

brjohnstmsft · 2020-12-05T00:58:52Z

Let's hold off on merging this until the API changes are actually deployed.

robertklee · 2020-12-05T01:04:19Z

Sounds good

…

On Dec 4, 2020, at 4:59 PM, Bruce Johnston ***@***.***> wrote: Let's hold off on merging this until the API changes are actually deployed. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#11954 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AHXR3JQGWN27L5PETC7TZPTSTGAVRANCNFSM4UNYO7BQ>.

brjohnstmsft · 2020-12-11T16:27:13Z

Closing this since we're not ready to merge it yet (the feature hasn't been deployed). We'll re-open the PR once the changes are ready.

ishansrivastava90 · 2021-01-06T16:27:38Z

@brjohnstmsft Can you re-open this PR since the changes are checked in and scheduled for next deployment? It seems that I don't have reopening rights. T

robertklee · 2021-01-06T17:28:18Z

I don't see a re-open button on my end either. I might have to push an update (probably a rebase) to get the re-open button to show up.

Edit: rebasing didn't work.

brjohnstmsft · 2021-01-06T18:53:08Z

@ishansrivastava90 @robertklee I don't seem to have re-open rights either, but there's no rush -- This shouldn't be merged until the changes are deployed worldwide.

robertklee · 2021-01-06T19:19:19Z

@ishansrivastava90 @brjohnstmsft If you need me, feel free to ping me once you are ready by commenting here. I can open a new PR if re-open isn't working at that point. Exciting that it's going to deployment soon! :)

Robert Lee added 2 commits December 3, 2020 16:51

building blocks for normalizer feature

49eb7a6

update description fields for normalizers

5ecaf01

robertklee requested review from brjohnstmsft, ishansrivastava90 and Yahnoosh December 4, 2020 18:00

robertklee requested review from AlexGhiondea, arv100kri, bleroy and heaths as code owners December 4, 2020 18:00

robertklee assigned brjohnstmsft, ishansrivastava90 and Yahnoosh Dec 4, 2020

heaths requested a review from Mohit-Chakraborty December 4, 2020 18:59

heaths approved these changes Dec 4, 2020

View reviewed changes

specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json Outdated Show resolved Hide resolved

specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json Outdated Show resolved Hide resolved

Robert Lee added 2 commits December 4, 2020 12:17

update with placeholder urls

dfefca6

missed a url

a657d1a

brjohnstmsft suggested changes Dec 4, 2020

View reviewed changes

Robert Lee added 4 commits December 4, 2020 13:06

fix broken lucene link

702ab24

Add "LexicalNormalizer" base type for "CustomNormalizer", update $refs

32edbc9

fix space between lower & upper case

393503a

fix description of LexicalNormalizerName

22a2b30

robertklee requested a review from brjohnstmsft December 4, 2020 21:45

remove discriminator type

d12b8cb

ishansrivastava90 approved these changes Dec 4, 2020

View reviewed changes

brjohnstmsft approved these changes Dec 5, 2020

View reviewed changes

brjohnstmsft changed the title ~~Add normalizer to latest preview API~~ [DO NOT MERGE] Add normalizer to latest preview API Dec 5, 2020

brjohnstmsft closed this Dec 11, 2020

ishansrivastava90 mentioned this pull request Feb 24, 2021

Normalizer api specs #12983

Merged

25 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DO NOT MERGE] Add normalizer to latest preview API #11954

[DO NOT MERGE] Add normalizer to latest preview API #11954

robertklee commented Dec 4, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 4, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 4, 2020 •

edited

Loading

openapi-workflow-bot bot commented Dec 4, 2020

brjohnstmsft Dec 4, 2020

robertklee Dec 4, 2020 •

edited

Loading

robertklee Dec 4, 2020

brjohnstmsft commented Dec 5, 2020

robertklee commented Dec 5, 2020 via email

brjohnstmsft commented Dec 11, 2020

ishansrivastava90 commented Jan 6, 2021

robertklee commented Jan 6, 2021 •

edited

Loading

brjohnstmsft commented Jan 6, 2021

robertklee commented Jan 6, 2021

[DO NOT MERGE] Add normalizer to latest preview API #11954

[DO NOT MERGE] Add normalizer to latest preview API #11954

Conversation

robertklee commented Dec 4, 2020 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-pipeline-app bot commented Dec 4, 2020 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Dec 4, 2020 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented Dec 4, 2020

brjohnstmsft Dec 4, 2020

Choose a reason for hiding this comment

robertklee Dec 4, 2020 • edited Loading

Choose a reason for hiding this comment

robertklee Dec 4, 2020

Choose a reason for hiding this comment

brjohnstmsft commented Dec 5, 2020

robertklee commented Dec 5, 2020 via email

brjohnstmsft commented Dec 11, 2020

ishansrivastava90 commented Jan 6, 2021

robertklee commented Jan 6, 2021 • edited Loading

brjohnstmsft commented Jan 6, 2021

robertklee commented Jan 6, 2021

robertklee commented Dec 4, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 4, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 4, 2020 •

edited

Loading

robertklee Dec 4, 2020 •

edited

Loading

robertklee commented Jan 6, 2021 •

edited

Loading