Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
  • Qualcosa non va?
#5,570 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
15/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Attiva
Ambito
api, documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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 :)

Lingua principale
Markdown
Stelle
31.3k
Fork
9.2k
Merge medio
2g 3h
PR unite (30g)
8

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OAI/OpenAPI-Specification

Tutte le issue di OAI/OpenAPI-Specification

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.