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

Adding new ACA Session Data Plane APIs #31996

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

shivamkm07
Copy link

@shivamkm07 shivamkm07 commented Jan 6, 2025

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.

spec_pr_review_workflow_diagram

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.

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

Tooling

Guidelines & Specifications

Helpful Links

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.

Copy link

openapi-pipeline-app bot commented Jan 6, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This is the public specs repo main branch which is not intended for iterative development.
    You must acknowledge that you understand that after this PR is merged, you won't be able to stop your changes from being published to Azure customers.
    If this is what you intend, add PublishToCustomers label to your PR.
    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 Swagger PrettierCheck has failed. 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

Copy link

openapi-pipeline-app bot commented Jan 6, 2025

Generated ApiView

Language Package Name ApiView Link
TypeSpec Microsoft.App.DynamicSessions https://apiview.dev/Assemblies/Review/0df869ba4f0a43928e7a1e8561f20ee2?revisionId=7f6039071f9e4019b593ec6d9b55dca5

@shivamkm07 shivamkm07 changed the title Adding new Session Data Plane APIs Adding new ACA Session Data Plane APIs Jan 6, 2025
Copy link
Contributor

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

@microsoft-github-policy-service microsoft-github-policy-service bot added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Jan 6, 2025
@azure-sdk
Copy link
Collaborator

API change check

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

Microsoft.App.DynamicSessions

@azure-sdk
Copy link
Collaborator

API change check

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

Microsoft.App.DynamicSessions
Microsoft.App.DynamicSessions

"body": {
"sessions": [
{
"identifier": "testid1",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why response body don't have other properties like GET resource object ?

     "body": {
        "createdAt": "2025-01-05T22:18:41.585Z",
        "lastAccessedAt": "2025-01-05T22:18:41.585Z",
        "expireAt": "2025-01-05T22:18:41.585Z",
        "etag": "123456789"
      }
      ```

"createdAt": "2025-01-05T22:18:41.585Z",
"lastAccessedAt": "2025-01-05T22:18:41.585Z",
"expireAt": "2025-01-05T22:18:41.585Z",
"etag": "123456789"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of this, can you add some real etag example value ?

"createdAt": "2025-01-05T22:18:41.495Z",
"lastUpdatedAt": "2025-01-05T22:18:41.495Z",
"jupyterKernel": {
"name": "deno",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: IJavaScript

}

@doc("The sessions list response entry.")
model SessionsListResponseEntry {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why it is different from GET ?

@get
get is Foundations.Operation<SessionIdentifier, Session>;

#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "No suitable standard operation found."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't we avoid these suppression as it means they are not following standard pattern ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-reported Issues that are reported by GitHub users external to the Azure organization. data-plane TypeSpec Authored with TypeSpec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants