Add 2021-06-06-Preview for NSP #23271
Draft
Conversation
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
|
Hi, @tjacobhi 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. [email protected] |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/6492f264b9b0e1f9e6e866892365280f6e18c953/specification/search/resource-manager/Microsoft.Search/preview/2021-06-06-preview/search.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/search/resource-manager/Microsoft.Search/stable/2020-08-01/search.json", "details":"Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.47/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=specification/search/resource-manager/Microsoft.Search/preview/2021-06-06-preview/search.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Schema violation: Additional properties not allowed: readonly\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/search/resource-manager/Microsoft.Search/preview/2021-06-06-preview/search.json:2918:8 ( |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/6492f264b9b0e1f9e6e866892365280f6e18c953/specification/search/resource-manager/Microsoft.Search/preview/2021-06-06-preview/search.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/search.json", "details":"Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.47/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=specification/search/resource-manager/Microsoft.Search/preview/2021-06-06-preview/search.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Schema violation: Additional properties not allowed: readonly\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/search/resource-manager/Microsoft.Search/preview/2021-06-06-preview/search.json:2918:8 ( |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| default | default(6492f26) | default(main) |
️❌Avocado: 41 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/6492f264b9b0e1f9e6e866892365280f6e18c953/specification/search/resource-manager/Microsoft.Search/preview/2021-06-06-preview/search.json" |
|
"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/6492f264b9b0e1f9e6e866892365280f6e18c953/specification/search/resource-manager/Microsoft.Search/preview/2021-06-06-preview/search.json" |
️❌SemanticValidation: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Expected type object but found type string JsonUrl: Microsoft.Search/preview/2021-06-06-preview/search.json |
|
Additional properties not allowed: readonly JsonUrl: Microsoft.Search/preview/2021-06-06-preview/search.json |
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌PrettierCheck: 4 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Code style issues found path: preview/2021-06-06-preview/examples/GetNetworkSecurityPerimeterConfiguration.json |
|
Code style issues found path: preview/2021-06-06-preview/examples/ListNetworkSecurityPerimeterConfigurations.json |
|
Code style issues found path: preview/2021-06-06-preview/examples/ReconcileNetworkSecurityPerimeterConfiguration.json |
|
Code style issues found path: Microsoft.Search/preview/2021-06-06-preview/search.json |
️❌SpellCheck: 9 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Unknown word (associtation), please fix the error or add words to ./custom-words.txt path: Microsoft.Search/preview/2021-06-06-preview/search.json#L1302:191 |
|
Unknown word (associtation), please fix the error or add words to ./custom-words.txt path: Microsoft.Search/preview/2021-06-06-preview/search.json#L1354:191 |
|
Unknown word (Triggeres), please fix the error or add words to ./custom-words.txt path: Microsoft.Search/preview/2021-06-06-preview/search.json#L1360:25 |
|
Unknown word (resoruce), please fix the error or add words to ./custom-words.txt path: Microsoft.Search/preview/2021-06-06-preview/search.json#L1360:166 |
|
Unknown word (abou), please fix the error or add words to ./custom-words.txt path: Microsoft.Search/preview/2021-06-06-preview/search.json#L2845:35 |
|
Unknown word (thte), please fix the error or add words to ./custom-words.txt path: Microsoft.Search/preview/2021-06-06-preview/search.json#L2845:40 |
|
Unknown word (Secuirty), please fix the error or add words to ./custom-words.txt path: Microsoft.Search/preview/2021-06-06-preview/search.json#L2849:46 |
|
Unknown word (qualfied), please fix the error or add words to ./custom-words.txt path: Microsoft.Search/preview/2021-06-06-preview/search.json#L2888:35 |
|
Unknown word (qualfied), please fix the error or add words to ./custom-words.txt path: Microsoft.Search/preview/2021-06-06-preview/search.json#L2892:33 |
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=353844&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 " |
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-go - sdk/resourcemanager/search/armsearch - 2.0.0+ Struct `CloudErrorBody` has been removed + Struct `CloudError` has been removed + Struct `ListQueryKeysResult` has been removed + Struct `PrivateEndpointConnectionListResult` has been removed + Struct `PrivateLinkResourcesResult` has been removed + Struct `ServiceListResult` has been removed + Struct `SharedPrivateLinkResourceListResult` has been removed
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from ab90471b7dfc83a2f6a46c2ad08d3ff67fe1fd92. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
️✔️Azure.ResourceManager.Search [View full logs] [Preview SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from ab90471b7dfc83a2f6a46c2ad08d3ff67fe1fd92. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] npm notice cmderr [automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.2 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.2> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-search [View full logs] [Preview SDK Changes]info [Changelog]
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from ab90471b7dfc83a2f6a46c2ad08d3ff67fe1fd92. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-search [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from ab90471b7dfc83a2f6a46c2ad08d3ff67fe1fd92. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/search/armsearch [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Struct `CloudError` has been removed info [Changelog] - Struct `CloudErrorBody` has been removed info [Changelog] - Struct `ListQueryKeysResult` has been removed info [Changelog] - Struct `PrivateEndpointConnectionListResult` has been removed info [Changelog] - Struct `PrivateLinkResourcesResult` has been removed info [Changelog] - Struct `ServiceListResult` has been removed info [Changelog] - Struct `SharedPrivateLinkResourceListResult` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New value `SearchServiceStatusStopped` added to enum type `SearchServiceStatus` info [Changelog] - New enum type `AADAuthFailureMode` with values `AADAuthFailureModeHttp401WithBearerChallenge`, `AADAuthFailureModeHttp403` info [Changelog] - New enum type `PrivateLinkServiceConnectionProvisioningState` with values `PrivateLinkServiceConnectionProvisioningStateCanceled`, `PrivateLinkServiceConnectionProvisioningStateDeleting`, `PrivateLinkServiceConnectionProvisioningStateFailed`, `PrivateLinkServiceConnectionProvisioningStateIncomplete`, `PrivateLinkServiceConnectionProvisioningStateSucceeded`, `PrivateLinkServiceConnectionProvisioningStateUpdating` info [Changelog] - New enum type `SearchEncryptionComplianceStatus` with values `SearchEncryptionComplianceStatusCompliant`, `SearchEncryptionComplianceStatusNonCompliant` info [Changelog] - New enum type `SearchEncryptionWithCmk` with values `SearchEncryptionWithCmkDisabled`, `SearchEncryptionWithCmkEnabled`, `SearchEncryptionWithCmkUnspecified` info [Changelog] - New function `NewClientFactory(string, azcore.TokenCredential, *arm.ClientOptions) (*ClientFactory, error)` info [Changelog] - New function `*ClientFactory.NewAdminKeysClient() *AdminKeysClient` info [Changelog] - New function `*ClientFactory.NewOperationsClient() *OperationsClient` info [Changelog] - New function `*ClientFactory.NewPrivateEndpointConnectionsClient() *PrivateEndpointConnectionsClient` info [Changelog] - New function `*ClientFactory.NewPrivateLinkResourcesClient() *PrivateLinkResourcesClient` info [Changelog] - New function `*ClientFactory.NewQueryKeysClient() *QueryKeysClient` info [Changelog] - New function `*ClientFactory.NewServicesClient() *ServicesClient` info [Changelog] - New function `*ClientFactory.NewSharedPrivateLinkResourcesClient() *SharedPrivateLinkResourcesClient` info [Changelog] - New struct `ClientFactory` info [Changelog] - New struct `DataPlaneAADOrAPIKeyAuthOption` info [Changelog] - New struct `DataPlaneAuthOptions` info [Changelog] - New struct `EncryptionWithCmk` info [Changelog] - New field `GroupID` in struct `PrivateEndpointConnectionProperties` info [Changelog] - New field `ProvisioningState` in struct `PrivateEndpointConnectionProperties` info [Changelog] - New field `AuthOptions` in struct `ServiceProperties` info [Changelog] - New field `DisableLocalAuth` in struct `ServiceProperties` info [Changelog] - New field `EncryptionWithCmk` in struct `ServiceProperties` info [Changelog] info [Changelog] Total 14 breaking change(s), 36 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from ab90471b7dfc83a2f6a46c2ad08d3ff67fe1fd92. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️@azure/arm-search [View full logs] [Preview SDK Changes]info [Changelog] **Features** info [Changelog] info [Changelog] - Added Interface DataPlaneAadOrApiKeyAuthOption info [Changelog] - Added Interface DataPlaneAuthOptions info [Changelog] - Added Interface EncryptionWithCmk info [Changelog] - Added Type Alias AadAuthFailureMode info [Changelog] - Added Type Alias PrivateLinkServiceConnectionProvisioningState info [Changelog] - Added Type Alias SearchEncryptionComplianceStatus info [Changelog] - Added Type Alias SearchEncryptionWithCmk info [Changelog] - Interface PrivateEndpointConnectionProperties has a new optional parameter groupId info [Changelog] - Interface PrivateEndpointConnectionProperties has a new optional parameter provisioningState info [Changelog] - Interface SearchService has a new optional parameter authOptions info [Changelog] - Interface SearchService has a new optional parameter disableLocalAuth info [Changelog] - Interface SearchService has a new optional parameter encryptionWithCmk info [Changelog] - Interface SearchServiceUpdate has a new optional parameter authOptions info [Changelog] - Interface SearchServiceUpdate has a new optional parameter disableLocalAuth info [Changelog] - Interface SearchServiceUpdate has a new optional parameter encryptionWithCmk info [Changelog] - Added Enum KnownPrivateLinkServiceConnectionProvisioningState
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs] Generate from ab90471b7dfc83a2f6a46c2ad08d3ff67fe1fd92. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile warn File azure-resource-manager-schemas_tmp/initOutput.json not found to read command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json warn No file changes detected after generation
️✔️search [View full logs]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from ab90471b7dfc83a2f6a46c2ad08d3ff67fe1fd92. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
️✔️Az.search.DefaultTag [View full logs] [Preview SDK Changes]
Generated ApiView
|
|
Hi, @tjacobhi, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
ghost
added
the
This was referenced Mar 23, 2023
|
If this PR is still relevant please can you investigate refactoring the NSP definitions to use the [new] common types NSP definitions, letting me know of any blockers |
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 API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] 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. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.