Azure / Azure/azure-sdk-tools

In C++ APIView, optional parameters are rendered as required.

Open
#1,752 1 comment 0 reactions 0 assignees View on GitHub
APIView bug C++
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

Turns out this is an APIview issue, the `additionalAuthenticationData` parameter is optional in C++ source:
https://github.com/Azure/azure-sdk-for-cpp/blob/0874e1c1c9047b9ccf6caac5057f67c9b92144a7/sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/cryptography/encrypt_parameters.hpp#L156-L158

From https://apiview.dev/Assemblies/Review/2b96c2a3509844fcaf0106f1af1d43f1:
![image](https://user-images.githubusercontent.com/6527137/123717058-e4960980-d830-11eb-817a-13671a66d0aa.png)

cc @vhvb1989, @RickWinter, @tg-msft, @praveenkuttappan

Contributor guide

Open the contributing guide

Research direction

Start with the linked C++ declaration of additionalAuthenticationData and compare it with the APIView review rendering. Trace the APIView entry point that processes C++ parameter optionality, then verify the review shows this parameter as optional rather than required.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.