NAME

CPAN::Testers::API::Controller::Release - API for test reports collected by CPAN release

VERSION

version 0.024

DESCRIPTION

This API accesses summary data collected by CPAN release. So, if you just want to know how many PASS and FAIL reports a single distribution has for each version released, this is the best API.

METHODS

release

    ### Requests:
    GET /v3/release
    GET /v3/release/dist/My-Dist
    GET /v3/release/author/PREACTION

    ### Optional query parameters (may be combined):
    # ?since=2016-01-01T12:34:00
    # ?maturity=stable
    # ?limit=2

    ### Response:
    200 OK
    Content-Type: application/json

    [
        {
            "dist": "My-Dist",
            "version": "1.000",
            "pass": 34,
            "fail": 2,
            "na": 1,
            "unknown": 0
        }
    ]

Get release data. Results can be limited by:

• distribution (with the dist key in the stash)

• author (with the author key in the stash)

• date (with the since query parameter)

• maturity (with the maturity query parameter)

• limit (limits the total number of results sent with the limit query parameter)

Release data contains a summary of the pass, fail, na, and unknown test results created by stable Perls. Development Perls (odd-numbered 5.XX releases) are not included.

SEE ALSO

CPAN::Testers::Schema::Result::Release

Mojolicious::Controller

AUTHOR

Doug Bell <preaction@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Doug Bell.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.