Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#5,570 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
15/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Activo
Área
api, documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Markdown
Estrellas
31.3k
Forks
9.2k
Merge medio
2 d 3 h
PR fusionados (30 d)
8

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de OAI/OpenAPI-Specification

Todos los issues de OAI/OpenAPI-Specification

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.