Azure / Azure/azure-rest-api-specs

Review existing KeyVault CI failures

Open
#15,810 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

KeyVault Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
6k
Avg merge
2d 21h
Merged PRs (30d)
432

Description

  • LintDiff failure:

The operation 'CreateCertificate' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.","code":"LongRunningOperationsWithLongRunningExtension"

See here the recommendation.

  • GoSDK CodeGen Faulure:

It seems Go CodeGen is failing for composite swagger, this seems due to mismatch definitions of same parameter "vaultBaseUrl " in two different swagger listed in the composite section

cmderr [generator automation] [AUTOREST] FATAL: Error: '$["x-ms-parameterized-host"].parameters' has incompatible values (---
cmderr [generator automation] [AUTOREST] - name: vaultBaseUrl
cmderr [generator automation] [AUTOREST] description: 'The vault name, for example https://myvault.vault.azure.net.'
cmderr [generator automation] [AUTOREST] required: true
cmderr [generator automation] [AUTOREST] type: string
cmderr [generator automation] [AUTOREST] in: path
cmderr [generator automation] [AUTOREST] x-ms-skip-url-encoding: true
cmderr [generator automation] [AUTOREST] , ---
cmderr [generator automation] [AUTOREST] - name: vaultBaseUrl
cmderr [generator automation] [AUTOREST] description: 'The vault name, for example https://myhsmvault.managedhsm.azure.net.'
cmderr [generator automation] [AUTOREST] required: true
cmderr [generator automation] [AUTOREST] type: string
cmderr [generator automation] [AUTOREST] in: path

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the KeyVault composite configuration in specification/keyvault/data-plane/readme.go.md and review the linked OpenAPI authoring guideline for the CreateCertificate response. Reproduce the LintDiff and Go CodeGen checks, then verify that the long-running-operation metadata and composite parameter definitions no longer cause either failure.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, go, openapi
Domain
api, ci-cd, cloud
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.