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

[Azure Container Apps - Azure Container Apps] API Review #31961

Open
azure-sdk opened this issue Dec 26, 2024 · 2 comments · May be fixed by #31996
Open

[Azure Container Apps - Azure Container Apps] API Review #31961

azure-sdk opened this issue Dec 26, 2024 · 2 comments · May be fixed by #31996
Labels
API Review Scoping This is an issue that will track work on a specific set of API changes.

Comments

@azure-sdk
Copy link
Collaborator

New API Review meeting has been requested.

Service Name: Azure Container Apps - Azure Container Apps
Review Created By: Rajneesh Mitharwal
Review Date: 01/23/2025 08:00 AM PT
Release Plan: 1418
PR:
Hero Scenarios Link: here
Core Concepts Doc Link: here

Description:

Detailed meeting information and documents provided can be accessed here
For more information that will help prepare you for this review, the requirements, and office hours, visit the documentation here

@azure-sdk azure-sdk added the API Review Scoping This is an issue that will track work on a specific set of API changes. label Dec 26, 2024
@mikekistler mikekistler linked a pull request Jan 23, 2025 that will close this issue
3 tasks
@mikekistler
Copy link
Member

PR is #31996

@mikekistler
Copy link
Member

Notes from API Review 1/24/25

  • Open feedback on moving session id to path from query
    • This is work in progress
    • Requires suppressions for not standard operation
  • Will the sessions list response be paginated?
    • Currently not
  • Offset and limit are not the right query params
    • Offset should be skip
    • Limit should be either maxpagesize or top
  • Missing other annotations for pagable operations
  • The service must always support (service-side) paging
    • maxpagesize - can but not required to allow clients to control page size
    • Implement the absolute minimum -- so no maxpagesize unless required
  • Model has eTag -- is this also returned in the response header? yes
    • But no support for If-Match, If-None-Match ?
    • So why provide these? Okay to leave them but
    • Add support for conditional headers as soon as possible
  • ETags should use TypeSpec ETag type
  • Should be consistent with "Id" properties
    • Don't mix "Id" and "Identifier"
  • Use TypeSpec URL type for properties that are URLs
  • Use TypeSpec durations for fields that represent time spans
  • Mismatch of timeout (seconds) and execution time (milliseconds)
    • It would be best to use consistent units here
  • SessionResourceFileNamePathParameter
    • Should this be an alias so that it doesn't show up in the final result?
    • We don't want models that go nowhere
  • File upload -- currently doesn't support multiple files
    • Is multiple files something in the future? If yes, make this an array

Please address the above, and any comments in the APIView, if possible in this version, and otherwise before your GA release.

As none are "must fix" for preview, the API is approved for preview.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Review Scoping This is an issue that will track work on a specific set of API changes.
Projects
Status: Triage
Development

Successfully merging a pull request may close this issue.

2 participants