[Key Vault] TypeSpec for Certificates library #28708

mccoyp · 2024-04-16T19:51:37Z

Data Plane API - Pull Request

This spec is for the KV Certificates library, and has been successfully tested with Python end-to-end (Azure/azure-sdk-for-python#36903).

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
Open API Hub

Guidelines & Specifications

Helpful Links

Schedule a data plane REST API spec review

Checks stuck in `queued` state?

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.

openapi-pipeline-app · 2024-04-16T19:51:41Z

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).
❌ This PR has at least one breaking change (label: BreakingChangeReviewRequired).
To unblock this PR, follow the process at aka.ms/brch.
❌ 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
❌ The required check named Swagger SpellCheck 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

openapi-pipeline-app · 2024-04-16T19:51:42Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Compared specs (v2.2.2)	new version	base version
default	default(a325c2b)	default(main)

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-04-16T19:51:42Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

️⚠️ azure-sdk-for-python warning [Detail]

⚠️Warning in generating from 5be6c323ca60dbd16e9823b2f4815cf35bfa46dd. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[automation_init.sh] npm notice
cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1
cmderr	[automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
cmderr	[automation_init.sh] npm notice To update run: npm install -g npm@10.8.1
cmderr	[automation_init.sh] npm notice
warn		specification/keyvault/data-plane/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
warn	No file changes detected after generation
warn	No package detected after generation

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-04-16T19:51:43Z

Generated ApiView

Language	Package Name	ApiView Link
Python	azure-keyvault-certificates	https://apiview.dev/Assemblies/Review/b2fdced96a5343cc972aac842b5f43fc?revisionId=d0ebbe69e600462bbd13534d00ad0249
Swagger	Microsoft.KeyVault	https://apiview.dev/Assemblies/Review/829182676c774ce193d9656b4168b090?revisionId=009d04d9c0574677b60f829f920dbc6d
TypeSpec	Security.KeyVault.Certificates	https://apiview.dev/Assemblies/Review/0529655b61bc404ebd37d2d5192ba45a?revisionId=93b4975767ea4130b9f4c2b1de688326

specification/keyvault/data-plane/typespec/main.tsp

specification/keyvault/data-plane/typespec/resources.json

specification/keyvault/data-plane/typespec/tspconfig.yaml

specification/keyvault/data-plane/typespec/models.tsp

specification/keyvault/data-plane/TypeSpec/routes.tsp

specification/keyvault/data-plane/TypeSpec/main.tsp

specification/keyvault/data-plane/TypeSpec/models.tsp

catalinaperalta · 2024-05-16T18:04:30Z

specification/keyvault/data-plane/TypeSpec/models.tsp

+model KeyVaultError {
+  /**
+   * The key vault server error.
+   */
+  @visibility("read")
+  error?: Error;
+}
+
+/**
+ * The key vault server error.
+ */
+model Error {
+  /**
+   * The error code.
+   */
+  @visibility("read")
+  code?: string;


Not related to the converter: can we use the Azure.Core.Foundations.ErrorResponse or Error type here?

specification/keyvault/data-plane/TypeSpec/routes.tsp

heaths

I haven't reviewed all the code, but this is also in the wrong directory. See #29249 (review) for more info about the state and lack of review on this one.

mccoyp added KeyVault TypeSpec Authored with TypeSpec labels Apr 16, 2024

AzureRestAPISpecReview added the data-plane label Apr 16, 2024

RickWinter reviewed Apr 16, 2024

View reviewed changes

specification/keyvault/data-plane/typespec/main.tsp Outdated Show resolved Hide resolved

specification/keyvault/data-plane/typespec/resources.json Outdated Show resolved Hide resolved

specification/keyvault/data-plane/typespec/tspconfig.yaml Outdated Show resolved Hide resolved

jhendrixMSFT reviewed Apr 16, 2024

View reviewed changes

specification/keyvault/data-plane/typespec/models.tsp Outdated Show resolved Hide resolved

mccoyp force-pushed the mccoyp/kv-typespec branch from 88ccbdb to 0cc1739 Compare May 14, 2024 23:46

mccoyp commented May 14, 2024

View reviewed changes

specification/keyvault/data-plane/TypeSpec/routes.tsp Outdated Show resolved Hide resolved

catalinaperalta reviewed May 16, 2024

View reviewed changes

This was referenced May 28, 2024

[Key Vault] TypeSpec for Keys library #29248

Open

[Key Vault] TypeSpec for Secrets library #29249

Open

mccoyp marked this pull request as ready for review June 3, 2024 22:45

mccoyp requested review from heaths and jlichwa as code owners June 3, 2024 22:45

mccoyp requested a review from johanste June 3, 2024 22:46

heaths requested changes Jun 4, 2024

View reviewed changes

microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Jun 24, 2024

microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Jul 15, 2024

timovv mentioned this pull request Jul 18, 2024

[keyvault] [do not merge] testing modular codegen with keyvault-certificates Azure/azure-sdk-for-js#30401

Draft

microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Aug 5, 2024

mccoyp mentioned this pull request Aug 15, 2024

[Key Vault] Generate Certificates with TypeSpec Azure/azure-sdk-for-python#36903

Draft

6 tasks

microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Sep 2, 2024

mccoyp removed the no-recent-activity There has been no recent activity on this issue. label Sep 4, 2024

microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Sep 23, 2024

mccoyp added 29 commits November 11, 2024 13:47

Use Core dependency for Versions

56bb5af

Correct imports; change base endpoint to URL

0480407

Fix setCertificateContacts operation

d6ab927

wip; Work out what can and can't be a resource

8b02737

Resolve warnings aside from lack of examples

95f2614

Align spec with original swagger spec

7ce2479

Add OAuth scheme

270dfa2

Contacts can't actually return an ID

5cad5e1

Add service-dir to tspconfig.yaml

b0d7c65

Add package-dir to tspconfig.yaml

620ca22

Rename TypeSpec directory

73e6576

Add examples

0a62cbe

Remove unnecessary friendlyName decorators

573ec6b

Generate swagger from tsp

a7c64ef

Reformat

ce35034

Move TSP directory to keyvault folder

e309641

Remove '-sdk' from generated swagger name

faa5e7e

Add 7.5 support

44db9d5

Examples folder structure; add operationId/title to examples

1ec0f98

Regenerate swaggers from TSP

158392b

camelCase to kebab-case for operation routes

84c591b

Remove TSP resource use

5cd76e0

Address batch of model breaking changes

c2ef0d9

Manual paged result, reverting Core paging changes

6d69d5c

Treat recoveryLevel value as opaque string

3389132

Use old KeyVaultError response

fc27bc9

Address more changes

0673dfc

Disambiguate nextLink decorators

16fcdc8

Suppress new method naming warnings

cb610b2

mccoyp force-pushed the mccoyp/kv-typespec branch from 3f886c8 to cb610b2 Compare November 11, 2024 21:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Key Vault] TypeSpec for Certificates library #28708

[Key Vault] TypeSpec for Certificates library #28708

mccoyp commented Apr 16, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 16, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 16, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 16, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 16, 2024 •

edited

Loading

catalinaperalta May 16, 2024

heaths left a comment

[Key Vault] TypeSpec for Certificates library #28708

Are you sure you want to change the base?

[Key Vault] TypeSpec for Certificates library #28708

Conversation

mccoyp commented Apr 16, 2024 • edited Loading

Data Plane API - Pull Request

API Info: The Basics

Change Scope

Viewing API changes

Suppressing failures

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

Tooling

Guidelines & Specifications

Helpful Links

openapi-pipeline-app bot commented Apr 16, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Apr 16, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Apr 16, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented Apr 16, 2024 • edited Loading

Generated ApiView

catalinaperalta May 16, 2024

Choose a reason for hiding this comment

heaths left a comment

Choose a reason for hiding this comment

mccoyp commented Apr 16, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 16, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 16, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 16, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 16, 2024 •

edited

Loading