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.

Sign up for GitHub

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

Jump to bottom

Key Vault Keys: JsonWebKey_2 isn't exported but is shown in ref docs #26278

Open
6 tasks
diberry opened this issue Jun 20, 2023 · 1 comment
Open
6 tasks

Key Vault Keys: JsonWebKey_2 isn't exported but is shown in ref docs #26278

diberry opened this issue Jun 20, 2023 · 1 comment
Assignees
@maorleger
Labels
Client This issue points to a problem in the data-plane of the library. Docs feature-request This issue requires a new behavior in the product in order be resolved. KeyVault
Milestone
Backlog

Comments

@diberry
Copy link
Contributor

diberry commented Jun 20, 2023

  • Package Name: @azure/keyvault-keys
  • Package Version: 4.7.1
  • Operating system:
  • nodejs
    • version:
  • browser
    • name/version:
  • typescript
    • version:
  • Is the bug related to documentation in

Describe the bug
When trying to figure out how to use the KeyVault Keys sdk to import a key, the intellisense shows JsonWebKey_2. The ref docs show 2 types for that.

image

image

JsonWebKey_2 isn't exported

image

JsonWebKey is exported

image

To Reproduce
Steps to reproduce the behavior:
1.

Expected behavior
Expect intellisense and ref docs to show only 1 type instead 2 and expect that to be exported in the types file.

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
Add any other context about the problem here.
@github-actions github-actions bot added Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. KeyVault needs-team-triage Workflow: This issue needs the team to triage. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Jun 20, 2023
@xirzec xirzec added the Docs label Jun 20, 2023
@xirzec xirzec removed the needs-team-triage Workflow: This issue needs the team to triage. label Jun 20, 2023
@github-actions github-actions bot added the needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team label Jun 20, 2023
@timovv
Copy link
Member

timovv commented Jun 20, 2023

This is related to #17710. It's unfortunate this is cascading into the ref docs.

@timovv timovv removed the needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team label Jun 20, 2023
@timovv timovv added this to the Backlog milestone Jun 20, 2023
@github-actions github-actions bot added the needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team label Jun 20, 2023
@xirzec xirzec added feature-request This issue requires a new behavior in the product in order be resolved. and removed question The issue doesn't require a change to the product in order to be resolved. Most issues start as that customer-reported Issues that are reported by GitHub users external to the Azure organization. needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team labels Jul 17, 2023
@chlowell chlowell moved this to Untriaged in Azure SDK for Key Vault Aug 1, 2024
@chlowell chlowell moved this from Untriaged to Not Started in Azure SDK for Key Vault Aug 1, 2024
@timovv timovv assigned maorleger and unassigned timovv Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@maorleger maorleger

Labels
Client This issue points to a problem in the data-plane of the library. Docs feature-request This issue requires a new behavior in the product in order be resolved. KeyVault
Projects
Azure SDK for Key Vault
Status: Not Started
Milestone
Backlog
Development

No branches or pull requests
4 participants
@xirzec @maorleger @timovv @diberry