Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Improve OpenAPI response schemas by marking guaranteed properties as required

Đang mở
  • Có gì không ổn?
#583 0 bình luận 1 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
45/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ệ
openapi
Lĩnh vực
api, backend-api-design

Hướng nghiên cứu

Start by locating the OpenAPI response schemas and comparing their properties with the actual API responses to identify values that are guaranteed to be present. Review the securitySchemes definitions and the separate secure.soundcloud.com host question as part of the scope. Done means guaranteed response properties have accurate required arrays and the OAuth path decision is documented.

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

Mô tả

The OpenAPI specification appears to be missing required declarations for many response properties.

For example, properties that appear to be consistently returned by the API are not included in the schema's required arrays. This causes OpenAPI-generated clients and TypeScript types to treat these properties as optional, even though they appear to be guaranteed in actual API responses.

Could the response schemas be reviewed and have properties marked as required where they are guaranteed to be present?

This would make the OpenAPI specification more accurately reflect the actual API contract and would improve the quality of generated clients.

One related question: OAuth is currently represented through the securitySchemes definitions, with the authorization and token URLs hosted at https://secure.soundcloud.com rather than the API host. Is the intention that the OAuth endpoints themselves are intentionally excluded from the OpenAPI paths, since they belong to the separate secure.soundcloud.com service?

Ngôn ngữ chính
JavaScript
Star
254
Fork
53
Không có pull request nào được merge trong 30 ngày

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

Chúng tôi chưa kiểm tra các tệp thiết lập môi trường của dự án này. Hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 soundcloud/api

Tất cả issue của soundcloud/api

Issue tương tự

Thêm issue về JavaScript

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.