/ 
OpenAPI-Linter-0.16
/ OpenAPI::Linter::Location

NAME

OpenAPI::Linter::Location - Represents file location information for OpenAPI specification issues

VERSION

Version 0.16

SYNOPSIS

use OpenAPI::Linter::Location;

# Create a location object
my $location = OpenAPI::Linter::Location->new('openapi.yaml', 10, 5);

# Convert to string representation
print $location->to_string;  # "openapi.yaml:10:5"

# Access location components directly
print $location->{file};    # "openapi.yaml"
print $location->{line};    # 10
print $location->{column};  # 5

DESCRIPTION

OpenAPI::Linter::Location represents a specific location within an OpenAPI specification file. It tracks the file name, line number, and column number where an issue or element is located.

This class is used internally by OpenAPI::Linter to provide precise location information for validation errors and linting issues, making it easier for developers to locate and fix problems in their OpenAPI specifications.

METHODS

new

Creates a new OpenAPI::Linter::Location instance.

It returns a blessed hash reference containing the location information.

Parameters:

  • file

    The file path where the issue occurred. This can be a relative or absolute path.

  • line

    The line number within the file (1-based).

  • column

    The column number within the line (1-based).

my $location = OpenAPI::Linter::Location->new($file, $line, $column);

to_string

Returns a string representation of the location in the format file:line:column.

This format is commonly used by development tools, IDEs, and command-line utilities to quickly navigate to specific locations in source files.

Example:

my $location_str = $location->to_string;

openapi.yaml:15:8
spec.json:42:3
input:1:1

ACCESSORS

While OpenAPI::Linter::Location uses a simple blessed hash structure rather than formal accessors, the following hash keys are available:

  • file

    The file path associated with this location.

  • line

    The line number (1-based).

  • column

    The column number (1-based).

Example:

print "File: $location->{file}\n";
print "Line: $location->{line}\n";
print "Column: $location->{column}\n";

Usage with OpenAPI::Linter

Location objects are automatically created and used by OpenAPI::Linter when processing OpenAPI specifications. Each issue returned by find_issues or validate_schema includes a location field:

my $linter = OpenAPI::Linter->new(spec => 'openapi.yaml');
my @issues = $linter->find_issues;

foreach my $issue (@issues) {
    print "Issue at $issue->{location}: $issue->{message}\n";
    # Example: "Issue at openapi.yaml:10:5: Missing info.title"
}

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) 2025 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.