Azure / Azure/azure-sdk-tools

[python apiview] TypedDict with NotRequired keys showing as ivars

Open
#10,828 0 comments 1 reaction 1 assignee Claimed by @swathipil View on GitHub
APIView needs-triage Python
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

The PhoneNumberProperties TypedDict in this APIView has a few keys marked as NotRequired:

https://spa.apiview.dev/review/a2f139968120456f916fa4485d7dba81?activeApiRevisionId=b1607a0a6c7e442eab20085e01c8f3d1&nId=azure.communication.identity.PhoneNumberIdentifier.__init__.param(kwargs)

The definition for the TypedDict in code is here: https://github.com/Azure/azure-sdk-for-python/blob/832d7de37f3a6674ba9e5467c1609c21087f877b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/models.py#L128

The keys are showing up as ivars whereas I would expect it to follow our APIView convention for keys:

`key "is_anonymous": NotRequired[bool]`

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.