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 web microsoft.web 2022 09 01 #22084

Merged
merged 16 commits into from
Mar 3, 2023

Conversation

naveedaz
Copy link
Contributor

@naveedaz naveedaz commented Jan 6, 2023

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

edwin-msft and others added 8 commits September 23, 2022 15:16
* add certs/domains new version folders and readme required changes

* add resource IDs to various example files

* add more missing IDs
* Add default action property

* Identifier Id
* Added built-in workflow operation

* Spelling Fixes

* Prettier

* Added response to example

* Lint diff

* Better documented DeployWorkflowArtifacts, fixed casing

* Updated workflow definition

* Correctly defined properties

* Fixed properties object

* PR Feedback

* Prettier and modelvalidation fixes

* ModelValidation

* SemanticValidation

* Spelling

* Updated long running operations

* Updated workflowArtifacts body

* Modelvalidation updated api-version

* Fixing sample errors

* More model validation updates

* Codegen parameters for slots

* Updating examples

* revert x-ms-longrunning

* Updating WorkflowArtifacts

* Fixing filestodelete

* Replaced exact slot objects with references

* added x-ms-parameter-location
* 1. Add more examples 2. Change workflow trigger run and histories to sync operations

* Fix WebApp examples

* Add metadata property to SiteConfig

* Add examples for Slot CRUD and clone web app

* Add more examples

* Revert changes to workflows/histories/resubmit

* Prettier changes

* Fix examples.

* Revert breaking changes

* Add LRO response header to examples
@openapi-workflow-bot
Copy link

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. vscswagger@microsoft.com

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Jan 6, 2023
    @ghost
    Copy link

    ghost commented Jan 6, 2023

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

    @ghost ghost added the Web Apps label Jan 6, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 6, 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
    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?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 6, 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 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?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 6, 2023

    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

    @weidongxu-microsoft
    Copy link
    Member

    about 44 of ModelValidation is from PR #21015 (comment)

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

    @openapi-workflow-bot
    Copy link

    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.

    @openapi-workflow-bot
    Copy link

    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

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 18, 2023
    @weidongxu-microsoft weidongxu-microsoft mentioned this pull request Jan 28, 2023
    3 tasks
    kaibocai and others added 5 commits February 9, 2023 10:55
    * update Site schema with container app enviornment
    
    * add custom words
    
    * update managedEnvironment descriptions
    
    * update to use managedEnvironmentId
    * Update Swagger for Static Web Apps database connections
    
    * Remove additional newline and comma
    
    * Fix up operationId for put / patch on build database connection
    
    * Update api-version in examples
    
    * Run prettier
    
    * Add 200 status for delete operations
    
    * Use StaticSiteDatabaseConnectionOverviewARMResource instead of StaticSiteDatabaseConnectionOverview
    
    * Remove StaticSite from operationId in suffix
    
    * Fix StaticSiteDatabaseConnectionConfigurationFileOverview definition
    
    * Add pattern for environmentName and databaseConnectionName, and remove ProxyOnlyResource from StaticSiteDatabaseConnectionPatchRequestPropertiesARMResource
    
    * Add missing pattern and also add x-ms-identifiers for configurationFiles
    
    * Update description for connectionIdentity
    
    * Simplify request and response entity names
    
    * Use shared parameter and reference for environmentName and databaseConnectionName
    
    * Update x-ms-identifiers per comments
    
    * Add x-ms-secret, combine request and response objects to one with proper readonly annotations
    
    * Run prettier
    
    * Add required parameters and update ConnectionString -> connection string
    
    * Fix required properties for DatabaseConnection
    
    * Remove 'name' from DatabaseConnection and update static site object with DatabaseConnectionOverview
    
    * Add x-ms-identifiers
    
    * Remove connectionString as a required property
    * Update Swagger for Static Web Apps basic auth
    
    * small fixes
    
    * _
    
    * added secret flag
    
    * changed api paths away from CRUD operations
    
    * changed api to use singleton pattern
    
    * small changes
    * Updated verbs and routes for workflowsConnections
    
    * Updated path, description, and operation ID
    * Add definition for ElasticWebAppScaleLimit
    
    * Update CommonDefinitions.json
    
    Use camel casing for property name
    
    ---------
    
    Co-authored-by: Naveed Aziz <naveeda@microsoft.com>
    @naveedaz
    Copy link
    Contributor Author

    naveedaz commented Mar 1, 2023

    @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 )

    @weidongxu-microsoft
    Copy link
    Member

    weidongxu-microsoft commented Mar 2, 2023

    @pilor pilor removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 2, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 2, 2023
    @pilor pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 2, 2023
    @AzureRestAPISpecReview AzureRestAPISpecReview added ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed CI-FixRequiredOnFailure labels Mar 2, 2023
    @weidongxu-microsoft
    Copy link
    Member

    @weidongxu-microsoft
    Copy link
    Member

    @msyyc on python failure.

    @weidongxu-microsoft weidongxu-microsoft added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Mar 2, 2023
    @msyyc
    Copy link
    Member

    msyyc commented Mar 2, 2023

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

    @weidongxu-microsoft
    Copy link
    Member

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

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

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-JavaScript CI-MissingBaseCommit customer-reported Issues that are reported by GitHub users external to the Azure organization. new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager Web Apps
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.