Debian Codegraph @

api-ref/source/v2/scope/scope_parameters.yml

raw
1 collector: &collector
2 in: query
3 description: |
4 Filter on collector.
5 type: string
6 required: false
7
8 fetcher: &fetcher
9 in: query
10 description: |
11 Filter on fetcher.
12 type: string
13 required: false
14
15 limit:
16 in: query
17 description: |
18 For pagination. The maximum number of results to return.
19 type: int
20 required: false
21
22 offset: &offset
23 in: query
24 description: |
25 For pagination. The index of the first element that should be returned.
26 type: int
27 required: false
28
29 scope_id: &scope_id
30 in: query
31 description: |
32 Filter on scope.
33 type: string
34 required: false
35
36 scope_key: &scope_key
37 in: query
38 description: |
39 Filter on scope_key.
40 type: string
41 required: false
42
43 active_anchor_query: &active_query
44 in: body
45 description: |
46 Defines if a scope should be processed or not; `True` means that
47 CloudKitty must process the scope.
48 type: bool
49 required: true
50
51 active_body:
52 <<: *active_query
53 required: false
54
55 active_key_resp:
56 <<: *active_query
57
58 all_scopes: &all_scopes
59 in: body
60 description: |
61 Confirmation whether all scopes must be reset
62 type: bool
63
64 collector_body:
65 <<: *collector
66 in: body
67
68 collector_resp:
69 <<: *collector
70 required: true
71 description: Collector for the given scope
72 in: body
73
74 fetcher_body:
75 <<: *fetcher
76 in: body
77
78 fetcher_resp:
79 <<: *fetcher
80 required: true
81 description: Fetcher for the given scope
82 in: body
83
84 last_processed_timestamp:
85 in: body
86 description: |
87 It represents the last processed timestamp for the storage state element.
88 type: iso8601 timestamp
89 required: true
90
91 scope_activation_toggle_date:
92 in: body
93 description: |
94 It represents the last time the scope was activated/deactivated via the
95 PATCH API.
96 type: iso8601 timestamp
97 required: true
98
99 scope_id_body:
100 <<: *scope_id
101 in: body
102
103 scope_id_resp:
104 <<: *scope_id
105 required: true
106 description: Scope
107 in: body
108
109 scope_key_body:
110 <<: *scope_key
111 in: body
112
113 scope_key_resp:
114 <<: *scope_key
115 required: true
116 description: Scope key for the given scope
117 in: body
118
119 state:
120 in: body
121 description: |
122 State of the scope. This variable represents the last processed
123 timestamp for the storage state element. It is DEPRECATED, and it will
124 be removed in upcoming releases. The alternative is
125 `last_processed_timestamp`.
126 type: iso8601 timestamp
127 required: true