[Schema Inaccuracy] `/repos/{owner}/{repo}/git/trees` can respond with an undocumented 409

Đang mở
#637 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
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
github, openapi
Lĩnh vực
api, documentation

Hướng nghiên cứu

Bắt đầu với thao tác POST /repos/{owner}/{repo}/git/trees được tài liệu hóa và so sánh các phản hồi của thao tác này với tài liệu tương ứng của git/blobs. Xác minh hành vi 409 của repository trống bằng bản tái hiện, sau đó cập nhật các phản hồi và điều kiện được tài liệu hóa của endpoint khi hành vi dự kiến đã được xác nhận.

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

Mô tả

feature fundamentals-and-support inaccuracy P4 shield waiting for review

Schema Inaccuracy

The route is documented as responding with 403 (forbidden e.g. use doesn't have write access), 404 Not Found (repo does not exist?) or 422 Unprocessable Entitiy (both sha and content specified? possibly also invalid mode, or type?)

However it can also reply with an HTTP 409 Conflict iff the repository is empty, while this is not clearly noted /repos/{owner}/{repo}/git/blobs does document the response code and behaves the same.

Expected

Either documenting the error condition, or allowing the creation of trees and blobs in empty repositories.

Reproduction Steps

import base64
import os

import requests

# add `token` to test with here

s = requests.Session()
s.headers['Accept'] = 'application/vnd.github.v3+json'
s.headers['Authorization'] = f'token {token}'

owner = s.get('https://api.github.com/user').json()['login']
repo = 'test_' + base64.b64encode(os.urandom(6), b'-_').decode()

r = s.post('https://api.github.com/user/repos', json={
    'name': repo,
    'has_issues': False,
    'has_projects': False,
    'has_wiki': False,
    'auto_init': False,
    # at least one merge method must be enabled :(
    'allow_squash_merge': False,
    # 'allow_merge_commit': False,
    'allow_rebase_merge': False,
})
r.raise_for_status()
r = s.post(f'https://api.github.com/repos/{owner}/{repo}/git/trees', json={
    'tree': [{
        'path': 'a',
        'mode': '100644',
        'type': 'blob',
        'content': 'this is my content'
    }]
})
print(r.status_code, r.reason)
for k, v in r.headers.items():
    print(f'{k}: {v}')
print()
print(r.text)
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.