[Azure Confidential Computing Ledger ] API Review

[azure-sdk]

New API Review meeting has been requested.

Service Name: Azure Confidential Computing Ledger
Review Created By: Amruthashree Anekonda Matadh
Review Date: 09/12/2024 08:00 AM PT
Release Plan:
PR:
Hero Scenarios Link: Not Provided
Core Concepts Doc Link: Not Provided

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]

Meeting updated by Amruthashree Anekonda Matadh

Service Name: Azure Confidential Computing Ledger
Review Created By: Amruthashree Anekonda Matadh
Review Date: 09/12/2024 08:00 AM PT
Release Plan:
PR: #30290
Hero Scenarios Link: Not Provided
Core Concepts Doc Link: Not Provided

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]

Meeting updated by Amruthashree Anekonda Matadh

Service Name: Azure Confidential Computing Ledger
Review Created By: Amruthashree Anekonda Matadh
Review Date: 09/12/2024 08:00 AM PT
Release Plan:
PR: #30290
Hero Scenarios Link: Not Provided
Core Concepts Doc Link: Not Provided

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]

Meeting updated by Amruthashree Anekonda Matadh

Service Name: Azure Confidential Computing Ledger
Review Created By: Amruthashree Anekonda Matadh
Review Date: 09/12/2024 08:00 AM PT
Release Plan:
PR: #30290
Hero Scenarios Link: Not Provided
Core Concepts Doc Link: Not Provided

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]

Meeting updated by Amruthashree Anekonda Matadh

Service Name: Azure Confidential Computing Ledger
Review Created By: Amruthashree Anekonda Matadh
Review Date: 09/12/2024 08:00 AM PT
Release Plan:
PR: #30290
Hero Scenarios Link: Not Provided
Core Concepts Doc Link: Not Provided

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

[mikekistler]

Notes from API Review 9/12/24

New endpoints for user-defined/custom endpoints
Merging some features from a related service being deprecated into this service

• Url path segments -- kebab-case or camel case?
  • Service already seems to use camel-case (enclaveQuotes)
• Choose "custom" or "user" as qualifier for endpoints, and use it consistently
• Do you need "run-time" as a qualifier of "options" ?
  • Qualifier is to avoid
• Why is there no api-version query parameter?
  • Needs to be added on new endpoints
• Why use PUT and not PATCH ?
  • PUT is not version-tolerant but PATCH is
  • Is there no need for partial update?
• PUT should return 200 or 201 with the same content as the request body
• The JavaScript will need to be encoded (escape quotes and backslashes)
• What does the name of the property mean ?
  • What does "additionalProp1" mean? How would the user decide what this should be?
  • Looks like a mistake
  • If you just want a collection then an array would be simpler / easier for users
  • CCF defines the endpoint properties -- can't change that
• How will this code be debugged ?
  • Is it just printf debugging ?
  • What if my JavaScript goes into an infinite loop ?
• run-time-options -- if it only sets JavaScript options then maybe make the body polymorphic or make the url explicit
• user-defined-endpoints - why not a resource id on this URL ?
  • This is a singleton resource
  • Where is the URL for the endpoint ??
  • Maybe this is the key in the additional properties.
• Whatever is defined by CCF should be unchanged here, but needs to be clearly documented
• Consider adding support for conditional requests, especially for PUT on user-defined-endpoints

Please address these points and we will approve for preview.

There are concerns about the usability of this feature so please focus on this in the preview with customers.