• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

tylernathanreed / jira-client-php / 13634794100

03 Mar 2025 03:19PM UTC coverage: 2.067% (-0.1%) from 2.21%
13634794100

push

github

web-flow
~ Try coveralls action

140 of 6773 relevant lines covered (2.07%)

0.03 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0
/src/Schema/SearchRequestBean.php
1
<?php
2

3
namespace Jira\Client\Schema;
4

5
use Jira\Client\Dto;
6

7
final readonly class SearchRequestBean extends Dto
8
{
9
    public function __construct(
×
10
        /**
11
         * Use "expand" to include additional information about issues in the response.
12
         * Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a list of values.
13
         * The expand options are:
14
         * 
15
         *  - `renderedFields` Returns field values rendered in HTML format
16
         *  - `names` Returns the display name of each field
17
         *  - `schema` Returns the schema describing a field type
18
         *  - `transitions` Returns all possible transitions for the issue
19
         *  - `operations` Returns all possible operations for the issue
20
         *  - `editmeta` Returns information about how each field can be edited
21
         *  - `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent
22
         *  - `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.
23
         * 
24
         * @var ?list<string>
25
         */
26
        public ?array $expand = null,
27

28
        /**
29
         * A list of fields to return for each issue, use it to retrieve a subset of fields.
30
         * This parameter accepts a comma-separated list.
31
         * Expand options include:
32
         * 
33
         *  - `*all` Returns all fields
34
         *  - `*navigable` Returns navigable fields
35
         *  - Any issue field, prefixed with a minus to exclude
36
         * 
37
         * The default is `*navigable`
38
         * 
39
         * Examples:
40
         * 
41
         *  - `summary,comment` Returns the summary and comments fields only
42
         *  - `-description` Returns all navigable (default) fields except description
43
         *  - `*all,-comment` Returns all fields except comments
44
         * 
45
         * Multiple `fields` parameters can be included in a request
46
         * 
47
         * Note: All navigable fields are returned by default.
48
         * This differs from "GET issue" where the default is all fields.
49
         * 
50
         * @var ?list<string>
51
         */
52
        public ?array $fields = null,
53

54
        /**
55
         * Reference fields by their key (rather than ID).
56
         * The default is `false`.
57
         */
58
        public ?bool $fieldsByKeys = null,
59

60
        /**
61
         * A "JQL" expression.
62
         * 
63
         * @link https://confluence.atlassian.com/x/egORLQ
64
         */
65
        public ?string $jql = null,
66

67
        /** The maximum number of items to return per page. */
68
        public ?int $maxResults = 50,
69

70
        /**
71
         * A list of up to 5 issue properties to include in the results.
72
         * This parameter accepts a comma-separated list.
73
         * 
74
         * @var ?list<string>
75
         */
76
        public ?array $properties = null,
77

78
        /**
79
         * The index of the first item to return in the page of results (page offset).
80
         * The base index is `0`.
81
         */
82
        public ?int $startAt = null,
83

84
        /**
85
         * Determines how to validate the JQL query and treat the validation results.
86
         * Supported values:
87
         * 
88
         *  - `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings)
89
         *  - `warn` Returns all errors as warnings
90
         *  - `none` No validation is performed
91
         *  - `true` *Deprecated* A legacy synonym for `strict`
92
         *  - `false` *Deprecated* A legacy synonym for `warn`
93
         * 
94
         * The default is `strict`
95
         * 
96
         * Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value.
97
         * 
98
         * @var 'strict'|'warn'|'none'|'true'|'false'|null
99
         */
100
        public ?string $validateQuery = null,
101
    ) {
102
    }
×
103
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc