[Schema Inaccuracy] Repository Advisory's author and publisher fields

Abierto

#2,534 abierto el 16/5/2023 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad: 3/5
Tiempo estimado: 1-2 días
Aptitud para principiantes: 45/100

Tipo de issue: Error
Claridad: Bien especificado
Estado de actividad: Estancado
Stack tecnológico: openapi
Área: api

Línea de trabajo

Comienza localizando el esquema #/components/schemas/repository-advisory en la descripción de OpenAPI e inspeccionando los campos author y publisher. Comprueba cómo interpretan las convenciones de esquemas del proyecto y las herramientas relevantes de OpenAPI sus declaraciones allOf y type nullable. La tarea estará terminada cuando ambos campos tengan una representación inequívoca y válida que admita el caso de uso de generación de clientes descrito.

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

Descripción

feature fundamentals-and-support inaccuracy shield waiting for review

Schema Inaccuracy

Currently, the #/components/schemas/repository-advisory schema has two fields with interesting types:

        author:
          readOnly: true
          description: The author of the advisory.
          allOf:
          - "$ref": "#/components/schemas/simple-user"
          type:
          - 'null'
        publisher:
          readOnly: true
          description: The publisher of the advisory.
          allOf:
          - "$ref": "#/components/schemas/simple-user"
          type:
          - 'null'

This appears to be somewhat contradictory, though it's always possible I'm misunderstanding the intent and the spec. The impact is that I'm currently unable to generate client code using a custom code generator (which, of course, might be wrong).

Expected

I believe the contents of the allOf property should be part of type, creating a nullable union:

        author:
          readOnly: true
          description: The author of the advisory.
          type:
          - "$ref": "#/components/schemas/simple-user"
          - 'null'
        publisher:
          readOnly: true
          description: The publisher of the advisory.
          type:
          - "$ref": "#/components/schemas/simple-user"
          - 'null'

Reproduction Steps

This issue arose while generating code from the description, so no API endpoint calls are involved. The code generator is language-specific, so it's unlikely to be useful during reproduction.

Lenguaje dominante: Sin datos de lenguaje
Estrellas: 1.6k
Forks: 342
Merge medio: 2 h 23 min
PR fusionados (30 d): 57