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

[Hub Generated] Review request for Microsoft.Media/Streaming to add version stable/2022-11-01 #21191

Merged

Conversation

StephanieHan
Copy link
Contributor

@StephanieHan StephanieHan commented Oct 19, 2022

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

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:

  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. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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

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

@openapi-workflow-bot
Copy link

Hi, @StephanieHan 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Oct 19, 2022

    Swagger Validation Report

    ️🔄BreakingChange inProgress [Detail]
    ️⌛Breaking Change(Cross-Version) pending [Detail]
    ️⌛CredScan pending [Detail]
    ️🔄LintDiff inProgress [Detail]
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/mediaservices/resource-manager/readme.md
    tag: specification/mediaservices/resource-manager/readme.md#tag-package-streaming-2022-11
    ️⌛ApiReadinessCheck pending [Detail]
    ️🔄~[Staging] ServiceAPIReadinessTest inProgress [Detail]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⌛PoliCheck pending [Detail]
    ️️✔️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).
    ️🔄CadlValidation inProgress [Detail]
    ️⌛PR Summary pending [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Oct 19, 2022

    Swagger Generation Artifacts

    ️🔄ApiDocPreview inProgress [Detail]
    ️⌛SDK Breaking Change Tracking pending [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Oct 19, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/mediaservices/armmediaservices https://apiview.dev/Assemblies/Review/b34f4afe477544c58025eea7cf4862cf
    JavaScript @azure/arm-mediaservices https://apiview.dev/Assemblies/Review/949ecbf093be488fa6df62a4844db5b5

    @StephanieHan
    Copy link
    Contributor Author

    /azp run unifiedPipeline

    @azure-pipelines
    Copy link

    No pipelines are associated with this pull request.

    @openapi-workflow-bot
    Copy link

    Hi, @StephanieHan your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @ghost
    Copy link

    ghost commented Dec 25, 2022

    Hi, @StephanieHan. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost
    Copy link

    ghost commented Jan 22, 2023

    Hi, @StephanieHan. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @giakas
    Copy link
    Contributor

    giakas commented Feb 7, 2023

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @akning-ms akning-ms merged commit 11a36e9 into Azure:main Feb 14, 2023
    ghost pushed a commit to Azure/azure-resource-manager-schemas that referenced this pull request Feb 14, 2023
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    …ersion stable/2022-11-01 (Azure#21191)
    
    * Adds base for updating Microsoft.Media/Streaming from version stable/2022-08-01 to version 2022-11-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * add changes to 2022-11-01
    
    * fix for linter and avocado
    
    * fix format
    
    * address all comments
    
    * remove extra white space
    
    * fix format
    
    * fix model validation
    
    * fix all warnings
    
    * fix for comments
    
    * fix lint
    
    * add properties to model and fix comments
    
    * change api method to POST and update example files
    
    * fix operationId
    
    * fix operationId again
    
    * fix healthDescription property
    
    * fix example
    
    * fix descriptions for status properties
    
    * add description of stream event properties
    
    * add descriptions for stream event properties
    
    * fix validation
    
    * fix prettier
    
    * mark time string as date-time format
    
    * add timedMetadataEndpoints property to live event properties
    
    * fix validation
    
    * fix description and example
    
    * annotate date-time format for one property
    
    * update example
    
    * add two additional properties to getStatus response
    
    * fix example
    
    * fix merge
    
    * fix spell check
    
    * fix readme
    
    * add API readiness tests for the new vesrion
    
    * fix API readiness test
    
    ---------
    
    Co-authored-by: Stephanie Han <minhan@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-LintDiff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-FixRequiredOnFailure DoNotMerge <valid label in PR review process> use to hold merge after approval Media Services new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager SuppressionReviewRequired
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    9 participants