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.

Sign up for GitHub

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

Jump to bottom

[Search] Specify some renames for Aml skill in the client SDKs #17541

Merged
merged 2 commits into from
Jan 28, 2022
Merged

[Search] Specify some renames for Aml skill in the client SDKs #17541

merged 2 commits into from
Jan 28, 2022

Conversation

Mohit-Chakraborty
Copy link
Contributor

@Mohit-Chakraborty Mohit-Chakraborty commented Jan 28, 2022 •
edited
Loading

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
  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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. 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:

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.

@openapi-workflow-bot
Copy link

Hi, @Mohit-Chakraborty 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
    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 Jan 28, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/cc1523504f4d74b541e82f30e95925d4398b469c/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: 0 Warnings warning [Detail]
    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#L5857
    ️️✔️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 Jan 28, 2022 •
    edited
    Loading

    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]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

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

    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jan 28, 2022
    Closed
    @Mohit-Chakraborty Mohit-Chakraborty changed the title [Search] Specify some renames for the client SDKs [Search] Specify some renames for Aml skill in the client SDKs Jan 28, 2022
    @Mohit-Chakraborty Mohit-Chakraborty marked this pull request as ready for review January 28, 2022 01:49
    @Mohit-Chakraborty Mohit-Chakraborty linked an issue Jan 28, 2022 that may be closed by this pull request
    [Search] Typo in AnswerResult.score description #17537
    Closed
    @Mohit-Chakraborty
    Copy link
    Contributor Author

    @mattmsft - any idea about the failures? They point to existing stuff in the files, things that aren't changing in this PR. I have faced this issue multiple times in this repo in different specification files. It adds unnecessary time to the update process of the SDK? Do you know who I can follow-up with for the pipeline issues?

    @Mohit-Chakraborty
    Copy link
    Contributor Author

    Mohit-Chakraborty commented Jan 28, 2022 •
    edited
    Loading

    @tjprescott - following the discussion from an earlier PR that added the skill, I guess the errors are false positives. Or at least, triggering for the wrong set of changes. Could you please help me merge this PR?

    Also, who would be a good contact to follow up on the failures of the different checks? My changes are almost always about adding client SDK impacting things, and never about service impacting. These failures add delay to the update-consume cycle of the REST spec.

    @jhendrixMSFT jhendrixMSFT added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 28, 2022
    @jhendrixMSFT jhendrixMSFT merged commit 932e261 into main Jan 28, 2022
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jan 28, 2022
    Closed
    mstrisoline pushed a commit to mstrisoline/azure-rest-api-specs that referenced this pull request Feb 1, 2022
    @Mohit-Chakraborty @mstrisoline
    [Search] Specify some renames for Aml skill in the client SDKs (Azure…
    5c6bed4 
    …#17541)

* Specify some renames for the client SDKs

* Fix typo in a description
    @JackTn JackTn deleted the mohitc/AmlSkillClientRenames branch June 16, 2022 00:50
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @jhendrixMSFT jhendrixMSFT jhendrixMSFT approved these changes

    @AlexGhiondea AlexGhiondea Awaiting requested review from AlexGhiondea

    @arv100kri arv100kri Awaiting requested review from arv100kri arv100kri is a code owner

    @bleroy bleroy Awaiting requested review from bleroy bleroy is a code owner

    @brjohnstmsft brjohnstmsft Awaiting requested review from brjohnstmsft

    @mattgotteiner mattgotteiner Awaiting requested review from mattgotteiner

    Assignees

    @jhendrixMSFT jhendrixMSFT

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-FixRequiredOnFailure
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.

    [Search] Typo in AnswerResult.score description
    2 participants
    @Mohit-Chakraborty @jhendrixMSFT