azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Release web microsoft.web 2022 09 01

Open naveedaz opened this issue 2 years ago • 8 comments

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:

  1. What's the purpose of the update?
    • [ ] new service onboarding
    • [x] 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: :warning:

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.

naveedaz avatar Jan 06 '23 05:01 naveedaz

Hi, @naveedaz 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]

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

    ghost avatar Jan 06 '23 05:01 ghost

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    AppServiceCertificateOrders.json 2022-09-01(92d4e5b) 2022-03-01(main)
    CertificateOrdersDiagnostics.json 2022-09-01(92d4e5b) 2022-03-01(main)
    CertificateRegistrationProvider.json 2022-09-01(92d4e5b) 2022-03-01(main)
    DomainRegistrationProvider.json 2022-09-01(92d4e5b) 2022-03-01(main)
    Domains.json 2022-09-01(92d4e5b) 2022-03-01(main)
    TopLevelDomains.json 2022-09-01(92d4e5b) 2022-03-01(main)
    AppServiceEnvironments.json 2022-09-01(92d4e5b) 2022-03-01(main)
    AppServicePlans.json 2022-09-01(92d4e5b) 2022-03-01(main)
    Certificates.json 2022-09-01(92d4e5b) 2022-03-01(main)
    CommonDefinitions.json 2022-09-01(92d4e5b) 2022-03-01(main)
    ContainerApps.json 2022-09-01(92d4e5b) 2022-03-01(main)
    ContainerAppsRevisions.json 2022-09-01(92d4e5b) 2022-03-01(main)
    DeletedWebApps.json 2022-09-01(92d4e5b) 2022-03-01(main)
    Diagnostics.json 2022-09-01(92d4e5b) 2022-03-01(main)
    Global.json 2022-09-01(92d4e5b) 2022-03-01(main)
    KubeEnvironments.json 2022-09-01(92d4e5b) 2022-03-01(main)
    Provider.json 2022-09-01(92d4e5b) 2022-03-01(main)
    Recommendations.json 2022-09-01(92d4e5b) 2022-03-01(main)
    ResourceHealthMetadata.json 2022-09-01(92d4e5b) 2022-03-01(main)
    ResourceProvider.json 2022-09-01(92d4e5b) 2022-03-01(main)
    StaticSites.json 2022-09-01(92d4e5b) 2022-03-01(main)
    WebApps.json 2022-09-01(92d4e5b) 2022-03-01(main)
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️🔄LintDiff inProgress [Detail]
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️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 succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️❌SDK Breaking Change Tracking failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-net-track2 failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-python-track2 failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-go failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️🔄 azure-resource-manager-schemas inProgress [Detail]
    ️❌ azure-powershell failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    Posted by Swagger Pipeline | How to fix these errors?

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/appservice/armappservice https://apiview.dev/Assemblies/Review/47c01b8957e347f3bae72a962b8e60c9
    Java azure-resourcemanager-appservice-generated https://apiview.dev/Assemblies/Review/476cf4fba6a24ead9cdf5a3a61a5b59c
    JavaScript @azure/arm-appservice https://apiview.dev/Assemblies/Review/f407d90b98784e998a51439c2753a73c

    about 44 of ModelValidation is from PR https://github.com/Azure/azure-rest-api-specs/pull/21015#issuecomment-1269122734

    other appears to be api-version in example is 2021-03-01

    weidongxu-microsoft avatar Jan 06 '23 05:01 weidongxu-microsoft

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

    Hi, @naveedaz, 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

    pending PR to this branch

    • https://github.com/Azure/azure-rest-api-specs/pull/21984
    • https://github.com/Azure/azure-rest-api-specs/pull/22159
    • https://github.com/Azure/azure-rest-api-specs/pull/22341

    weidongxu-microsoft avatar Jan 16 '23 01:01 weidongxu-microsoft

    PR is not generated properly for a new API version

    The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version . Please remove the "ARMChangesRequested" label once you have fixed this issue.

    raosuhas avatar Jan 18 '23 22:01 raosuhas

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @raosuhas web/specifications have multiple RPs in the same client. We would love to move them apart but that is a big breaking change. Unfortunately, openAPIHub does not support creating a branch with multiple RPs as base. This has been our feature request to the openAPI team (@akning-ms , @josefree )

    naveedaz avatar Mar 01 '23 03:03 naveedaz

    @raosuhas

    All PR (with change to API path) merging into this feature branch has been approved by ARM reviewer

    • https://github.com/Azure/azure-rest-api-specs/pull/21015 (by Tim)
    • https://github.com/Azure/azure-rest-api-specs/pull/22159
    • https://github.com/Azure/azure-rest-api-specs/pull/22211
    • https://github.com/Azure/azure-rest-api-specs/pull/22491

    weidongxu-microsoft avatar Mar 02 '23 02:03 weidongxu-microsoft

    @MaryGao Please check JS SDK breaking changes https://github.com/Azure/azure-rest-api-specs/pull/22084/checks?check_run_id=11705120988

    weidongxu-microsoft avatar Mar 02 '23 05:03 weidongxu-microsoft

    @msyyc on python failure.

    weidongxu-microsoft avatar Mar 02 '23 05:03 weidongxu-microsoft

    We will fix the failure soon and please ignore it temporarily.

    msyyc avatar Mar 02 '23 06:03 msyyc

    We will fix the failure soon and please ignore it temporarily.

    Sure. I will probably ask Arthur to force merge this tomorrow.

    weidongxu-microsoft avatar Mar 02 '23 07:03 weidongxu-microsoft