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

Release Microsoft.Web 2023-01-01 API version #26646

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

kamperiadis
Copy link
Contributor

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Getting help

Copy link

openapi-pipeline-app bot commented Nov 9, 2023

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR has breaking changes in the generated SDK for go (label: CI-BreakingChange-Go). Refer to step 3 in the PR workflow diagram (even if your PR is for data plane, not ARM).
  • ❌ Your PR has breaking changes in the generated SDK for javascript (label: CI-BreakingChange-JavaScript). Refer to step 3 in the PR workflow diagram (even if your PR is for data plane, not ARM).
  • ❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it. In addition, refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

Copy link

openapi-pipeline-app bot commented Nov 9, 2023

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
AppServiceEnvironments.json 2023-01-01(7459731) 2022-09-01(main)
AppServicePlans.json 2023-01-01(7459731) 2022-09-01(main)
Certificates.json 2023-01-01(7459731) 2022-09-01(main)
CommonDefinitions.json 2023-01-01(7459731) 2022-09-01(main)
ContainerApps.json 2023-01-01(7459731) 2022-09-01(main)
ContainerAppsRevisions.json 2023-01-01(7459731) 2022-09-01(main)
DeletedWebApps.json 2023-01-01(7459731) 2022-09-01(main)
Diagnostics.json 2023-01-01(7459731) 2022-09-01(main)
Global.json 2023-01-01(7459731) 2022-09-01(main)
KubeEnvironments.json 2023-01-01(7459731) 2022-09-01(main)
Provider.json 2023-01-01(7459731) 2022-09-01(main)
Recommendations.json 2023-01-01(7459731) 2022-09-01(main)
ResourceHealthMetadata.json 2023-01-01(7459731) 2022-09-01(main)
ResourceProvider.json 2023-01-01(7459731) 2022-09-01(main)
StaticSites.json 2023-01-01(7459731) 2022-09-01(main)
WebApps.json 2023-01-01(7459731) 2022-09-01(main)
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄LintDiff inProgress [Detail]
️❌Avocado: 31 Errors, 0 Warnings failed [Detail]

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

Rule Message
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.CertificateRegistration/certificateOrders is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders/{}/certificates is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders/{}/certificates/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders/{}/reissue is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders/{}/renew is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders/{}/resendEmail is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders/{}/resendRequestEmails is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders/{}/retrieveSiteSeal is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders/{}/verifyDomainOwnership is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders/{}/retrieveCertificateActions is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders/{}/retrieveEmailHistory is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /providers/Microsoft.CertificateRegistration/operations is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/CertificateRegistrationProvider.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders/{}/detectors is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/CertificateOrdersDiagnostics.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.CertificateRegistration/certificateOrders/{}/detectors/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.CertificateRegistration/stable/2022-09-01/CertificateOrdersDiagnostics.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /providers/Microsoft.DomainRegistration/operations is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.DomainRegistration/stable/2022-09-01/DomainRegistrationProvider.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.DomainRegistration/checkDomainAvailability is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.DomainRegistration/domains is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.DomainRegistration/generateSsoRequest is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.DomainRegistration/listDomainRecommendations is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DomainRegistration/domains is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DomainRegistration/domains/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DomainRegistration/domains/{}/domainOwnershipIdentifiers is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DomainRegistration/domains/{}/domainOwnershipIdentifiers/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DomainRegistration/domains/{}/renew is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.DomainRegistration/topLevelDomains is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.DomainRegistration/stable/2022-09-01/TopLevelDomains.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.DomainRegistration/topLevelDomains/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.DomainRegistration/stable/2022-09-01/TopLevelDomains.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.DomainRegistration/topLevelDomains/{}/listAgreements is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/web/resource-manager/readme.md
json: Microsoft.DomainRegistration/stable/2022-09-01/TopLevelDomains.json
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView 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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Nov 9, 2023

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 warning [Detail]

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

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

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?

Copy link

openapi-pipeline-app bot commented Nov 9, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/appservice/armappservice https://apiview.dev/Assemblies/Review/f310aa440af24142a997466de3386804
Java azure-resourcemanager-appservice-generated https://apiview.dev/Assemblies/Review/bc2fc4e99af64da488ff80ab2e638bf6
JavaScript @azure/arm-appservice https://apiview.dev/Assemblies/Review/b407bb08340c4364a9f0f8cbca851e88

Copy link

Hi @kamperiadis! 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.

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.

2 participants