Skip to content

Conversation

@ahrkrak
Copy link
Member

@ahrkrak ahrkrak commented Jun 14, 2021

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Note: submitting on request from @jamesc

Changelog

Please ensure to add changelog with 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
    • [X ] Other, please clarify
    • Fix alias list of popular OSs
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet. N/A - no new service
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet. N/A - no API update
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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
    • [ X ] No, no need to refresh 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

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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, @ahrkrak 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. [email protected]

    @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 Jun 14, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: 1/c93b354fd9c14905bb574a8834c4d69b/arm-compute/quickstart-templates
    ️️✔️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.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Jun 14, 2021
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 14, 2021

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    @ghost
    Copy link

    ghost commented Jun 14, 2021

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

    @jamesc
    Copy link

    jamesc commented Jun 14, 2021

    Added Azure/azure-cli#18484 to update the fallback alias list in the CLI for when github is not accessible.

    @weidongxu-microsoft
    Copy link
    Member

    @jamesc Is there anyone from CLI can approve it? I do not work on CLI and do not know what this change means.

    @jamesc
    Copy link

    jamesc commented Jun 18, 2021

    Yes.adding @zhoxing-ms who is working on the connected azure CLI Issue to approve and merge this along with the CLI one.

    @zhoxing-ms
    Copy link
    Contributor

    zhoxing-ms commented Jul 1, 2021

    @ahrkrak Could you please fix the CI issue?

    @jamesc
    Copy link

    jamesc commented Jul 1, 2021

    @ahrkrak Andrew Randall FTE Could you please fix the CI issue?

    @zhoxing-ms Do you mean the failing 'Swagger Avocado' check ? We can ignore that as it's not relevant in this directory.

    @zhoxing-ms
    Copy link
    Contributor

    @ahrkrak Andrew Randall FTE Could you please fix the CI issue?

    @zhoxing-ms Do you mean the failing 'Swagger Avocado' check ? We can ignore that as it's not relevant in this directory.

    Yes, got it, thanks~

    @weidongxu-microsoft
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @weidongxu-microsoft
    Copy link
    Member

    weidongxu-microsoft commented Jul 2, 2021

    @jianyexi Any idea why Avocado fails? This PR does not touch any RP.

    Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: 1/c93b354fd9c14905bb574a8834c4d69b/arm-compute/quickstart-templates
    

    @weidongxu-microsoft
    Copy link
    Member

    @zhoxing-ms
    Let me know when you need it merged.

    @zhoxing-ms
    Copy link
    Contributor

    @weidongxu-microsoft We will start to release the modification of CLI side today, so this PR also needs to be merged today, please help to merge it~

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    Approved-Avocado customer-reported Issues that are reported by GitHub users external to the Azure organization.

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants