Koha/api/v1/swagger/definitions/erm_usage_data_provider.yaml
Matt Blenkinsop 979ff589d9
Bug 34587: Remove counter files from API embedding to improve performance
Rather than fetching the counter files and embedding the counter logs, we now add a foreign key to the data provider in the counter logs table and fetch them directly.

Signed-off-by: Jessica Zairo <jzairo@bywatersolutions.com>
Signed-off-by: Michaela Sieber <michaela.sieber@kit.edu>
Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
2023-10-31 16:46:21 -03:00

158 lines
3.1 KiB
YAML

---
type: object
properties:
erm_usage_data_provider_id:
type: integer
description: internally assigned data provider identifier
readOnly: true
name:
description: name of the data provider
type: string
description:
description: description of the data provider
type:
- string
- "null"
active:
description: status of the harvester
type:
- integer
- "null"
method:
description: method of the harvester
type:
- string
- "null"
aggregator:
description: aggregator of the harvester
type:
- string
- "null"
service_type:
description: service_type of the harvester
type:
- string
- "null"
service_url:
description: service_url of the harvester
type:
- string
- "null"
report_release:
description: report_release of the harvester
type:
- string
- "null"
customer_id:
description: customer_id of the harvester
type:
- string
- "null"
requestor_id:
description: requestor_id of the harvester
type:
- string
- "null"
api_key:
description: api_key of the harvester
type:
- string
- "null"
requestor_name:
description: requestor_name of the harvester
type:
- string
- "null"
requestor_email:
description: requestor_email of the harvester
type:
- string
- "null"
report_types:
description: report types of the harvester
type:
- string
- "null"
metric_type:
description: metric type of the harvester when reporting
type:
- string
- "null"
counter_files:
type: array
description: counter files
items:
$ref: erm_counter_file.yaml
erm_usage_titles:
type: array
description: usage titles
items:
$ref: erm_usage_title.yaml
erm_usage_items:
type: array
description: usage items
items:
$ref: erm_usage_item.yaml
erm_usage_platforms:
type: array
description: usage platforms
items:
$ref: erm_usage_platform.yaml
erm_usage_databases:
type: array
description: usage databases
items:
$ref: erm_usage_database.yaml
earliest_title:
description: time period of data harvested
type:
- string
- "null"
latest_title:
description: time period of data harvested
type:
- string
- "null"
earliest_platform:
description: time period of data harvested
type:
- string
- "null"
latest_platform:
description: time period of data harvested
type:
- string
- "null"
earliest_item:
description: time period of data harvested
type:
- string
- "null"
latest_item:
description: time period of data harvested
type:
- string
- "null"
earliest_database:
description: time period of data harvested
type:
- string
- "null"
latest_database:
description: time period of data harvested
type:
- string
- "null"
last_run:
description: last time the harvester was run
type:
- string
- "null"
additionalProperties: false
required:
- name
- customer_id
- requestor_id
- service_url
- report_release