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

Đang mở
#301 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
52/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python, yaml
Lĩnh vực
api

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

#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.

Ngôn ngữ chính
Python
Star
5
Fork
4
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của NCATSTranslator/NameResolution

Tất cả issue của NCATSTranslator/NameResolution

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.