From 4a610ab7dc9e8d2eb81967a479ebaeb7a33b97e2 Mon Sep 17 00:00:00 2001 From: Tomas Cohen Arazi Date: Wed, 10 Apr 2024 14:04:57 +0200 Subject: [PATCH] Bug 36565: Preservation module API docs fixes (bug 30708 follow-up) Signed-off-by: Tomas Cohen Arazi Signed-off-by: David Nind Signed-off-by: Martin Renvoize --- api/v1/swagger/paths/preservation_config.yaml | 2 +- .../paths/preservation_processings.yaml | 10 ++++----- api/v1/swagger/paths/preservation_trains.yaml | 22 +++++++++---------- .../paths/preservation_waiting_list.yaml | 6 ++--- api/v1/swagger/swagger.yaml | 3 +++ 5 files changed, 23 insertions(+), 20 deletions(-) diff --git a/api/v1/swagger/paths/preservation_config.yaml b/api/v1/swagger/paths/preservation_config.yaml index 59cd7d4a4d3..925f3aee7d3 100644 --- a/api/v1/swagger/paths/preservation_config.yaml +++ b/api/v1/swagger/paths/preservation_config.yaml @@ -6,7 +6,7 @@ description: This resource returns a list of options needed for the Preservation Vue app. EXPERIMENTAL - DO NOT RELY on this, it is subject to change! summary: get the Preservation config tags: - - Preservation + - preservation produces: - application/json responses: diff --git a/api/v1/swagger/paths/preservation_processings.yaml b/api/v1/swagger/paths/preservation_processings.yaml index 092c470558c..eac8f25955d 100644 --- a/api/v1/swagger/paths/preservation_processings.yaml +++ b/api/v1/swagger/paths/preservation_processings.yaml @@ -4,7 +4,7 @@ x-mojo-to: Preservation::Processings#list operationId: listPreservationProcessings tags: - - preservation_processing + - preservation summary: List processings produces: - application/json @@ -57,7 +57,7 @@ x-mojo-to: Preservation::Processings#add operationId: addPreservationProcessings tags: - - preservation_processing + - preservation summary: Add processing consumes: - application/json @@ -118,7 +118,7 @@ x-mojo-to: Preservation::Processings#get operationId: getPreservationProcessings tags: - - preservation_processing + - preservation summary: Get processing produces: - application/json @@ -169,7 +169,7 @@ x-mojo-to: Preservation::Processings#update operationId: updatePreservationProcessings tags: - - preservation_processing + - preservation summary: Update processing consumes: - application/json @@ -227,7 +227,7 @@ x-mojo-to: Preservation::Processings#delete operationId: deletePreservationProcessings tags: - - preservation_processing + - preservation summary: Delete processing produces: - application/json diff --git a/api/v1/swagger/paths/preservation_trains.yaml b/api/v1/swagger/paths/preservation_trains.yaml index fca0cda0bec..9644581fd7c 100644 --- a/api/v1/swagger/paths/preservation_trains.yaml +++ b/api/v1/swagger/paths/preservation_trains.yaml @@ -4,7 +4,7 @@ x-mojo-to: Preservation::Trains#list operationId: listPreservationTrains tags: - - preservation_train + - preservation summary: List trains produces: - application/json @@ -88,7 +88,7 @@ x-mojo-to: Preservation::Trains#add operationId: addPreservationTrains tags: - - preservation_train + - preservation summary: Add train consumes: - application/json @@ -150,7 +150,7 @@ x-mojo-to: Preservation::Trains#get operationId: getPreservationTrains tags: - - preservation_train + - preservation summary: Get train produces: - application/json @@ -208,7 +208,7 @@ x-mojo-to: Preservation::Trains#update operationId: updatePreservationTrains tags: - - preservation_train + - preservation summary: Update train consumes: - application/json @@ -266,7 +266,7 @@ x-mojo-to: Preservation::Trains#delete operationId: deletePreservationTrains tags: - - preservation_train + - preservation summary: Delete train produces: - application/json @@ -314,7 +314,7 @@ x-mojo-to: Preservation::Trains#add_item operationId: addItemToTrain tags: - - preservation_train + - preservation summary: Add item to train consumes: - application/json @@ -376,7 +376,7 @@ x-mojo-to: Preservation::Trains#add_items operationId: addItemsToTrain tags: - - preservation_train + - preservation summary: Add items to train consumes: - application/json @@ -442,7 +442,7 @@ x-mojo-to: Preservation::Trains#update_item operationId: updateItemFromTrain tags: - - preservation_train + - preservation summary: Update item from train consumes: - application/json @@ -510,7 +510,7 @@ x-mojo-to: Preservation::Trains#remove_item operationId: removeItemFromTrain tags: - - preservation_train + - preservation summary: Remove item from train parameters: - $ref: "../swagger.yaml#/parameters/preservation_train_id_pp" @@ -554,7 +554,7 @@ x-mojo-to: Preservation::Trains#get_item operationId: getItemFromPreservationTrains tags: - - preservation_train + - preservation summary: Get item from train produces: - application/json @@ -610,7 +610,7 @@ x-mojo-to: Preservation::Trains#copy_item operationId: copyItemToAnotherTrain tags: - - preservation_train + - preservation summary: Copy an item to an other train consumes: - application/json diff --git a/api/v1/swagger/paths/preservation_waiting_list.yaml b/api/v1/swagger/paths/preservation_waiting_list.yaml index 73b93502929..26f1ef65486 100644 --- a/api/v1/swagger/paths/preservation_waiting_list.yaml +++ b/api/v1/swagger/paths/preservation_waiting_list.yaml @@ -4,7 +4,7 @@ x-mojo-to: Preservation::WaitingList#list operationId: listItemsFromWaitingList tags: - - waiting_list + - preservation summary: List items from waiting list parameters: - name: external_id @@ -70,7 +70,7 @@ x-mojo-to: Preservation::WaitingList#add_items operationId: addItemsToWaitingList tags: - - waiting_list + - preservation summary: Add items to waiting list consumes: - application/json @@ -135,7 +135,7 @@ x-mojo-to: Preservation::WaitingList#remove_item operationId: removeItemFromWaitingList tags: - - waiting_list + - preservation summary: Remove item from waiting list parameters: - $ref: "../swagger.yaml#/parameters/item_id_pp" diff --git a/api/v1/swagger/swagger.yaml b/api/v1/swagger/swagger.yaml index 7f37a34f84c..649000adca2 100644 --- a/api/v1/swagger/swagger.yaml +++ b/api/v1/swagger/swagger.yaml @@ -1194,6 +1194,9 @@ tags: - description: "Manage patrons\n" name: patrons x-displayName: Patrons + - description: "Manage preservation tasks\n" + name: preservation + x-displayName: Preservation - description: "Manage purchase suggestions\n" name: suggestions x-displayName: Purchase suggestions -- 2.44.0