Bugzilla – Attachment 167608 Details for
Bug 36565
Fix API docs inconsistencies
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
[23.11.x] Bug 36565: Preservation module API docs fixes (bug 30708 follow-up)
2311x-Bug-36565-Preservation-module-API-docs-fixes.patch (text/plain), 7.19 KB, created by
Tomás Cohen Arazi (tcohen)
on 2024-06-10 12:17:00 UTC
(
hide
)
Description:
[23.11.x] Bug 36565: Preservation module API docs fixes (bug 30708 follow-up)
Filename:
MIME Type:
Creator:
Tomás Cohen Arazi (tcohen)
Created:
2024-06-10 12:17:00 UTC
Size:
7.19 KB
patch
obsolete
>From b2d560d66e0f2545aab6cd3a397ed9d3745975b3 Mon Sep 17 00:00:00 2001 >From: Tomas Cohen Arazi <tomascohen@theke.io> >Date: Wed, 10 Apr 2024 14:04:57 +0200 >Subject: [PATCH] [23.11.x] Bug 36565: Preservation module API docs fixes (bug > 30708 follow-up) > >Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> >Signed-off-by: David Nind <david@davidnind.com> >Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> >--- > 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 f457133c085..eae1521f73b 100644 >--- a/api/v1/swagger/swagger.yaml >+++ b/api/v1/swagger/swagger.yaml >@@ -1172,6 +1172,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.45.2
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
|
Splinter Review
Attachments on
bug 36565
:
164612
|
164613
|
164614
|
164615
|
164616
|
164617
|
164642
|
164643
|
164644
|
164645
|
164646
|
164647
|
164648
|
164649
|
164650
|
164651
|
164652
|
164653
|
165698
|
165699
|
165700
|
165701
|
165702
|
165703
|
167604
|
167605
|
167606
|
167607
| 167608