Document uuid_uri_variables.accept_any_identifier (api-components-bundle #567)

Đã đóng Phù hợp với người mới
  • Có gì không ổn?
#307 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
78/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu từ tài liệu tham chiếu cấu hình API trong content/4.api/ và tìm phần về silverback_api_components. Tài liệu hóa uuid_uri_variables.accept_any_identifier dưới dạng danh sách FQCN có giá trị mặc định là [], với việc khớp lớp chính xác và các yêu cầu đối với provider được mô tả trong issue. Hoàn tất khi tài liệu tham chiếu giải thích cách các lớp này được hợp nhất với các giá trị mặc định của bundle và vì sao provider tùy chỉnh phải trả về null đối với những định danh mà nó không thể phân giải.

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

Mô tả

api-components-bundle now has a config key for resources whose item identifier is not always a UUID (components-web-app/api-components-bundle#567, PR components-web-app/api-components-bundle#568).

Since 2.0.0-alpha.38 an item URL whose id is not a valid UUID is a 404 before any state provider runs, except for Route (by path), ComponentGroup (by reference) and Form (password_reset). A project with its own provider that resolves another identifier (e.g. a Page by reference at /_api/_/pages/share-resource-page) lists the class:

silverback_api_components:
    uuid_uri_variables:
        accept_any_identifier:
            - Silverback\ApiComponentsBundle\Entity\Core\Page

To document (API configuration reference, content/4.api/):

  • A list of FQCNs, default [], merged with the bundle's three classes.
  • The operation's class is matched exactly; a subclass is not included.
  • The class needs a provider that resolves the string and returns null for one it cannot resolve; otherwise Doctrine's item provider returns a 500 for a string on a UUID column.
Ngôn ngữ chính
TypeScript
Star
0
Fork
0
Merge trung bình
1 giờ 20 phút
Pull request đã merge (30 ngày)
1

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: 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 components-web-app/docs

Tất cả issue của components-web-app/docs

Issue tương tự

Thêm issue về TypeScript

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.