Attachment #158333 for bug #35219

View | Details | Raw Unified | Return to bug 35219
Collapse All | Expand All




    x-mojo-to: ERM::EUsage::CounterFiles#get
    operationId: downloadCounterFile
    tags:
      - erm_counter_files
    summary: Download Counter file
    produces:
      - application/octet-stream

    x-mojo-to: ERM::EUsage::CounterFiles#list
    operationId: listErmCounterFiles
    tags:
      - erm_counter_files
    summary: List counter_files
    produces:
      - application/json

    x-mojo-to: ERM::EUsage::CounterFiles#delete
    operationId: deleteERMCounterFiles
    tags:
      - erm_counter_files
    summary: Delete counter_file
    produces:
      - application/json

Lines 3-9 Link Here

(-)a/api/v1/swagger/paths/erm_counter_logs.yaml (-1 / +1 lines)
3	x-mojo-to: ERM::EUsage::CounterLogs#list	3	x-mojo-to: ERM::EUsage::CounterLogs#list
4	operationId: listErmCounterLogs	4	operationId: listErmCounterLogs
5	tags:	5	tags:
6	- counter_log	6	- erm_counter_logs
7	summary: List counter_logs	7	summary: List counter_logs
8	produces:	8	produces:
9	- application/json	9	- application/json




    x-mojo-to: ERM::EUsage::CustomReports#monthly_report
    operationId: getERMUsageMonthlyReport
    tags:
      - erm_usage_reports
    summary: get usage monthly report
    produces:
      - application/json

    x-mojo-to: ERM::EUsage::CustomReports#yearly_report
    operationId: getERMUsageYearlyReport
    tags:
      - erm_usage_reports
    summary: get usage yearly report
    produces:
      - application/json

    x-mojo-to: ERM::EUsage::CustomReports#metric_types_report
    operationId: getERMUsageMetricTypesReport
    tags:
      - erm_usage_reports
    summary: get usage metric_types report
    produces:
      - application/json

    x-mojo-to: ERM::EUsage::CustomReports#provider_rollup_report
    operationId: getERMUsageProviderRollupReport
    tags:
      - erm_usage_reports
    summary: get usage provider rollup report
    produces:
      - application/json




    x-mojo-to: ERM::EUsage::DefaultUsageReports#list
    operationId: listErmDefaultUsageReports
    tags:
      - erm_default_usage_reports
    summary: List default_usage_reports
    produces:
      - application/json

    x-mojo-to: ERM::EUsage::DefaultUsageReports#add
    operationId: addErmDefaultUsageReports
    tags:
      - erm_default_usage_reports
    summary: Add default_usage_report
    consumes:
      - application/json

    x-mojo-to: ERM::EUsage::DefaultUsageReports#delete
    operationId: deleteERMDefaultUsageReports
    tags:
      - erm_default_usage_reports
    summary: Delete default_usage_report
    produces:
      - application/json




    x-mojo-to: ERM::EUsage::UsageDataProviders#list
    operationId: listErmUsageDataProviders
    tags:
      - erm_usage_data_providers
    summary: List usage_data_providers
    produces:
      - application/json

    x-mojo-to: ERM::EUsage::UsageDataProviders#add
    operationId: addErmUsageDataProviders
    tags:
      - erm_usage_data_providers
    summary: Add usage_data_provider
    consumes:
      - application/json

    x-mojo-to: ERM::EUsage::UsageDataProviders#get
    operationId: getERMUsageDataProvider
    tags:
      - erm_usage_data_providers
    summary: get usage_data_provider
    produces:
      - application/json

    x-mojo-to: ERM::EUsage::UsageDataProviders#update
    operationId: updateERMUsageDataProviders
    tags:
      - erm_usage_data_providers
    summary: update usage_data_provider
    consumes:
      - application/json

    x-mojo-to: ERM::EUsage::UsageDataProviders#delete
    operationId: deleteERMUsageDataProviders
    tags:
      - erm_usage_data_providers
    summary: Delete usage_data_provider
    produces:
      - application/json

    x-mojo-to: ERM::EUsage::UsageDataProviders#process_SUSHI_response
    operationId: processSUSHICounterUsageDataProviderHarvester
    tags:
      - erm_usage_data_providers
    summary: Process SUSHI COUNTER for this data provider's harvester
    produces:
      - application/json

    x-mojo-to: ERM::EUsage::UsageDataProviders#process_COUNTER_file
    operationId: processCOUNTERFileUsageDataProviderHarvester
    tags:
      - erm_usage_data_providers
    summary: Process COUNTER file upload for this data provider's harvester
    produces:
      - application/json

    x-mojo-to: ERM::EUsage::UsageDataProviders#test_connection
    operationId: testUsageDataProviderHarvester
    tags:
      - erm_usage_data_providers
    summary: Test this data provider's harvester
    produces:
      - application/json

        description: Under maintenance
        schema:
          $ref: "../swagger.yaml#/definitions/error"
    x-koha-authorization:
      permissions:
        erm: 1
"/erm/usage_data_providers/report":
  get:
    x-mojo-to: ERM::EUsage::UsageDataProviders#providers_report
    operationId: reportUsageDataProvider
    tags:
      - usage data provider report
    summary: Run a report for this data provider
    produces:
      - application/json
    parameters:
      - $ref: "../swagger.yaml#/parameters/match"
      - $ref: "../swagger.yaml#/parameters/order_by"
      - $ref: "../swagger.yaml#/parameters/page"
      - $ref: "../swagger.yaml#/parameters/per_page"
      - $ref: "../swagger.yaml#/parameters/q_param"
      - $ref: "../swagger.yaml#/parameters/q_body"
      - $ref: "../swagger.yaml#/parameters/q_header"
      - name: x-koha-embed
        in: header
        required: false
        description: Embed list sent as a request header
        type: array
        items:
          type: string
          enum:
            - counter_files
            - erm_usage_titles.erm_usage_muses
    responses:
      200:
        description: Successful report run
        schema:
          items:
            $ref: "../swagger.yaml#/definitions/erm_usage_data_provider"
      400:
        description: Bad request
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      403:
        description: Access forbidden
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      500:
        description: |-
          Internal server error. Possible `error_code` attribute values:
          * `internal_server_error`
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      503:
        description: Under maintenance
        schema:
          $ref: "../swagger.yaml#/definitions/error"
    x-koha-authorization:
      permissions:
        erm: 1

Lines 4-10 Link Here

(-)a/api/v1/swagger/paths/erm_usage_databases.yaml (-1 / +1 lines)
4	x-mojo-to: ERM::EUsage::UsageDatabases#list	4	x-mojo-to: ERM::EUsage::UsageDatabases#list
5	operationId: listErmUsageDatabases	5	operationId: listErmUsageDatabases
6	tags:	6	tags:
7	- usage_database	7	- erm_usage_databases
8	summary: List usage_databases	8	summary: List usage_databases
9	produces:	9	produces:
10	- application/json	10	- application/json

Lines 4-10 Link Here

(-)a/api/v1/swagger/paths/erm_usage_items.yaml (-1 / +1 lines)
4	x-mojo-to: ERM::EUsage::UsageItems#list	4	x-mojo-to: ERM::EUsage::UsageItems#list
5	operationId: listErmUsageItems	5	operationId: listErmUsageItems
6	tags:	6	tags:
7	- usage_item	7	- erm_usage_items
8	summary: List usage_items	8	summary: List usage_items
9	produces:	9	produces:
10	- application/json	10	- application/json

Lines 4-10 Link Here

(-)a/api/v1/swagger/paths/erm_usage_platforms.yaml (-1 / +1 lines)
4	x-mojo-to: ERM::EUsage::UsagePlatforms#list	4	x-mojo-to: ERM::EUsage::UsagePlatforms#list
5	operationId: listErmUsagePlatforms	5	operationId: listErmUsagePlatforms
6	tags:	6	tags:
7	- usage_platform	7	- erm_usage_platforms
8	summary: List usage_platforms	8	summary: List usage_platforms
9	produces:	9	produces:
10	- application/json	10	- application/json

Lines 4-10 Link Here

(-)a/api/v1/swagger/paths/erm_usage_titles.yaml (-1 / +1 lines)
4	x-mojo-to: ERM::EUsage::UsageTitles#list	4	x-mojo-to: ERM::EUsage::UsageTitles#list
5	operationId: listErmUsageTitles	5	operationId: listErmUsageTitles
6	tags:	6	tags:
7	- usage_title	7	- erm_usage_titles
8	summary: List usage_titles	8	summary: List usage_titles
9	produces:	9	produces:
10	- application/json	10	- application/json

Lines 1018-1023 tags: Link Here

(-)a/api/v1/swagger/swagger.yaml (-1 / +33 lines)
1018	- description: "Manage ERM configuration\n"	1018	- description: "Manage ERM configuration\n"
1019	name: erm_config	1019	name: erm_config
1020	x-displayName: ERM configuration	1020	x-displayName: ERM configuration
		1021	- description: "Manage ERM counter files\n"
		1022	name: erm_counter_files
		1023	x-displayName: ERM counter files
		1024	- description: "Manage ERM counter logs\n"
		1025	name: erm_counter_logs
		1026	x-displayName: ERM counter logs
		1027	- description: "Retrieve counter registry data\n"
		1028	name: erm_counter_registry
		1029	x-displayName: ERM counter registry
		1030	- description: "Manage ERM saved reports\n"
		1031	name: erm_default_usage_reports
		1032	x-displayName: ERM saved reports
1021	- description: "Manage ERM docuemnts\n"	1033	- description: "Manage ERM docuemnts\n"
1022	name: erm_documents	1034	name: erm_documents
1023	x-displayName: ERM documents	1035	x-displayName: ERM documents
Lines 1033-1038 tags: Link Here
1033	- description: "Manage ERM licences\n"	1045	- description: "Manage ERM licences\n"
1034	name: erm_licences	1046	name: erm_licences
1035	x-displayName: ERM licences	1047	x-displayName: ERM licences
		1048	- description: "Retrieve SUSHI service data\n"
		1049	name: erm_sushi_service
		1050	x-displayName: ERM SUSHI services
		1051	- description: "Manage ERM usage data providers\n"
		1052	name: erm_usage_data_providers
		1053	x-displayName: ERM usage data providers
		1054	- description: "Manage ERM usage databases\n"
		1055	name: erm_usage_databases
		1056	x-displayName: ERM usage databases
		1057	- description: "Manage ERM usage items\n"
		1058	name: erm_usage_items
		1059	x-displayName: ERM usage items
		1060	- description: "Manage ERM usage platforms\n"
		1061	name: erm_usage_platforms
		1062	x-displayName: ERM usage platforms
		1063	- description: "Manage ERM usage titles\n"
		1064	name: erm_usage_titles
		1065	x-displayName: ERM usage titles
		1066	- description: "Manage ERM usage reports\n"
		1067	name: erm_usage_reports
		1068	x-displayName: ERM usage reports
1036	- description: "Manage ERM users\n"	1069	- description: "Manage ERM users\n"
1037	name: erm_users	1070	name: erm_users
1038	x-displayName: ERM users	1071	x-displayName: ERM users
1039	-

Return to bug 35219

Lines 4-10 Link Here

(-)a/api/v1/swagger/paths/erm_usage_data_providers.yaml (-62 / +8 lines)
4	x-mojo-to: ERM::EUsage::UsageDataProviders#list	4	x-mojo-to: ERM::EUsage::UsageDataProviders#list
5	operationId: listErmUsageDataProviders	5	operationId: listErmUsageDataProviders
6	tags:	6	tags:
7	- usage_data_provider	7	- erm_usage_data_providers
8	summary: List usage_data_providers	8	summary: List usage_data_providers
9	produces:	9	produces:
10	- application/json	10	- application/json
Lines 132-138 Link Here
132	x-mojo-to: ERM::EUsage::UsageDataProviders#add	132	x-mojo-to: ERM::EUsage::UsageDataProviders#add
133	operationId: addErmUsageDataProviders	133	operationId: addErmUsageDataProviders
134	tags:	134	tags:
135	- usage_data_provider	135	- erm_usage_data_providers
136	summary: Add usage_data_provider	136	summary: Add usage_data_provider
137	consumes:	137	consumes:
138	- application/json	138	- application/json
Lines 193-199 Link Here
193	x-mojo-to: ERM::EUsage::UsageDataProviders#get	193	x-mojo-to: ERM::EUsage::UsageDataProviders#get
194	operationId: getERMUsageDataProvider	194	operationId: getERMUsageDataProvider
195	tags:	195	tags:
196	- usage_data_provider	196	- erm_usage_data_providers
197	summary: get usage_data_provider	197	summary: get usage_data_provider
198	produces:	198	produces:
199	- application/json	199	- application/json
Lines 245-251 Link Here
245	x-mojo-to: ERM::EUsage::UsageDataProviders#update	245	x-mojo-to: ERM::EUsage::UsageDataProviders#update
246	operationId: updateERMUsageDataProviders	246	operationId: updateERMUsageDataProviders
247	tags:	247	tags:
248	- usage_data_provider	248	- erm_usage_data_providers
249	summary: update usage_data_provider	249	summary: update usage_data_provider
250	consumes:	250	consumes:
251	- application/json	251	- application/json
Lines 310-316 Link Here
310	x-mojo-to: ERM::EUsage::UsageDataProviders#delete	310	x-mojo-to: ERM::EUsage::UsageDataProviders#delete
311	operationId: deleteERMUsageDataProviders	311	operationId: deleteERMUsageDataProviders
312	tags:	312	tags:
313	- usage_data_provider	313	- erm_usage_data_providers
314	summary: Delete usage_data_provider	314	summary: Delete usage_data_provider
315	produces:	315	produces:
316	- application/json	316	- application/json
Lines 357-363 Link Here
357	x-mojo-to: ERM::EUsage::UsageDataProviders#process_SUSHI_response	357	x-mojo-to: ERM::EUsage::UsageDataProviders#process_SUSHI_response
358	operationId: processSUSHICounterUsageDataProviderHarvester	358	operationId: processSUSHICounterUsageDataProviderHarvester
359	tags:	359	tags:
360	- usage data provider harvester	360	- erm_usage_data_providers
361	summary: Process SUSHI COUNTER for this data provider's harvester	361	summary: Process SUSHI COUNTER for this data provider's harvester
362	produces:	362	produces:
363	- application/json	363	- application/json
Lines 411-417 Link Here
411	x-mojo-to: ERM::EUsage::UsageDataProviders#process_COUNTER_file	411	x-mojo-to: ERM::EUsage::UsageDataProviders#process_COUNTER_file
412	operationId: processCOUNTERFileUsageDataProviderHarvester	412	operationId: processCOUNTERFileUsageDataProviderHarvester
413	tags:	413	tags:
414	- usage data provider harvester	414	- erm_usage_data_providers
415	summary: Process COUNTER file upload for this data provider's harvester	415	summary: Process COUNTER file upload for this data provider's harvester
416	produces:	416	produces:
417	- application/json	417	- application/json
Lines 459-465 Link Here
459	x-mojo-to: ERM::EUsage::UsageDataProviders#test_connection	459	x-mojo-to: ERM::EUsage::UsageDataProviders#test_connection
460	operationId: testUsageDataProviderHarvester	460	operationId: testUsageDataProviderHarvester
461	tags:	461	tags:
462	- usage data provider harvester	462	- erm_usage_data_providers
463	summary: Test this data provider's harvester	463	summary: Test this data provider's harvester
464	produces:	464	produces:
465	- application/json	465	- application/json
Lines 489-548 Link Here
489	description: Under maintenance	489	description: Under maintenance
490	schema:	490	schema:
491	$ref: "../swagger.yaml#/definitions/error"	491	$ref: "../swagger.yaml#/definitions/error"
492	x-koha-authorization:
493	permissions:
494	erm: 1
495	"/erm/usage_data_providers/report":
496	get:
497	x-mojo-to: ERM::EUsage::UsageDataProviders#providers_report
498	operationId: reportUsageDataProvider
499	tags:
500	- usage data provider report
501	summary: Run a report for this data provider
502	produces:
503	- application/json
504	parameters:
505	- $ref: "../swagger.yaml#/parameters/match"
506	- $ref: "../swagger.yaml#/parameters/order_by"
507	- $ref: "../swagger.yaml#/parameters/page"
508	- $ref: "../swagger.yaml#/parameters/per_page"
509	- $ref: "../swagger.yaml#/parameters/q_param"
510	- $ref: "../swagger.yaml#/parameters/q_body"
511	- $ref: "../swagger.yaml#/parameters/q_header"
512	- name: x-koha-embed
513	in: header
514	required: false
515	description: Embed list sent as a request header
516	type: array
517	items:
518	type: string
519	enum:
520	- counter_files
521	- erm_usage_titles.erm_usage_muses
522	responses:
523	200:
524	description: Successful report run
525	schema:
526	items:
527	$ref: "../swagger.yaml#/definitions/erm_usage_data_provider"
528	400:
529	description: Bad request
530	schema:
531	$ref: "../swagger.yaml#/definitions/error"
532	403:
533	description: Access forbidden
534	schema:
535	$ref: "../swagger.yaml#/definitions/error"
536	500:
537	description: \|-
538	Internal server error. Possible `error_code` attribute values:
539	* `internal_server_error`
540	schema:
541	$ref: "../swagger.yaml#/definitions/error"
542	503:
543	description: Under maintenance
544	schema:
545	$ref: "../swagger.yaml#/definitions/error"
546	x-koha-authorization:	492	x-koha-authorization:
547	permissions:	493	permissions:
548	erm: 1	494	erm: 1

Lines 4-10 Link Here

(-)a/api/v1/swagger/paths/erm_counter_files.yaml (-3 / +3 lines)
4	x-mojo-to: ERM::EUsage::CounterFiles#get	4	x-mojo-to: ERM::EUsage::CounterFiles#get
5	operationId: downloadCounterFile	5	operationId: downloadCounterFile
6	tags:	6	tags:
7	- counter_file	7	- erm_counter_files
8	summary: Download Counter file	8	summary: Download Counter file
9	produces:	9	produces:
10	- application/octet-stream	10	- application/octet-stream
Lines 49-55 Link Here
49	x-mojo-to: ERM::EUsage::CounterFiles#list	49	x-mojo-to: ERM::EUsage::CounterFiles#list
50	operationId: listErmCounterFiles	50	operationId: listErmCounterFiles
51	tags:	51	tags:
52	- counter_file	52	- erm_counter_files
53	summary: List counter_files	53	summary: List counter_files
54	produces:	54	produces:
55	- application/json	55	- application/json
Lines 133-139 Link Here
133	x-mojo-to: ERM::EUsage::CounterFiles#delete	133	x-mojo-to: ERM::EUsage::CounterFiles#delete
134	operationId: deleteERMCounterFiles	134	operationId: deleteERMCounterFiles
135	tags:	135	tags:
136	- counter_file	136	- erm_counter_files
137	summary: Delete counter_file	137	summary: Delete counter_file
138	produces:	138	produces:
139	- application/json	139	- application/json

Lines 3-9 Link Here

(-)a/api/v1/swagger/paths/erm_custom_reports.yaml (-4 / +4 lines)
3	x-mojo-to: ERM::EUsage::CustomReports#monthly_report	3	x-mojo-to: ERM::EUsage::CustomReports#monthly_report
4	operationId: getERMUsageMonthlyReport	4	operationId: getERMUsageMonthlyReport
5	tags:	5	tags:
6	- usage_report	6	- erm_usage_reports
7	summary: get usage monthly report	7	summary: get usage monthly report
8	produces:	8	produces:
9	- application/json	9	- application/json
Lines 62-68 Link Here
62	x-mojo-to: ERM::EUsage::CustomReports#yearly_report	62	x-mojo-to: ERM::EUsage::CustomReports#yearly_report
63	operationId: getERMUsageYearlyReport	63	operationId: getERMUsageYearlyReport
64	tags:	64	tags:
65	- usage_report	65	- erm_usage_reports
66	summary: get usage yearly report	66	summary: get usage yearly report
67	produces:	67	produces:
68	- application/json	68	- application/json
Lines 121-127 Link Here
121	x-mojo-to: ERM::EUsage::CustomReports#metric_types_report	121	x-mojo-to: ERM::EUsage::CustomReports#metric_types_report
122	operationId: getERMUsageMetricTypesReport	122	operationId: getERMUsageMetricTypesReport
123	tags:	123	tags:
124	- usage_report	124	- erm_usage_reports
125	summary: get usage metric_types report	125	summary: get usage metric_types report
126	produces:	126	produces:
127	- application/json	127	- application/json
Lines 180-186 Link Here
180	x-mojo-to: ERM::EUsage::CustomReports#provider_rollup_report	180	x-mojo-to: ERM::EUsage::CustomReports#provider_rollup_report
181	operationId: getERMUsageProviderRollupReport	181	operationId: getERMUsageProviderRollupReport
182	tags:	182	tags:
183	- usage_report	183	- erm_usage_reports
184	summary: get usage provider rollup report	184	summary: get usage provider rollup report
185	produces:	185	produces:
186	- application/json	186	- application/json

Lines 4-10 Link Here

(-)a/api/v1/swagger/paths/erm_default_usage_reports.yaml (-3 / +3 lines)
4	x-mojo-to: ERM::EUsage::DefaultUsageReports#list	4	x-mojo-to: ERM::EUsage::DefaultUsageReports#list
5	operationId: listErmDefaultUsageReports	5	operationId: listErmDefaultUsageReports
6	tags:	6	tags:
7	- default_usage_report	7	- erm_default_usage_reports
8	summary: List default_usage_reports	8	summary: List default_usage_reports
9	produces:	9	produces:
10	- application/json	10	- application/json
Lines 62-68 Link Here
62	x-mojo-to: ERM::EUsage::DefaultUsageReports#add	62	x-mojo-to: ERM::EUsage::DefaultUsageReports#add
63	operationId: addErmDefaultUsageReports	63	operationId: addErmDefaultUsageReports
64	tags:	64	tags:
65	- default_usage_report	65	- erm_default_usage_reports
66	summary: Add default_usage_report	66	summary: Add default_usage_report
67	consumes:	67	consumes:
68	- application/json	68	- application/json
Lines 123-129 Link Here
123	x-mojo-to: ERM::EUsage::DefaultUsageReports#delete	123	x-mojo-to: ERM::EUsage::DefaultUsageReports#delete
124	operationId: deleteERMDefaultUsageReports	124	operationId: deleteERMDefaultUsageReports
125	tags:	125	tags:
126	- default_usage_report	126	- erm_default_usage_reports
127	summary: Delete default_usage_report	127	summary: Delete default_usage_report
128	produces:	128	produces:
129	- application/json	129	- application/json