NAME

ICANN::RST::Input - an object representing an RST input parameter.

VERSION

version 0.01

DESCRIPTION

This class inherits from ICANN::RST::Base (so it has the id(), order() and spec() methods).

METHODS

description()

A ICANN::RST::Text object containing the long textual description of the test case.

type()

A string containing the input type.

example()

A string containing an example value.

jsonExample()

A scalar containing the example value coerced into a type that JSON::XS understands. This ensures that numbers and booleans are properly represented when encoded into JSON.

schema()

A hashref containing a JSON::Schema object that can be used to validate this parameter.

cases()

A list of all ICANN::RST::Case objects that use this input parameter.

suites()

A list of all ICANN::RST::Suite objects that use this input parameter.

required()

Whether or not this input parameter is required.

AUTHOR

Gavin Brown <gavin.brown@icann.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2025 by Internet Corporation for Assigned Names and Number (ICANN).

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