From 5125195a52e7730c07d207db71507c4570f51a08 Mon Sep 17 00:00:00 2001 From: Matt Blenkinsop Date: Thu, 27 Apr 2023 10:49:46 +0000 Subject: [PATCH] Bug 34587: API swagger paths and definitions Signed-off-by: Jessica Zairo Signed-off-by: Michaela Sieber Signed-off-by: Nick Clemens Signed-off-by: Tomas Cohen Arazi --- .../swagger/definitions/erm_counter_file.yaml | 36 ++ .../swagger/definitions/erm_counter_log.yaml | 37 ++ .../definitions/erm_usage_data_provider.yaml | 100 +++++ api/v1/swagger/definitions/erm_usage_mus.yaml | 47 +++ .../swagger/definitions/erm_usage_title.yaml | 60 +++ api/v1/swagger/definitions/erm_usage_yus.yaml | 43 +++ api/v1/swagger/paths/erm_counter_files.yaml | 193 ++++++++++ .../paths/erm_usage_data_providers.yaml | 362 ++++++++++++++++++ api/v1/swagger/paths/erm_usage_titles.yaml | 93 +++++ api/v1/swagger/swagger.yaml | 52 +++ 10 files changed, 1023 insertions(+) create mode 100644 api/v1/swagger/definitions/erm_counter_file.yaml create mode 100644 api/v1/swagger/definitions/erm_counter_log.yaml create mode 100644 api/v1/swagger/definitions/erm_usage_data_provider.yaml create mode 100644 api/v1/swagger/definitions/erm_usage_mus.yaml create mode 100644 api/v1/swagger/definitions/erm_usage_title.yaml create mode 100644 api/v1/swagger/definitions/erm_usage_yus.yaml create mode 100644 api/v1/swagger/paths/erm_counter_files.yaml create mode 100644 api/v1/swagger/paths/erm_usage_data_providers.yaml create mode 100644 api/v1/swagger/paths/erm_usage_titles.yaml diff --git a/api/v1/swagger/definitions/erm_counter_file.yaml b/api/v1/swagger/definitions/erm_counter_file.yaml new file mode 100644 index 0000000000..17eea906c1 --- /dev/null +++ b/api/v1/swagger/definitions/erm_counter_file.yaml @@ -0,0 +1,36 @@ +--- +type: object +properties: + erm_counter_files_id: + type: integer + description: internally assigned counter_files identifier + readOnly: true + usage_data_provider_id: + description: usage_data_provider_id of the counter_files + type: integer + type: + description: type of the counter_files + type: + - string + - "null" + filename: + description: filename + type: string + file_content: + description: file_content + type: string + date_uploaded: + type: string + format: date-time + description: Timestamp for the date of upload + counter_logs: + type: array + description: counter logs + items: + $ref: erm_counter_log.yaml + +additionalProperties: false +required: + - usage_data_provider_id + - filename + - file_content \ No newline at end of file diff --git a/api/v1/swagger/definitions/erm_counter_log.yaml b/api/v1/swagger/definitions/erm_counter_log.yaml new file mode 100644 index 0000000000..897dcee683 --- /dev/null +++ b/api/v1/swagger/definitions/erm_counter_log.yaml @@ -0,0 +1,37 @@ +--- +type: object +properties: + erm_counter_log_id: + type: integer + description: internally assigned counter_log identifier + readOnly: true + counter_files_id: + description: counter_files_id of the counter_log + type: + - integer + - "null" + borrowernumber: + description: borrowernumber of the counter_log + type: + - integer + - "null" + importdate: + type: string + format: date-time + description: Timestamp for the date of upload + filename: + description: filename of the counter_file + type: + - string + - "null" + logdetails: + description: logdetails of the counter_log + type: + - string + - "null" + +additionalProperties: false +required: + - filename + - borrowernumber + - counter_files_id \ No newline at end of file diff --git a/api/v1/swagger/definitions/erm_usage_data_provider.yaml b/api/v1/swagger/definitions/erm_usage_data_provider.yaml new file mode 100644 index 0000000000..8db15ae256 --- /dev/null +++ b/api/v1/swagger/definitions/erm_usage_data_provider.yaml @@ -0,0 +1,100 @@ +--- +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" + begin_date: + type: + - string + - "null" + format: date + description: Start of the harvester + end_date: + type: + - string + - "null" + format: date + description: End of the harvester + 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" + counter_files: + type: array + description: counter files + items: + $ref: erm_counter_file.yaml + +additionalProperties: false +required: + - name + - customer_id + - requestor_id + - service_url + - report_release diff --git a/api/v1/swagger/definitions/erm_usage_mus.yaml b/api/v1/swagger/definitions/erm_usage_mus.yaml new file mode 100644 index 0000000000..585fb29570 --- /dev/null +++ b/api/v1/swagger/definitions/erm_usage_mus.yaml @@ -0,0 +1,47 @@ +--- +type: object +properties: + monthly_usage_summary_id: + type: integer + description: internally assigned monthly usage summary identifier + readOnly: true + title_id: + description: title_id of the monthly usage summary + type: + - integer + - "null" + usage_data_provider_id: + description: usage_data_provider_id of the monthly usage summary + type: + - integer + - "null" + year: + description: year of the monthly usage summary + type: + - integer + - "null" + month: + description: month of the monthly usage summary + type: + - integer + - "null" + usage_count: + description: total count of the monthly usage summary + type: + - integer + - "null" + metric_type: + description: metric type of the monthly usage summary + type: + - string + - "null" + report_type: + description: report type of the monthly usage summary + type: + - string + - "null" + +additionalProperties: false +required: + - title_id + - usage_data_provider_id \ No newline at end of file diff --git a/api/v1/swagger/definitions/erm_usage_title.yaml b/api/v1/swagger/definitions/erm_usage_title.yaml new file mode 100644 index 0000000000..fcc2e01b67 --- /dev/null +++ b/api/v1/swagger/definitions/erm_usage_title.yaml @@ -0,0 +1,60 @@ +--- +type: object +properties: + title_id: + type: integer + description: internally assigned title identifier + readOnly: true + title: + description: title of the title + type: + - string + - "null" + usage_data_provider_id: + description: usage_data_provider the title is harvested by + type: integer + title_doi: + description: doi number of the title + type: + - string + - "null" + print_issn: + description: print_issn number of the title + type: + - string + - "null" + online_issn: + description: online_issn number of the title + type: + - string + - "null" + title_uri: + description: title_uri number of the title + type: + - string + - "null" + provider_name: + description: provider_name of the title + type: + - string + - "null" + metric_type: + description: metric_type of the title data + type: + - string + - "null" + erm_usage_muses: + type: array + description: usage mus + items: + $ref: erm_usage_mus.yaml + erm_usage_yuses: + type: array + description: usage yus + items: + $ref: erm_usage_yus.yaml + +additionalProperties: false +required: + - title + - usage_data_provider_id diff --git a/api/v1/swagger/definitions/erm_usage_yus.yaml b/api/v1/swagger/definitions/erm_usage_yus.yaml new file mode 100644 index 0000000000..4504aa21c7 --- /dev/null +++ b/api/v1/swagger/definitions/erm_usage_yus.yaml @@ -0,0 +1,43 @@ +--- +type: object +properties: + yearly_usage_summary_id: + type: integer + description: internally assigned yearly usage summary identifier + readOnly: true + title_id: + description: title_id of the yearly usage summary + type: + - integer + - "null" + usage_data_provider_id: + description: usage_data_provider_id of the yearly usage summary + type: + - integer + - "null" + year: + description: year of the yearly usage summary + type: + - integer + - "null" + totalcount: + description: total count of the yearly usage summary + type: + - integer + - "null" + metric_type: + description: metric type of the yearly usage summary + type: + - string + - "null" + report_type: + description: report type of the yearly usage summary + type: + - string + - "null" + + +additionalProperties: false +required: + - title_id + - usage_data_provider_id \ No newline at end of file diff --git a/api/v1/swagger/paths/erm_counter_files.yaml b/api/v1/swagger/paths/erm_counter_files.yaml new file mode 100644 index 0000000000..fde2a8b071 --- /dev/null +++ b/api/v1/swagger/paths/erm_counter_files.yaml @@ -0,0 +1,193 @@ +--- +/erm/counter_files: + get: + x-mojo-to: ERM::CounterFiles#list + operationId: listErmCounterFiles + tags: + - counter_file + summary: List counter_files + produces: + - application/json + parameters: + - description: Case insensitive search on counter_file erm_counter_files_id + in: query + name: erm_counter_files_id + required: false + type: integer + - description: Case insensitive search on counter_file usage_data_provider_id + in: query + name: usage_data_provider_id + required: false + type: integer + - description: Case insensitive search on counter_file filename + in: query + name: filename + required: false + type: string + - description: Case insensitive search on counter_file type + in: query + name: type + required: false + type: string + - description: Case insensitive search on counter_file file_content + in: query + name: file_content + required: false + type: string + - description: Case insensitive search on counter_file date_uploaded + in: query + name: date_uploaded + required: false + type: string + - name: x-koha-embed + in: header + required: false + description: Embed list sent as a request header + type: array + items: + type: string + enum: + - counter_logs + collectionFormat: csv + - $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" + responses: + 200: + description: A list of counter_files + schema: + items: + $ref: "../swagger.yaml#/definitions/erm_counter_file" + type: array + 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 + post: + x-mojo-to: ERM::CounterFiles#add + operationId: addErmCounterFiles + tags: + - counter_file + summary: Add counter_file + consumes: + - application/json + produces: + - application/json + parameters: + - description: A JSON object containing information about the new counter_file + in: body + name: body + required: true + schema: + $ref: "../swagger.yaml#/definitions/erm_counter_file" + responses: + 201: + description: A successfully created counter_file + schema: + items: + $ref: "../swagger.yaml#/definitions/erm_counter_file" + 400: + description: Bad parameter + schema: + $ref: "../swagger.yaml#/definitions/error" + 401: + description: Authentication required + schema: + $ref: "../swagger.yaml#/definitions/error" + 403: + description: Access forbidden + schema: + $ref: "../swagger.yaml#/definitions/error" + 404: + description: Ressource not found + schema: + $ref: "../swagger.yaml#/definitions/error" + 409: + description: Conflict in creating resource + schema: + $ref: "../swagger.yaml#/definitions/error" + 413: + description: Payload too large + 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 +"/erm/counter_files/{erm_counter_files_id}": + delete: + x-mojo-to: ERM::CounterFiles#delete + operationId: deleteERMCounterFiles + tags: + - counter_file + summary: Delete counter_file + produces: + - application/json + parameters: + - $ref: "../swagger.yaml#/parameters/erm_counter_files_id_pp" + responses: + 204: + description: counter_file deleted + 400: + description: counter_file deletion failed + schema: + $ref: "../swagger.yaml#/definitions/error" + 401: + description: authentication required + schema: + $ref: "../swagger.yaml#/definitions/error" + 403: + description: access forbidden + schema: + $ref: "../swagger.yaml#/definitions/error" + 404: + description: ressource not found + schema: + $ref: "../swagger.yaml#/definitions/error" + 409: + description: conflict in deleting resource + 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 \ No newline at end of file diff --git a/api/v1/swagger/paths/erm_usage_data_providers.yaml b/api/v1/swagger/paths/erm_usage_data_providers.yaml new file mode 100644 index 0000000000..18c79ae105 --- /dev/null +++ b/api/v1/swagger/paths/erm_usage_data_providers.yaml @@ -0,0 +1,362 @@ +--- +/erm/usage_data_providers: + get: + x-mojo-to: ERM::UsageDataProviders#list + operationId: listErmUsageDataProviders + tags: + - usage_data_provider + summary: List usage_data_providers + produces: + - application/json + parameters: + - description: Case insensitive search on usage_data_provider usage_data_provider_id + in: query + name: usage_data_provider_id + required: false + type: integer + - description: Case insensitive search on usage_data_provider name + in: query + name: name + required: false + type: string + - description: Case insensitive search on usage_data_provider description + in: query + name: description + required: false + type: string + - description: Case insensitive search on usage_data_provider active + in: query + name: active + required: false + type: integer + - description: Case insensitive search on usage_data_provider method + in: query + name: method + required: false + type: string + - description: Case insensitive search on usage_data_provider aggregator + in: query + name: aggregator + required: false + type: string + - description: Case insensitive search on usage_data_provider service_type + in: query + name: service_type + required: false + type: string + - description: Case insensitive search on usage_data_provider service_url + in: query + name: service_url + required: false + type: string + - description: Case insensitive search on usage_data_provider report_release + in: query + name: report_release + required: false + type: string + - description: Case insensitive search on usage_data_provider begin_date + in: query + name: begin_date + required: false + type: string + - description: Case insensitive search on usage_data_provider end_date + in: query + name: end_date + required: false + type: string + - description: Case insensitive search on usage_data_provider customer_id + in: query + name: customer_id + required: false + type: string + - description: Case insensitive search on usage_data_provider requestor_id + in: query + name: requestor_id + required: false + type: string + - description: Case insensitive search on usage_data_provider api_key + in: query + name: api_key + required: false + type: string + - description: Case insensitive search on usage_data_provider requestor_name + in: query + name: requestor_name + required: false + type: string + - description: Case insensitive search on usage_data_provider requestor_email + in: query + name: requestor_email + required: false + type: string + - description: Case insensitive search on usage_data_provider report_types + in: query + name: report_types + required: false + type: string + - name: x-koha-embed + in: header + required: false + description: Embed list sent as a request header + type: array + items: + type: string + enum: + - counter_files + collectionFormat: csv + - $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" + responses: + 200: + description: A list of usage_data_providers + schema: + items: + $ref: "../swagger.yaml#/definitions/erm_usage_data_provider" + type: array + 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 + post: + x-mojo-to: ERM::UsageDataProviders#add + operationId: addErmUsageDataProviders + tags: + - usage_data_provider + summary: Add usage_data_provider + consumes: + - application/json + produces: + - application/json + parameters: + - description: A JSON object containing information about the new usage_data_provider + in: body + name: body + required: true + schema: + $ref: "../swagger.yaml#/definitions/erm_usage_data_provider" + responses: + 201: + description: A successfully created usage_data_provider + schema: + items: + $ref: "../swagger.yaml#/definitions/erm_usage_data_provider" + 400: + description: Bad parameter + schema: + $ref: "../swagger.yaml#/definitions/error" + 401: + description: Authentication required + schema: + $ref: "../swagger.yaml#/definitions/error" + 403: + description: Access forbidden + schema: + $ref: "../swagger.yaml#/definitions/error" + 404: + description: Ressource not found + schema: + $ref: "../swagger.yaml#/definitions/error" + 409: + description: Conflict in creating resource + schema: + $ref: "../swagger.yaml#/definitions/error" + 413: + description: Payload too large + 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 +"/erm/usage_data_providers/{erm_usage_data_provider_id}": + get: + x-mojo-to: ERM::UsageDataProviders#get + operationId: getERMUsageDataProvider + tags: + - usage_data_provider + summary: get usage_data_provider + produces: + - application/json + parameters: + - $ref: "../swagger.yaml#/parameters/erm_usage_data_provider_id_pp" + - name: x-koha-embed + in: header + required: false + description: Embed list sent as a request header + type: array + items: + type: string + collectionFormat: csv + responses: + 200: + description: usage_data_provider + schema: + items: + $ref: "../swagger.yaml#/definitions/erm_usage_data_provider" + 401: + description: authentication required + schema: + $ref: "../swagger.yaml#/definitions/error" + 403: + description: access forbidden + schema: + $ref: "../swagger.yaml#/definitions/error" + 404: + description: ressource not found + 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 + put: + x-mojo-to: ERM::UsageDataProviders#update + operationId: updateERMUsageDataProviders + tags: + - usage_data_provider + summary: update usage_data_provider + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "../swagger.yaml#/parameters/erm_usage_data_provider_id_pp" + - name: body + in: body + description: a json object containing new information about existing usage_data_provider + required: true + schema: + $ref: "../swagger.yaml#/definitions/erm_usage_data_provider" + - name: x-koha-embed + in: header + required: false + description: Embed list sent as a request header + type: array + items: + type: string + collectionFormat: csv + responses: + 200: + description: a successfully updated usage_data_provider + schema: + items: + $ref: "../swagger.yaml#/definitions/erm_usage_data_provider" + 400: + description: bad parameter + schema: + $ref: "../swagger.yaml#/definitions/error" + 403: + description: access forbidden + schema: + $ref: "../swagger.yaml#/definitions/error" + 404: + description: ressource not found + schema: + $ref: "../swagger.yaml#/definitions/error" + 409: + description: conflict in updating resource + schema: + $ref: "../swagger.yaml#/definitions/error" + 413: + description: Payload too large + 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 + delete: + x-mojo-to: ERM::UsageDataProviders#delete + operationId: deleteERMUsageDataProviders + tags: + - usage_data_provider + summary: Delete usage_data_provider + produces: + - application/json + parameters: + - $ref: "../swagger.yaml#/parameters/erm_usage_data_provider_id_pp" + responses: + 204: + description: usage_data_provider deleted + 400: + description: usage_data_provider deletion failed + schema: + $ref: "../swagger.yaml#/definitions/error" + 401: + description: authentication required + schema: + $ref: "../swagger.yaml#/definitions/error" + 403: + description: access forbidden + schema: + $ref: "../swagger.yaml#/definitions/error" + 404: + description: ressource not found + schema: + $ref: "../swagger.yaml#/definitions/error" + 409: + description: conflict in deleting resource + 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 \ No newline at end of file diff --git a/api/v1/swagger/paths/erm_usage_titles.yaml b/api/v1/swagger/paths/erm_usage_titles.yaml new file mode 100644 index 0000000000..dc59cd2c59 --- /dev/null +++ b/api/v1/swagger/paths/erm_usage_titles.yaml @@ -0,0 +1,93 @@ +--- +/erm/usage_titles: + get: + x-mojo-to: ERM::UsageTitles#list + operationId: listErmUsageTitles + tags: + - usage_title + summary: List usage_titles + produces: + - application/json + parameters: + - description: Case insensitive search on usage_title title_id + in: query + name: title_id + required: false + type: integer + - description: Case insensitive search on usage_title title + in: query + name: title + required: false + type: string + - description: Case insensitive search on usage_title usage_data_provider_id + in: query + name: usage_data_provider_id + required: false + type: string + - description: Case insensitive search on usage_title title_doi + in: query + name: title_doi + required: false + type: string + - description: Case insensitive search on usage_title print_issn + in: query + name: print_issn + required: false + type: string + - description: Case insensitive search on usage_title online_issn + in: query + name: online_issn + required: false + type: string + - description: Case insensitive search on usage_title title_uri + in: query + name: title_uri + required: false + type: string + - name: x-koha-embed + in: header + required: false + description: Embed list sent as a request header + type: array + items: + type: string + enum: + - erm_usage_muses + - erm_usage_yuses + collectionFormat: csv + - $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" + - $ref: "../swagger.yaml#/parameters/request_id_header" + responses: + 200: + description: A list of usage_titles + schema: + items: + $ref: "../swagger.yaml#/definitions/erm_usage_title" + type: array + 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 \ No newline at end of file diff --git a/api/v1/swagger/swagger.yaml b/api/v1/swagger/swagger.yaml index cdca970837..162e6b5d66 100644 --- a/api/v1/swagger/swagger.yaml +++ b/api/v1/swagger/swagger.yaml @@ -40,6 +40,10 @@ definitions: $ref: ./definitions/erm_config.yaml erm_agreement: $ref: ./definitions/erm_agreement.yaml + erm_counter_file: + $ref: ./definitions/erm_counter_file.yaml + erm_counter_log: + $ref: ./definitions/erm_counter_log.yaml erm_eholdings_title: $ref: ./definitions/erm_eholdings_title.yaml erm_eholdings_package: @@ -48,6 +52,14 @@ definitions: $ref: ./definitions/erm_eholdings_resource.yaml erm_license: $ref: ./definitions/erm_license.yaml + erm_usage_data_provider: + $ref: ./definitions/erm_usage_data_provider.yaml + erm_usage_mus: + $ref: ./definitions/erm_usage_mus.yaml + erm_usage_title: + $ref: ./definitions/erm_usage_title.yaml + erm_usage_yus: + $ref: ./definitions/erm_usage_yus.yaml error: $ref: ./definitions/error.yaml fund: @@ -243,6 +255,16 @@ paths: $ref: "./paths/erm_agreements.yaml#/~1erm~1agreements~1{agreement_id}" "/erm/documents/{document_id}/file/content": $ref: "./paths/erm_documents.yaml#/~1erm~1documents~1{document_id}~1file~1content" + /erm/counter_files: + $ref: ./paths/erm_counter_files.yaml#/~1erm~1counter_files + "/erm/counter_files/{erm_counter_files_id}": + $ref: "./paths/erm_counter_files.yaml#/~1erm~1counter_files~1{erm_counter_files_id}" + "/erm/counter_files/{erm_counter_files_id}/file/content": + $ref: "./paths/erm_counter_files.yaml#/~1erm~1counter_files~1{erm_counter_files_id}~1file~1content" + /erm/default_usage_reports: + $ref: ./paths/erm_default_usage_reports.yaml#/~1erm~1default_usage_reports + "/erm/default_usage_reports/{erm_default_usage_report_id}": + $ref: "./paths/erm_default_usage_reports.yaml#/~1erm~1default_usage_reports~1{erm_default_usage_report_id}" "/erm/eholdings/{provider}/titles": $ref: "./paths/erm_eholdings_titles.yaml#/~1erm~1eholdings~1{provider}~1titles" /erm/eholdings/local/titles/import: @@ -265,6 +287,12 @@ paths: $ref: ./paths/erm_licenses.yaml#/~1erm~1licenses "/erm/licenses/{license_id}": $ref: "./paths/erm_licenses.yaml#/~1erm~1licenses~1{license_id}" + /erm/usage_data_providers: + $ref: ./paths/erm_usage_data_providers.yaml#/~1erm~1usage_data_providers + "/erm/usage_data_providers/{erm_usage_data_provider_id}": + $ref: "./paths/erm_usage_data_providers.yaml#/~1erm~1usage_data_providers~1{erm_usage_data_provider_id}" + /erm/usage_titles: + $ref: ./paths/erm_usage_titles.yaml#/~1erm~1usage_titles /erm/users: $ref: ./paths/erm_users.yaml#/~1erm~1users /holds: @@ -555,6 +583,30 @@ parameters: name: resource_id required: true type: string + erm_counter_files_id_pp: + description: ERM counter_files internal identifier + in: path + name: erm_counter_files_id + required: true + type: integer + erm_counter_log_id_pp: + description: ERM counter_log internal identifier + in: path + name: erm_counter_log_id + required: true + type: integer + erm_usage_data_provider_id_pp: + description: ERM usage_data_provider internal identifier + in: path + name: erm_usage_data_provider_id + required: true + type: integer + data_type_pp: + description: ERM custom report data type + in: path + name: data_type + required: true + type: string fund_id_pp: description: Fund id in: path -- 2.39.5