Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of "asn_db" object in profile does not match implementation #1053

Closed
matsduf opened this issue Apr 22, 2022 · 1 comment · Fixed by #1257
Closed

Documentation of "asn_db" object in profile does not match implementation #1053

matsduf opened this issue Apr 22, 2022 · 1 comment · Fixed by #1257
Assignees
Labels
A-Documentation Area: Documentation only. S-PRforIssue Status: There is a PR that is meant to resolve the issue T-Bug Type: Bug in software or error in test case description
Milestone

Comments

@matsduf
Copy link
Contributor

matsduf commented Apr 22, 2022

The asn_db object in the default profile contains a sources object, and since it works, that should match the implementation.

{
    "asn_db" : {
        "style" : "Cymru",
        "sources" : {
            "Cymru" : [ "asnlookup.zonemaster.net", "asn.cymru.com" ],
            "RIPE" : [ "riswhois.ripe.net" ]
        }
    }
}

The documentation, however, says that sources should be an array:

=head2 asn_db.sources
An arrayref of domain names when asn_db.style is set to C<"Cymru"> or whois
servers when asn_db.style is set to C<"RIPE">. Normally only the first item
in the list will be used, the rest are backups in case the earlier ones don't 
work.
Default C<"asnlookup.zonemaster.net">.

(From Zonemaster/Engine/Profile.pm)

Either the documentation or the implementation should be updated.

In that Perl module there is also no documentation for the asn_db object.

@matsduf matsduf added the T-Bug Type: Bug in software or error in test case description label Apr 22, 2022
@matsduf matsduf added this to the v2022.2 milestone Apr 22, 2022
@matsduf matsduf modified the milestones: v2022.2, v2023.1 Dec 20, 2022
@matsduf matsduf modified the milestones: v2023.1, v2023.2 Jun 26, 2023
@tgreenx tgreenx added the A-Documentation Area: Documentation only. label Jul 19, 2023
@tgreenx tgreenx self-assigned this Jul 19, 2023
@tgreenx tgreenx linked a pull request Jul 19, 2023 that will close this issue
@tgreenx tgreenx added the S-PRforIssue Status: There is a PR that is meant to resolve the issue label Jul 19, 2023
@matsduf matsduf modified the milestones: v2023.2, v2024.1 Mar 19, 2024
@matsduf matsduf modified the milestones: v2024.1, v2024.2 Jul 3, 2024
@tgreenx
Copy link
Contributor

tgreenx commented Sep 17, 2024

Solved in upcoming release v2024.2 by #1257.

@tgreenx tgreenx closed this as completed Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Documentation Area: Documentation only. S-PRforIssue Status: There is a PR that is meant to resolve the issue T-Bug Type: Bug in software or error in test case description
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants