Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Azure Cognitive Search] Add missed out enum value to ByPass list #18082

Merged
merged 13 commits into from
Mar 18, 2022

Conversation

arv100kri
Copy link
Member

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:

  1. 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 - Adding an enum to an extensible enum that was previously missed out
  2. 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. Already deployed, just updating the swagger
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. Already deployed the swagger, this is just a minor correction
  4. If updating an existing version, please select the specific language 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 ** We have not published SDK for this API version **

Contribution checklist:

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 are using OpenAPIHub to initialize the PR for adding a new version. 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 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.

@arv100kri arv100kri requested a review from tjacobhi as a code owner March 3, 2022 09:40
@openapi-workflow-bot
Copy link

Hi, @arv100kri 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. vscswagger@microsoft.com

    @openapi-workflow-bot
    Copy link

    [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
    Copy link

    openapi-pipeline-app bot commented Mar 3, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.

    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    R4009 - RequiredReadOnlySystemData The response of operation:'Services_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L361
    R4009 - RequiredReadOnlySystemData The response of operation:'Services_Update' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L454
    R4009 - RequiredReadOnlySystemData The response of operation:'Services_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L540
    R4009 - RequiredReadOnlySystemData The response of operation:'PrivateEndpointConnections_Update' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L736
    R4009 - RequiredReadOnlySystemData The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L794
    R4009 - RequiredReadOnlySystemData The response of operation:'SharedPrivateLinkResources_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L948
    R4009 - RequiredReadOnlySystemData The response of operation:'SharedPrivateLinkResources_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1013
    R4011 - DeleteOperationResponses The delete operation is defined without a 200 or 204 error response implementation,please add it.'
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L877
    R4011 - DeleteOperationResponses The delete operation is defined without a 200 or 204 error response implementation,please add it.'
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1100
    R4032 - MissingXmsErrorResponse Response code 404 is defined without a x-ms-error-response.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L348
    R4032 - MissingXmsErrorResponse Response code 404 is defined without a x-ms-error-response.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L624
    R4032 - MissingXmsErrorResponse Response code 404 is defined without a x-ms-error-response.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L884
    R4032 - MissingXmsErrorResponse Response code 404 is defined without a x-ms-error-response.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1107
    R4037 - MissingTypeObject The schema 'AdminKeyResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1343
    R4037 - MissingTypeObject The schema 'QueryKey' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1358
    R4037 - MissingTypeObject The schema 'ListQueryKeysResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1373
    R4037 - MissingTypeObject The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1392
    R4037 - MissingTypeObject The schema 'DataPlaneAuthOptions' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1454
    R4037 - MissingTypeObject The schema 'DataPlaneAadOrApiKeyAuthOption' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1468
    R4037 - MissingTypeObject The schema 'PrivateEndpointConnection' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1576
    R4037 - MissingTypeObject The schema 'NetworkRuleSet' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1590
    R4037 - MissingTypeObject The schema 'IpRule' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1626
    R4037 - MissingTypeObject The schema 'PrivateEndpointConnectionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1635
    R4037 - MissingTypeObject The schema 'privateEndpoint' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1637
    R4037 - MissingTypeObject The schema 'PrivateEndpointConnectionListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1700
    R4037 - MissingTypeObject The schema 'SharedPrivateLinkResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1749
    R4037 - MissingTypeObject The schema 'SharedPrivateLinkResourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1763
    R4037 - MissingTypeObject The schema 'SharedPrivateLinkResourceListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1866
    R4037 - MissingTypeObject The schema 'PrivateLinkResourcesResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1884
    R4037 - MissingTypeObject The schema 'PrivateLinkResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Search/preview/2021-04-01-preview/search.json#L1898
    ️️✔️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

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

    openapi-pipeline-app bot commented Mar 3, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-go-track2 - armsearch - 0.4.0
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-search - 8.0.0
    ️✔️azure-sdk-for-go - search/mgmt/2020-08-01/search - v62.0.0
    ️✔️azure-sdk-for-go - search/mgmt/2020-03-13/search - v62.0.0
    ️✔️azure-sdk-for-go - search/mgmt/2015-08-19/search - v62.0.0
    ️✔️azure-sdk-for-go - search/mgmt/2015-02-28/search - v62.0.0
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8a9da83. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/search/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.Search [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8a9da83. SDK Automation 14.0.0
      command	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]  notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.3.1 -> 8.5.5
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.5.5>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.5.5` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-search [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8a9da83. SDK Automation 14.0.0
      command	./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]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8a9da83. SDK Automation 14.0.0
      command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️search/mgmt/2020-08-01/search [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️search/mgmt/2020-03-13/search [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️search/mgmt/2015-08-19/search [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️search/mgmt/2015-02-28/search [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8a9da83. SDK Automation 14.0.0
      command	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
    • ️✔️armsearch [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `CloudErrorBody.MarshalJSON` has been removed
      info	[Changelog] - Struct `AsyncOperationResult` has been removed
      info	[Changelog] - Struct `CloudError` has been removed
      info	[Changelog] - Struct `CloudErrorBody` has been removed
      info	[Changelog]
      info	[Changelog] Total 7 breaking change(s), 0 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8a9da83. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      cmderr	[automation_init.sh] deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh]  uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      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]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8a9da83. Schema Automation 14.0.0
      command	.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
    • ️✔️search [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

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

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @msyyc
    Copy link
    Member

    msyyc commented Mar 18, 2022

    Hi @ArcturusZhang , please help confirm Go breaking change.

    @msyyc msyyc merged commit 8a9da83 into Azure:main Mar 18, 2022
    ghost pushed a commit to Azure/azure-resource-manager-schemas that referenced this pull request Mar 18, 2022
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022
    …ure#18082)
    
    * Defining the APIs for the new NSP resource
    
    * Add the AzurePortal bypass value to enum
    
    * Add AzurePortal value to examples
    
    * Fix some validation errors
    
    * Fix prettier violations
    
    * Revert changes to package lock
    
    * Examples prettier fix
    
    Co-authored-by: Hari Prasad Perabattula <harics24@users.noreply.github.com>
    Co-authored-by: Hari Prasad Perabattula <haperaba@microsoft.com>
    Co-authored-by: Arvind Krishnaa Jagannathan <arjagann@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants