Bug 34587: Remove counter files from API embedding to improve performance
[koha.git] / api / v1 / swagger / definitions / erm_usage_data_provider.yaml
1 ---
2 type: object
3 properties:
4   erm_usage_data_provider_id:
5     type: integer
6     description: internally assigned data provider identifier
7     readOnly: true
8   name:
9     description: name of the data provider
10     type: string
11   description:
12     description: description of the data provider
13     type: 
14     - string
15     - "null"
16   active:
17     description: status of the harvester
18     type: 
19     - integer
20     - "null"
21   method:
22     description: method of the harvester
23     type: 
24     - string
25     - "null"
26   aggregator:
27     description: aggregator of the harvester
28     type: 
29     - string
30     - "null"
31   service_type:
32     description: service_type of the harvester
33     type: 
34     - string
35     - "null"
36   service_url:
37     description: service_url of the harvester
38     type: 
39     - string
40     - "null"
41   report_release:
42     description: report_release of the harvester
43     type: 
44     - string
45     - "null"
46   customer_id:
47     description: customer_id of the harvester
48     type:
49       - string
50       - "null"
51   requestor_id:
52     description: requestor_id of the harvester
53     type:
54       - string
55       - "null"
56   api_key:
57     description: api_key of the harvester
58     type: 
59     - string
60     - "null"
61   requestor_name:
62     description: requestor_name of the harvester
63     type: 
64     - string
65     - "null"
66   requestor_email:
67     description: requestor_email of the harvester
68     type: 
69     - string
70     - "null"
71   report_types:
72     description: report types of the harvester
73     type: 
74     - string
75     - "null"
76   metric_type:
77     description: metric type of the harvester when reporting
78     type: 
79     - string
80     - "null"
81   counter_files:
82     type: array
83     description: counter files
84     items:
85       $ref: erm_counter_file.yaml
86   erm_usage_titles:
87     type: array
88     description: usage titles
89     items:
90       $ref: erm_usage_title.yaml
91   erm_usage_items:
92     type: array
93     description: usage items
94     items:
95       $ref: erm_usage_item.yaml
96   erm_usage_platforms:
97     type: array
98     description: usage platforms
99     items:
100       $ref: erm_usage_platform.yaml
101   erm_usage_databases:
102     type: array
103     description: usage databases
104     items:
105       $ref: erm_usage_database.yaml
106   earliest_title:
107     description: time period of data harvested
108     type: 
109     - string
110     - "null"
111   latest_title:
112     description: time period of data harvested
113     type: 
114     - string
115     - "null"
116   earliest_platform:
117     description: time period of data harvested
118     type: 
119     - string
120     - "null"
121   latest_platform:
122     description: time period of data harvested
123     type: 
124     - string
125     - "null"
126   earliest_item:
127     description: time period of data harvested
128     type: 
129     - string
130     - "null"
131   latest_item:
132     description: time period of data harvested
133     type: 
134     - string
135     - "null"
136   earliest_database:
137     description: time period of data harvested
138     type: 
139     - string
140     - "null"
141   latest_database:
142     description: time period of data harvested
143     type: 
144     - string
145     - "null"
146   last_run:
147     description: last time the harvester was run
148     type: 
149     - string
150     - "null"
151
152 additionalProperties: false
153 required:
154   - name
155   - customer_id
156   - requestor_id
157   - service_url
158   - report_release