GET /user/repos: `homepage` field declared as format "uri" but API returns empty string ""

Đang mở Phù hợp với người mới
#6,354 2 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
62/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
openapi
Lĩnh vực
api

Hướng nghiên cứu

Xác định schema của repository và định nghĩa homepage của nó, sau đó kiểm tra các schema được GET /user/repos và GET /repos/{owner}/{repo} sử dụng. So sánh ràng buộc URI đã khai báo với các response trong đó homepage là "" và xác thực các schema bị ảnh hưởng; hoàn thành khi các response đó vượt qua xác thực, trong khi các URL homepage hợp lệ vẫn bị ràng buộc.

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

Mô tả

documentation

Description

The repository schema declares the homepage field with format: "uri", but the GitHub API returns an empty string "" for repositories that have no homepage set.

An empty string is not a valid URI per RFC 3986, so MCP servers and other tools that validate API responses against this schema will reject the entire response with a schema validation error.

Error observed

When calling GET /user/repos (or any endpoint returning repository objects), tools that validate against this schema produce:

MCP error -32602: Structured content does not match the tool's output schema: 
data/result/23/homepage must match format "uri"

The offending field is homepage: "" — GitHub returns an empty string when no homepage has been set on a repo, rather than null or omitting the field.

Expected behavior

The schema should either:

  • Change homepage to allow null or an empty string alongside valid URIs (e.g. type: ["string", "null"] with the format: "uri" applied only when non-null/non-empty), or
  • Document that the API returns "" for unset homepages and update the format constraint accordingly

Steps to reproduce

  1. Call GET /user/repos or GET /repos/{owner}/{repo} for any repository that has no homepage URL set in its settings
  2. The response will contain "homepage": ""
  3. Validating this response against the current OpenAPI schema will fail on the format: "uri" constraint

Notes

  • This affects all repository-returning endpoints, not just /user/repos
  • The homepage field is likely nullable/optional in practice — the schema should reflect this
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
1.6k
Fork
342
Merge trung bình
3 giờ 33 phút
Pull request đã merge (30 ngày)
51

Hướng dẫn đóng góp

Mở 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 github/rest-api-description

Tất cả issue của github/rest-api-description

Issue tương tự

Thêm issue về Backend & API Design

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.