Update WebApiSkill Model with authResourceId #16592

andrea-mccool · 2021-10-29T00:13:47Z

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:

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 are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the 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 refresh required for updates in this PR

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?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

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.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] 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.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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-workflow-bot · 2021-10-29T00:13:50Z

Hi, @andrea-mccool 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.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

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. vsswagger@microsoft.com

openapi-workflow-bot · 2021-10-29T00:13:50Z

[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.

openapi-pipeline-app · 2021-10-29T00:13:50Z

Swagger Validation Report

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

Compared Swaggers (Based on Oad v0.9.3)
- current:preview/2021-04-30-Preview/searchservice.json compared with base:preview/2021-04-30-Preview/searchservice.json

Rule	Message
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'identity' that was not found in the old version. New: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L7963:7 Old: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L7963:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'authResourceId' that was not found in the old version. New: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L8836:7 Old: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L8831:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'authIdentity' that was not found in the old version. New: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L8836:7 Old: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L8831:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'identity' that was not found in the old version. New: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L10260:7 Old: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L10245:7

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.12.1 , classic-openapi-validator v1.2.2 )
- data-plane/Azure.Search/readme.md tag:package-2021-04-searchservice-preview
Linted configuring files (Based on target branch, openapi-validator v1.12.1 , classic-openapi-validator v1.2.2 )
- data-plane/Azure.Search/readme.md tag:package-2021-04-searchservice-preview

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	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
⚠️ R4000 - ParameterDescriptionRequired	'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
⚠️ R4020 - DescriptiveDescriptionRequired	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#L6115

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

search/data-plane/Azure.Search/readme.md#package-2021-04-searchservice-preview

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

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

openapi-pipeline-app · 2021-10-29T00:13:51Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 3aa956fabdf883b066ee1791641219754caa99c5. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Automation-Sdk-Generate.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.Search.Documents [View full logs] [Preview SDK Changes]
- Azure.Search.Documents.11.4.0-alpha.20220318.1.nupkg
- Azure.Search.Documents.11.4.0-alpha.20220318.1.symbols.nupkg
```
info	[Changelog]
```

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

ghost · 2021-10-29T00:13:52Z

Thank you for your contribution andrea-mccool! We will review the pull request and get back to you soon.

openapi-workflow-bot · 2021-10-29T00:15:57Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

openapi-workflow-bot · 2021-12-15T00:59:46Z

Hi @andrea-mccool, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

HeidiSteen

Hi Andrea, I left some suggestions. Are we missing a MI connection to Azure Key Vault? I think all of the outbound scenarios are there except for that one.

HeidiSteen · 2022-03-17T16:19:26Z

specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/searchservice.json

+        "identity": {
+          "$ref": "#/definitions/SearchIndexerDataIdentity",
+          "x-nullable": true,
+          "description": "The managed identity used for connections to the enrichment cache.  If the connection string indicates an identity and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared."


line 9831 - In the first sentence, can you mention 'user-assigned managed identity? i.e., "The user-assigned managed identity used for connections". In the second sentence, could you include a reference to ResourceId so that it meshes better with our managed identity docs? The amendment would be "If the connection string indicates an identity (ResourceId) and it's not specified"

Also, any chance this is also used for debug sessions?? If it's the same code, you should add an "and debug session" after "enrichment cache".

HeidiSteen · 2022-03-17T16:19:53Z

specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/searchservice.json

+        "identity": {
+          "$ref": "#/definitions/SearchIndexerDataIdentity",
+          "x-nullable": true,
+          "description": "The managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared."


line 7591 - In the first sentence, can you mention 'user-assigned managed identity? i.e., "The user-assigned managed identity used for connections". In the second sentence, could you include a reference to ResourceId so that it meshes better with our managed identity docs? The amendment would be "If the connection string indicates an identity (ResourceId) and it's not specified"

HeidiSteen · 2022-03-17T17:18:12Z

specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/searchservice.json

+        "authResourceId": {
+          "type": "string",
+          "x-nullable": true,
+          "description": "If set, indicates that this skill should use managed identity. This will be used as the resource id for indicating the scope of the authentication token."


line 8481. I think this description is too light. I had to go back to our old email threads to understand what this is supposed to be. What do you think about this:

"Applies to custom skills that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the custom skill connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app."

ID should either be capitalized or spelled out as "identifier".

Update WebApiSkill Model with authResourceId

34ad7f4

ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Oct 29, 2021

openapi-pipeline-app bot added the NewApiVersionRequired label Oct 29, 2021

openapi-sdkautomation bot mentioned this pull request Oct 29, 2021

[AutoPR Azure.Search.Documents] Update WebApiSkill Model with authResourceId AzureSDKAutomation/azure-sdk-for-net#6462

Draft

andrea-mccool added 2 commits December 14, 2021 16:36

Add authIdentity to definitions

a279e67

auth identity

0524cd8

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Dec 15, 2021

andrea-mccool added 2 commits December 17, 2021 12:39

Update Descriptions

bf6cefb

parameters and descriptions

62eae94

HeidiSteen suggested changes Mar 17, 2022

View reviewed changes

updates

27a5db1

AzureRestAPISpecReview removed the NewApiVersionRequired label Sep 28, 2022

Careyjmac mentioned this pull request May 1, 2023

New Azure Cognitive Search API version 2023-07-01-Preview #23779

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update WebApiSkill Model with authResourceId #16592

Update WebApiSkill Model with authResourceId #16592

andrea-mccool commented Oct 29, 2021

openapi-workflow-bot bot commented Oct 29, 2021

openapi-workflow-bot bot commented Oct 29, 2021

openapi-pipeline-app bot commented Oct 29, 2021 •

edited

Loading

openapi-pipeline-app bot commented Oct 29, 2021 •

edited

Loading

Breaking Changes Tracking

ghost commented Oct 29, 2021

openapi-workflow-bot bot commented Oct 29, 2021

openapi-workflow-bot bot commented Dec 15, 2021

HeidiSteen left a comment

HeidiSteen Mar 17, 2022

HeidiSteen Mar 17, 2022

HeidiSteen Mar 17, 2022

HeidiSteen Mar 17, 2022

Update WebApiSkill Model with authResourceId #16592

Are you sure you want to change the base?

Update WebApiSkill Model with authResourceId #16592

Conversation

andrea-mccool commented Oct 29, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Oct 29, 2021

openapi-workflow-bot bot commented Oct 29, 2021

openapi-pipeline-app bot commented Oct 29, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Oct 29, 2021 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

ghost commented Oct 29, 2021

openapi-workflow-bot bot commented Oct 29, 2021

openapi-workflow-bot bot commented Dec 15, 2021

HeidiSteen left a comment

Choose a reason for hiding this comment

HeidiSteen Mar 17, 2022

Choose a reason for hiding this comment

HeidiSteen Mar 17, 2022

Choose a reason for hiding this comment

HeidiSteen Mar 17, 2022

Choose a reason for hiding this comment

HeidiSteen Mar 17, 2022

Choose a reason for hiding this comment

openapi-pipeline-app bot commented Oct 29, 2021 •

edited

Loading

openapi-pipeline-app bot commented Oct 29, 2021 •

edited

Loading