blob: 4de41bd67ea150fd656eff9d81a4ccc846c95a7b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
<?php
namespace Guzzle\Service\Description;
use Guzzle\Common\ToArrayInterface;
/**
* Interface defining data objects that hold the information of an API operation
*/
interface OperationInterface extends ToArrayInterface
{
const TYPE_PRIMITIVE = 'primitive';
const TYPE_CLASS = 'class';
const TYPE_DOCUMENTATION = 'documentation';
const TYPE_MODEL = 'model';
/**
* Get the service description that the operation belongs to
*
* @return ServiceDescriptionInterface|null
*/
public function getServiceDescription();
/**
* Set the service description that the operation belongs to
*
* @param ServiceDescriptionInterface $description Service description
*
* @return self
*/
public function setServiceDescription(ServiceDescriptionInterface $description);
/**
* Get the params of the operation
*
* @return array
*/
public function getParams();
/**
* Returns an array of parameter names
*
* @return array
*/
public function getParamNames();
/**
* Check if the operation has a specific parameter by name
*
* @param string $name Name of the param
*
* @return bool
*/
public function hasParam($name);
/**
* Get a single parameter of the operation
*
* @param string $param Parameter to retrieve by name
*
* @return Parameter|null
*/
public function getParam($param);
/**
* Get the HTTP method of the operation
*
* @return string|null
*/
public function getHttpMethod();
/**
* Get the concrete operation class that implements this operation
*
* @return string
*/
public function getClass();
/**
* Get the name of the operation
*
* @return string|null
*/
public function getName();
/**
* Get a short summary of what the operation does
*
* @return string|null
*/
public function getSummary();
/**
* Get a longer text field to explain the behavior of the operation
*
* @return string|null
*/
public function getNotes();
/**
* Get the documentation URL of the operation
*
* @return string|null
*/
public function getDocumentationUrl();
/**
* Get what is returned from the method. Can be a primitive, class name, or model. For example, the responseClass
* could be 'array', which would inherently use a responseType of 'primitive'. Using a class name would set a
* responseType of 'class'. Specifying a model by ID will use a responseType of 'model'.
*
* @return string|null
*/
public function getResponseClass();
/**
* Get information about how the response is unmarshalled: One of 'primitive', 'class', 'model', or 'documentation'
*
* @return string
*/
public function getResponseType();
/**
* Get notes about the response of the operation
*
* @return string|null
*/
public function getResponseNotes();
/**
* Get whether or not the operation is deprecated
*
* @return bool
*/
public function getDeprecated();
/**
* Get the URI that will be merged into the generated request
*
* @return string
*/
public function getUri();
/**
* Get the errors that could be encountered when executing the operation
*
* @return array
*/
public function getErrorResponses();
/**
* Get extra data from the operation
*
* @param string $name Name of the data point to retrieve
*
* @return mixed|null
*/
public function getData($name);
}
|