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

OpenAPI docs: identityname should be identity.name, and token scope admin should be global

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#2,707 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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
Công nghệ
csharp, openapi
Lĩnh vực
api, documentation

Hướng nghiên cứu

Đọc mô tả tham số trong src/Exceptionless.Web/Api/Endpoints/EventEndpoints.cs và mô tả phạm vi của token trong TokenEndpoints.cs, rồi so sánh chúng với EventHandler.cs và AuthorizationRoles.cs. Cập nhật mô tả OpenAPI để sử dụng identity.name và liệt kê client, user, global, source-maps:write; tạo lại snapshot tại tests/Exceptionless.Tests/Api/Data/openapi.json. Hoàn thành khi các mô tả và snapshot đã được đưa vào kho mã khớp với hành vi của máy chủ.

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

Mô tả

bug documentation

The generated OpenAPI document has two errors that make API calls fail or behave unexpectedly:

  1. The event submit GET endpoints document an identityname query parameter. The server reads identity.name.
  2. The token create endpoints say valid scopes are client, user, admin. The scope is actually named global, and admin is rejected.

Where

What happens

  • GET /api/v2/events/submit?...&[email protected]&identityname=Jane stores identityname as a custom data property, and the user's name isn't set.
  • Creating a token with "scopes": ["admin"] returns a validation error, "Invalid token scope requested."

Expected

The parameter is documented as identity.name, and the scope descriptions list client, user, global (global admins only), and source-maps:write.

Suggested fix

Rename the parameter key and description in EventEndpoints.cs, fix the three token descriptions, and regenerate openapi.json. Optionally accept identityname as an alias in EventHandler for clients that followed the docs.

Ngôn ngữ chính
C#
Star
2.5k
Fork
508
Merge trung bình
2 ngày 17 giờ
Pull request đã merge (30 ngày)
40

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

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

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 exceptionless/Exceptionless

Tất cả issue của exceptionless/Exceptionless

Issue tương tự

Thêm issue về C#

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.