/ 
OpenAPI-Linter-0.19
River stage zero No dependents
/ OpenAPI::Linter::Location

NAME

OpenAPI::Linter::Location - File location information for OpenAPI spec issues

VERSION

Version 0.19

SYNOPSIS

use OpenAPI::Linter::Location;

my $loc = OpenAPI::Linter::Location->new(
    file   => 'openapi.yaml',
    path   => 'paths./users.get.responses',
    line   => 42,
    column => 5,
);

print $loc;             # "paths./users.get.responses"  (stringifies to path)
print $loc->to_string;  # "paths./users.get.responses"
print $loc->file;       # "openapi.yaml"
print $loc->line;       # 42
print $loc->column;     # 5
print $loc->position;   # "openapi.yaml:42:5"

DESCRIPTION

Represents a specific location within an OpenAPI specification file, combining a dot-separated schema path (e.g. paths./users.get) with an optional file name, line number, and column number.

The object stringifies to its path value, so existing code that treats issue locations as plain strings continues to work without modification.

METHODS

new

my $loc = OpenAPI::Linter::Location->new(%args);

Named arguments:

path (required)

Dot-separated path within the spec, e.g. paths./users.get.responses.200.

file (optional)

The spec file name or internal_data for in-memory specs.

line (optional)

1-based line number within the file. 0 means unknown.

column (optional)

1-based column number within the file. 0 means unknown.

to_string

Returns the dot-separated path string. This is also what the object produces when used in string context.

file

Returns the file name associated with this location.

line

Returns the line number (1-based). Returns 0 if unknown.

column

Returns the column number (1-based). Returns 0 if unknown.

position

Returns the full file:line:column position string, e.g. openapi.yaml:42:5. Returns unknown if line information is unavailable.

OVERLOADING

The object stringifies to its path value via "". This preserves backwards compatibility with code that compares or prints $issue-{location}> as a plain string.

AUTHOR

Mohammad Sajid Anwar, <mohammad.anwar at yahoo.com>

REPOSITORY

https://github.com/manwar/OpenAPI-Linter

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/manwar/OpenAPI-Linter/issues. I will be notified and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc OpenAPI::Linter::Location

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright (C) 2026 Mohammad Sajid Anwar.

This program is free software; you can redistribute it and / or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at: http://www.perlfoundation.org/artistic_license_2_0 Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License.By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license. If your Modified Version has been derived from a Modified Version made by someone other than you,you are nevertheless required to ensure that your Modified Version complies with the requirements of this license. This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder. This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement,then this Artistic License to you shall terminate on the date that such litigation is filed. Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.