forked from HydraCG/Heracles.ts
/
IOperation.ts
59 lines (52 loc) · 1.32 KB
/
IOperation.ts
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
import ResourceFilterableCollection from "./Collections/ResourceFilterableCollection";
import { IClass } from "./IClass";
import { IHydraResource } from "./IHydraResource";
import { IPointingResource } from "./IPointingResource";
/**
* Describes an abstract Hydra operation.
* @interface
*/
export interface IOperation extends IHydraResource, IPointingResource {
/**
* Gets the operations's title.
* @readonly
* @returns {string}
*/
readonly title: string;
/**
* Gets the operations's description.
* @readonly
* @returns {string}
*/
readonly description: string;
/**
* Gets a method to be used for the call.
* @readonly
* @returns {string}
*/
readonly method: string;
/**
* Gets the expected classes.
* @readonly
* @returns {TypedResourceFilterableCollection<IClass>}
*/
readonly expects: ResourceFilterableCollection<IClass>;
/**
* Gets the returned classes.
* @readonly
* @returns {TypedResourceFilterableCollection<IClass>}
*/
readonly returns: ResourceFilterableCollection<IClass>;
/**
* Gets the expected headers.
* @readonly
* @returns {Iterable<string>}
*/
readonly expectedHeaders: Iterable<string>;
/**
* Gets the returned headers.
* @readonly
* @returns {Iterable<string>}
*/
readonly returnedHeaders: Iterable<string>;
}