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 Key Vault - Key Vault] API Review #31639

Open
azure-sdk opened this issue Nov 21, 2024 · 3 comments
Open

[Azure Key Vault - Key Vault] API Review #31639

azure-sdk opened this issue Nov 21, 2024 · 3 comments
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 Key Vault - Key Vault
Review Created By: Sandeep Sen
Review Date: 12/03/2024 01:00 PM PT
Release Plan: 1452
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 azure-sdk added the API Review Scoping This is an issue that will track work on a specific set of API changes. label Nov 21, 2024
@azure-sdk
Copy link
Collaborator Author

Meeting updated by Sandeep Sen

Service Name: Azure Key Vault - Key Vault
Review Created By: Sandeep Sen
Review Date: 12/03/2024 01:00 PM PT
Release Plan: 1452
PR: #31670
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

1 similar comment
@azure-sdk
Copy link
Collaborator Author

Meeting updated by Sandeep Sen

Service Name: Azure Key Vault - Key Vault
Review Created By: Sandeep Sen
Review Date: 12/03/2024 01:00 PM PT
Release Plan: 1452
PR: #31670
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
Copy link
Member

Notes from API Review 12/3/2024

  • The key-version is passed in the path but not marked required.
    • This is not allowed in OpenAPI
    • It actually is optional. Here and everywhere else (even though it's marked required)
    • Jeff recommends making this two separate operations
  • Moving to date-based versioning ?
    • Maybe plan to do this as part of the TypeSpec conversion ?
    • We would like the service to move to date-based versions in this api version
  • It needs to be clear what encoding scheme is used for base64 fields
    • URL safe?
  • Why "certificates" a plural name for a string?
    • It contains a base64url encoded PEM file that contains multiple certificates.
    • Consider changing this to "PEMfile" or something else
  • Please specify that the default of preserveCertOrder parameter is false with default: false
    • Is the customer expected to respect this field ?
      • Why return it?
      • It's just for verification
    • Recommend removing the "must" from the description

This looks good 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

No branches or pull requests

2 participants