Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

All GetXXXResponseContent types declare all fields as Optional in Management API

未关闭
#798 1 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
52/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
冷清
技术栈
python
领域
api, backend

调研方向

首先定位 Management API 的 .get() 端点使用的 GetXXXResponseContent 模型,并将其字段与链接的 API 文档进行比较。识别文档中说明始终存在的字段,将其响应类型设为非可选,并在具有代表性的端点上验证更新后的注解。

由索引模型根据 Issue 内容生成。

描述

bug
Checklist
  • I have looked into the Readme and have not found a suitable solution or answer.
  • I have looked into the API documentation and have not found a suitable solution or answer.
  • I have searched the issues and have not found a suitable solution or answer.
  • I have searched the Auth0 Community forums and have not found a suitable solution or answer.
  • I agree to the terms within the Auth0 Code of Conduct.
Description

The return types for .get() functions declare all fields to be optional. An example here for an organization:


class GetOrganizationResponseContent(UniversalBaseModel):
    id: typing.Optional[str] = pydantic.Field(default=None)
    """
    Organization identifier.
    """

    name: typing.Optional[str] = pydantic.Field(default=None)
    """
    The name of this organization.
    """

    display_name: typing.Optional[str] = pydantic.Field(default=None)
    """
    Friendly name of this organization.
    """

    branding: typing.Optional[OrganizationBranding] = None
    metadata: typing.Optional[OrganizationMetadata] = None
    token_quota: typing.Optional[TokenQuota] = None

However the API documentation does not say id, display_name or name can be None : https://auth0.com/docs/fr-ca/api/management/v2/organizations/get-organizations

This forces developers to correct the typing after the fact with typing.cast or disable typing of the concerned lines.

Reproduction
  1. Call any endpoint in the Management API
  2. Use a field that should never been None (for exemple user.email or user.id)
  3. The IDE or type checker will warn you this field could be None.
Additional context

No response

auth0-python version

5.1.0

Python version

3.12

主要语言
Python
星标
581
派生
189
平均合并
15 小时 33 分钟
30 天内合并 PR
6

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

auth0/auth0-python 的其他 Issue

查看 auth0/auth0-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。