Adding new ACA Session Data Plane APIs

[shivamkm07]

Data Plane API Specification Update Pull Request

Related PR: https://msazure.visualstudio.com/One/_git/AAPT-Antares-Containerapps/pullrequest/11352385

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

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

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

• Link to API Spec engagement record issue:

Is this review for (select one):

• a private preview
• a public preview
• GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

• Design Document:
• Previous API Spec Doc:
• Updated paths:

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.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

• 💬 Teams Channel
• 💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

• Open API validation tools were run on this PR. Go here to see how to fix errors
• Spectral Linting

Guidelines & Specifications

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Schedule a data plane REST API spec review

Getting help

• First, please carefully read through this PR description, from top to bottom.
• If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
• To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
• For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
  and https://aka.ms/ci-fix.
• If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
  This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
• If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

[openapi-pipeline-app]

Next Steps to Merge

Next steps that must be taken to merge this PR:

• ❌ This PR targets either the main branch of the public specs repo or the RPSaaSMaster branch of the private specs repo. These branches are not intended for iterative development. Therefore, you must acknowledge you understand that after this PR is merged, the APIs are considered shipped to Azure customers. Any further attempts at in-place modifications to the APIs will be subject to Azure's versioning and breaking change policies. Additionally, for control plane APIs, you must acknowledge that you are following all the best practices documented by ARM at aka.ms/armapibestpractices. If you do intend to release the APIs to your customers by merging this PR, add the PublishToCustomers label to your PR in acknowledgement of the above. Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
• ❌ 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 and consult the aka.ms/ci-fix guide. In addition, refer to step 4 in the PR workflow diagram

[openapi-pipeline-app]

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

[microsoft-github-policy-service]

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

[azure-sdk]

API change check

APIView has identified API level changes in this PR and created following API reviews.

Microsoft.App.DynamicSessions

[azure-sdk]

API change check

APIView has identified API level changes in this PR and created following API reviews.

Microsoft.App.DynamicSessions
Microsoft.App.DynamicSessions

[mikekistler]

The PR pipeline tooling is failing because of a bad example file that is already merged to main:

CodeExecution_Execute_Async_Running.json

The problem is that the headers field is not allowed here. It should be included in the parameters section.

A quick check of the other example files found a second occurrence of this problem in

CodeExecution_Execute_Async_Completed.json

Please open a separate PR to correct this problem (fixing just these files)

The runtime failure in the PR tooling obscures a deviation from the Azure Versioning policy. The 2024-10-02-preview API version was already merged to main in the public repo, so updates to this version must be done in a new API version. I've added the VersioningReviewRequired label by hand to signal this.

[mikekistler]

Looks good for preview. 👍

[jijohn14]

Approved to unblock

[shivamkm07]

PR sdk checks failing with this error due to this:
You cannot enable SDK generation for both TypeSpec and OpenAPI simultaneously. Disable one before enabling the other.

This hasn't been changed in this PR. Confirming with the team to identify what to remove.