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

Document: a position hides an unpublished component from callers who cannot see drafts

Đã đóng Phù hợp với người mới
  • Có gì không ổn?
#257 1 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
75/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
Công nghệ
typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Issue xác định gói API, các component có thể xuất bản và vị trí component là các chủ đề cần tài liệu hóa, nhưng không nêu tên tệp tài liệu nào. Hãy bắt đầu bằng cách tìm các trang của gói API về vị trí component và việc xuất bản, sau đó kiểm tra cách các trang này mô tả khả năng hiển thị bản nháp và bộ nhớ đệm. Tài liệu hóa hành vi còn thiếu của component đối với bên gọi không có quyền truy cập bản nháp, cách client xử lý, cũng như hành vi hết hạn và xóa bộ nhớ đệm; hoàn tất khi mọi trường hợp được liệt kê đều được đề cập.

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

Mô tả

From components-web-app/api-components-bundle#493 (fixes #492).

What to document (API bundle, publishable components / component positions):

  • For a caller without draft access, a component position whose component is publishable and not published yet (publishedAt null or in the future) has no component key, and no _metadata.staticComponent. The manifest leaves the component out too. Admins still see the draft.
  • A client must treat a static position with no component as empty.
  • Caching: such a response still carries the component's cache tag, its Expires/s-maxage end when a scheduled component goes live, and publishing or rescheduling a component purges (and publishes over Mercure) the positions holding it and the manifests of the pages placing it.

🤖 Generated with Claude Code

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.