Add Semantic configuration to Azure Search specs#16642
Closed
shmed wants to merge 18 commits intoAzure:mainfrom
Closed
Add Semantic configuration to Azure Search specs#16642shmed wants to merge 18 commits intoAzure:mainfrom
shmed wants to merge 18 commits intoAzure:mainfrom
Conversation
* Add new 2.0-preview.1 version for IoT Central * fix typo on enum value * rollback 1.0 changes, applied 2.0-preview.1 * fix typo * remove non-used examples * fix style * update version from 2.0-preview.1 to 1.1-preview * update code review comments, fix patch consumes with json-patch support, fix examples for fileupload * add nextLink to collection of orgs * fix typo * fix wrong position of paging * fix the paging * add . to description * update default to use enum for api-version * add oct release with query, cde v2, device filter, device template filter, relationship, edge template, simplified template patching * update examples * fix lint error, model validation * fix missing type in examples, remove url format * fix ID case * fix id case * fix ID case * add iotc query language reference * fix typo
shmed
requested review from
AlexGhiondea,
Mohit-Chakraborty,
arv100kri,
bleroy and
brjohnstmsft
as code owners
|
Hi, @shmed 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 |
|
[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 Validation Report
|
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/7a003b0aa0def1a454ff0844fa4c6a276bc1ee53/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview", "details":"Command failed: node /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@Azure+oad@0.9.1/node_modules/autorest/dist/app.js /tmp/readme.oad.old.md --tag=oad-default-tag --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp\nFATAL: swagger-document/compose - FAILED\nFATAL: Error: '$["x-ms-parameterized-host"].hostTemplate' has incompatible values (---\n'endpoint/indexes(''indexName'')'\n, ---\n'endpoint'\n).\n Error: '$["x-ms-parameterized-host"].hostTemplate' has incompatible values (---\n'endpoint/indexes(''indexName'')'\n, ---\n'endpoint'\n).\n" |
️⚠️LintDiff: 1 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
| Rule | Message |
|---|---|
| The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L5857 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| The operation 'Indexers_Run' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L413 |
|
| 'keysOrIds' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L358 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️❌SpellCheck: 3 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Unknown word (Normway), please fix the error or add words to ./custom-words.txt path: Azure.Search/preview/2021-04-30-Preview/searchindex.json#L1780:65 |
|
Unknown word (Bulgary), please fix the error or add words to ./custom-words.txt path: Azure.Search/preview/2021-04-30-Preview/searchindex.json#L1785:65 |
|
Unknown word (Darussalam), please fix the error or add words to ./custom-words.txt path: Azure.Search/preview/2021-04-30-Preview/searchindex.json#L1805:68 |
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
Member
Author
|
@tjprescott / @dereklegenzoff - here's the new PR targeting main |
bleroy
approved these changes
Nov 3, 2021
shmed
changed the title
BevLoh
approved these changes
Nov 5, 2021
tjprescott
requested changes
Nov 5, 2021
Member
tjprescott
left a comment
tjprescott
left a comment
There was a problem hiding this comment.
Keeping my hold on this from the old PR. These are not names we can use in the SDK.
brjohnstmsft
reviewed
Nov 5, 2021
specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/searchindex.json
Show resolved
Hide resolved
tjprescott
approved these changes
Nov 15, 2021
Member
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Hi @shmed, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Member
|
Need to resolve the CI failures. There's an error about the parameterized host in https://dev.azure.com/azure-sdk/internal/_build/results?buildId=1195583&view=logs&j=98f87804-8e1f-5655-af02-e80aefa7aa97&t=8452b151-7122-5001-9e44-ba5cc52e601b&l=49 |
Contributor
|
Since @shmed is out this week and we want to get this change in quickly, I'll submit a new PR against main that fixes the spellcheck errors at hand. We can abandon this PR. |
25 tasks
Member
|
Closing since #16777 was merged. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
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.
This PR was originally reviewed here: #16257
Recreating it to target Azure:main instead of Azure:master.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for 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
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.
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 any of the following scenarios apply to the PR, request approval from the 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.