File: reprocessing_parameters.yml

package info (click to toggle)
cloudkitty 23.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 3,528 kB
  • sloc: python: 21,803; sh: 528; makefile: 226; pascal: 54
file content (66 lines) | stat: -rw-r--r-- 1,560 bytes parent folder | download | duplicates (3)
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
path_scope_id:
  in: path
  description: |
    The scope ID to retrieve.
  type: string
  required: true

limit:
  in: query
  description: |
    For pagination. The maximum number of results to return.
  type: int
  required: false

offset:
  in: query
  description: |
    For pagination. The index of the first element that should be returned.
  type: int
  required: false

scope_ids_order_query: &scope_ids_order_query
  in: query
  description: |
    The order in which reprocessing tasks are returned. By default, we
    order reprocessing tasks ``desc`` by their insertion order in the
    database. The possible values are ``desc`` or ``asc``.
  required: false
  type: string

scope_ids_query: &scope_ids_query
  in: query
  description: |
    The scope IDs one wants to retrieve the reprocessing tasks of. If not
    informed, all reprocessing tasks, for all scopes are retrieved.
  required: false
  type: string

end_reprocess_time:
  in: body
  description: |
    The end date for the reprocessing task.
  type: iso8601 timestamp
  required: true

reason:
  in: body
  description: |
    The reason for the reprocessing to take place.
  type: string
  required: true

scope_ids:
  <<: *scope_ids_query
  in: body
  description: |
    The scope IDs to reprocess. Must be comma-separated to schedule more than one.
    One can use the keyword `ALL` to schedule all scopes to be reprocessed.
  required: true

start_reprocess_time:
  in: body
  description: |
    The start date for the reprocessing task.
  type: iso8601 timestamp
  required: true