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

OpenApiVisitorBase PathString is not correct for v2 documents

Abierto
#2,806 1 comentario 0 reacciones 1 asignado Ver en GitHub

@baywet ya está trabajando en esto.

Desde el 16/4/2026.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

help wanted type:feature

Describe the bug
The OpenApiVisitorBase.PathString is documented as 'Pointer to source of validation error in document', but when used with OpenApiWalker and the built-in validation system, it does not produce correct pointers when the input document is in the v2 format. This is because the walker operates on the shared data model which mirrors the v3 structure - which has already been manipulated by the v2 reader.

OpenApi File To Reproduce

{
    "swagger": "2.0",
    "info": {
        "title": "Test API",
        "version": "1.0.0"
    },
    "paths": {
        "/items": {
            "get": {
                "responses": {
                    "200": {
                        "description": "OK",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "id": {
                                    "type": "integer"
                                },
                                "name": null
                            }
                        }
                    }
                }
            }
        }
    }
}

Expected behavior
I'd expect a validation error with the pointer:
#/paths/~1items/get/responses/200/schema/properties/name

Instead, we see a validation error with the pointer:
#/paths/~1items/get/responses/200/content/application~1octet-stream/schema/name

This example actually has two separate bugs in one:

  • It looks like a v3 pointer - the 'content/application~1octet-stream' is not present in the document.
  • It is also missing 'properties' path segment due to a bug in the ValidateSchemaPropertyHasValue rule.

Additional context
Ideally it seems like we need the walker to 'undo' the changes that the v2 reader makes to the structure so it can track what the pointer in the underlying document actually is.

At minimum we should document that the PathString is a path to the internal document representation, and not the original document - but IMO it's more useful to have a path to the location in the input document.

Lenguaje dominante
C#
Estrellas
1.6k
Forks
286
Merge medio
6 h 38 min
PR fusionados (30 d)
35

Guía de contribución

Abrir la guía de contribución

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 microsoft/OpenAPI.NET

Todos los issues de microsoft/OpenAPI.NET

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.