Confirm x-id and x-role belong inside info.contact against the SmartAPI validator

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

还没有人认领这个 Issue。

评估

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

调研方向

Start with openapi.yml and CLAUDE.md, then check how the SmartAPI validator handles info.contact.x-id and x-role and whether the registry reads them. Compare the result with NodeNorm’s served OpenAPI document. Done means the fields’ accepted location and registry behavior are confirmed, with the convention documented in CLAUDE.md or a comment in openapi.yml.

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

描述

#294 nested the loose email / name / x-id / x-role keys of openapi.yml under info.contact,
matching what NodeNorm serves:

info:
  contact:
    email: [email protected]
    name: Chris Bizon
    x-id: https://github.com/cbizon
    x-role: responsible developer

x-id and x-role are not fields of the OpenAPI 3.0.2 Contact Object. They are presumably a
Translator convention carried as specification extensions — NodeNorm has served them this way for a
long time — but nobody has checked that against the SmartAPI validator, and #294 is the second time
this block has been wrong without anyone noticing.

Worth confirming rather than changing blind:

  • Does the SmartAPI validator accept x-id / x-role under contact, and does the registry
    actually read them?
  • If they are expected somewhere else (info.x-translator, say), move them and note the convention
    in CLAUDE.md.
  • If they are accepted but ignored, say so in a comment in openapi.yml so the next person doesn't
    re-litigate it.

Found while fixing #294; not a regression, and the current form is at least consistent with NodeNorm.

主要语言
Python
星标
5
派生
4
PR 合并指标
30 天内没有已合并 PR

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 没有贡献指南

从这里开始

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

NCATSTranslator/NameResolution 的其他 Issue

查看 NCATSTranslator/NameResolution 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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