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

オープン
#301 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
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 ファイルあり
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

NCATSTranslator/NameResolution のほかの issue

NCATSTranslator/NameResolution の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。