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

v3.3: SAFs -> guidance for constants versus discoverability

Đang mở
  • Có gì không ổn?
#5,570 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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
15/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Sôi nổi
Lĩnh vực
api, documentation

Hướng nghiên cứu

The issue names no file or test. Read the linked discussion in PR 5447 and the existing security authentication framework (SAF) material in the OpenAPI Specification repository to see how runtime-discoverable values are handled today. Done means a proposed written guidance text for SAF authors and for users on conflicts between a document and a runtime value, agreed with maintainers. This is design work, so a newcomer should wait for a decision before starting.

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

Mô tả

This is a follow up to this comment https://github.com/OAI/OpenAPI-Specification/pull/5447#discussion_r4221692962 which was left during the TDC call.

Some values, especially in the context of formalized security protocols, could be discovered at runtime through the protocol, and/or specified in the OAD as a constant from the SAF data structure.

An example of that is the GNAP as_url that can be discovered in the www-authenticate header in the 401 response, or specified in the OAD (based on the current proposal at time of writing).

After we spin the wheel on a couple of times on new SAFs (as @handrews has rightfully pointed out that we'll get better answers to those questions through a bit more experience on that new design approach), we should probably provide additional generic guidance that applies to all SAFs:

  • outside of the OAS specification, for the people writing SAFs, when should a "field" that already can be discovered at runtime be available in the data structure as well?
  • in the OAS specification, for users of the specification/SAFs: what to do when a value in the document contradicts a value discovered at runtime?

I hope this issue captures the 2 discussions on the topic accurately. And that it's articulate enough that when we revisit the issue in a couple of months we know what this is about :)

Ngôn ngữ chính
Markdown
Star
31.3k
Fork
9.2k
Merge trung bình
2 ngày 3 giờ
Pull request đã merge (30 ngày)
8

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

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 OAI/OpenAPI-Specification

Tất cả issue của OAI/OpenAPI-Specification

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.