Skip to content

Document the syntax of OpenApiError.Pointer #500

Closed

Description

The OpenApiError.Pointer property currently has a minimal XML documentation comment:

/// <summary>
/// Pointer to the location of the error.
/// </summary>
public string Pointer { get; set; }

I would like to see documentation of the possible syntaxes here. I have an MSBuild task that tries to parse this string and pass line and column numbers to TaskLoggingHelper.LogError.

Currently, the possibilities seem to be:

(Some errors have more detailed location information in OpenApiError.Message. Filed #502 for making that easier to access.)

Activity

  1. KalleOlaviNiemitalo commented on Jul 16, 2020

    @KalleOlaviNiemitalo
    Author

    Verified that OpenApiError.Pointer in Microsoft.OpenApi.Readers 1.2.2 does not escape / as ~1 if the error occurs within a Path Item Object, whose key in the Paths Object always starts with a slash.

  2. added this to the 1.3 milestone on Sep 28, 2020
  3. added a commit that references this issue on May 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

type:bugA broken experience

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions