microsoft / microsoft/OpenAPI.NET

OpenApiVisitorBase PathString is not correct for v2 documents

Ouverte
#2,806 1 commentaire 0 réactions 1 personne assignée Voir sur GitHub

@baywet y travaille déjà.

Depuis le 16/4/2026.

help wanted type:feature
Langage dominant
C#
Étoiles
1.6k
Forks
286
Merge moyen
6 h 38 min
PR mergées (30 j)
35

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.