File Coverage

blib/lib/WebService/Mattermost/V4/API/Resource/Role/Single.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

package WebService::Mattermost::V4::API::Resource::Role::Single;
 2: 
 3: # ABSTRACT: Marks a resource as an object with an identifier. 4: 
 5: use Moo::Role;
 6: use Types::Standard 'Str';
 7: 
 8: ################################################################################
 9: 
10: has id => (is => 'rw', isa => Str, required => 0);
11: 
12: ################################################################################
13: 
14: 1;
15: 
16: __END__
17: 
18: =pod
19: 
20: =encoding UTF-8
21: 
22: =head1 NAME
23: 
24: WebService::Mattermost::V4::API::Resource::Role::Single - Marks a resource as an object with an identifier.
25: 
26: =head1 VERSION
27: 
28: version 0.28
29: 
30: =head1 DESCRIPTION
31: 
32: To be included in API resources for a single result object (i.e. something with
33: a unique identifier).
34: 
35: The C<id> attribute may be overridden by an ID parameter being passed to a
36: method call (which will take precedence over the C<id> attribute).
37: 
38: =head1 ATTRIBUTES
39: 
40: =over 4
41: 
42: =item C<id>
43: 
44: String.
45: 
46: =back
47: 
48: =head1 AUTHOR
49: 
50: Mike Jones <[e-mail]>
51: 
52: =head1 COPYRIGHT AND LICENSE
53: 
54: This software is Copyright (c) 2020 by Mike Jones.
55: 
56: This is free software, licensed under:
57: 
58:   The MIT (X11) License
59: 
60: =cut
61: