Fix hide API of Transfer & Ingest (#454)

* Fix hide API of Transfer & Ingest * Update dev-manual/api/api-reference-archivematica.rst Co-authored-by: Douglas Cerna <[email protected]> * Run pre-commit * Fix the changes * Update dev-manual/api/api-reference-archivematica.rst Co-authored-by: Douglas Cerna <[email protected]> * Update dev-manual/api/api-reference-archivematica.rst Co-authored-by: Douglas Cerna <[email protected]> * Update dev-manual/api/api-reference-archivematica.rst Co-authored-by: Douglas Cerna <[email protected]> * Update dev-manual/api/api-reference-archivematica.rst Co-authored-by: Douglas Cerna <[email protected]> --------- Co-authored-by: Douglas Cerna <[email protected]>
artefactual · Mar 18, 2024 · 0011828 · 0011828
1 parent 2a97626
commit 0011828
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 8 deletions.
diff --git a/dev-manual/api/_code/hide_request_ingest.curl b/dev-manual/api/_code/hide_request_ingest.curl
@@ -0,0 +1,4 @@
+curl -X DELETE \
+    http://my_archivematica_instance.archivematica.org/api/ingest/ \
+    89fd478d-c896-461a-baec-5d1faf661020/delete/ \
+    -H 'Authorization: ApiKey [_your_username_]:[_your_ApiKey_]'
diff --git a/dev-manual/api/_code/hide_request.curl → ...nual/api/_code/hide_request_transfer.curl b/dev-manual/api/_code/hide_request.curl → ...nual/api/_code/hide_request_transfer.curl
@@ -1,5 +1,4 @@
 curl -X DELETE \
-    http://my_archivematica_instance.archivematica.org/api/transfer/status/
-    89fd478d-c896-461a-baec-5d1faf661020/ \
-    -H 'Authorization: ApiKey [_your_username_]:[_your_ApiKey_]' \
-    -H 'Host: my_archivematica_instance.archivematica.org'
+    http://my_archivematica_instance.archivematica.org/api/transfer/
+    89fd478d-c896-461a-baec-5d1faf661020/delete/ \
+    -H 'Authorization: ApiKey [_your_username_]:[_your_ApiKey_]'
diff --git a/dev-manual/api/api-reference-archivematica.rst b/dev-manual/api/api-reference-archivematica.rst
@@ -224,15 +224,26 @@ Hide
              delete/**
 ===========  =================================   ==============================
 
+Request body parameters:
+
+=================   =====================
+``transfer_uuid``   UUID of the transfer.
+=================   =====================
+
+Response definitions:
+
+===========   ======================
+``removed``   Boolean true or false.
+===========   ======================
+
 Example request:
 
-.. literalinclude:: _code/hide_request.curl
+.. literalinclude:: _code/hide_request_transfer.curl
 
 Example response:
 
 .. literalinclude:: _code/hide_response.curl
 
-
 Completed
 ^^^^^^^^^
 
@@ -352,15 +363,25 @@ Hide
 ``DELETE``   **/api/ingest/<SIP UUID>/delete/**  *Hides a SIP.*
 ===========  =================================== ==============================
 
+Request body parameters:
+=============  ================
+``sip_uuid``   UUID of the SIP.
+=============  ================
+
+Response definitions:
+
+===========   ======================
+``removed``   Boolean true or false.
+===========   ======================
+
 Example request:
 
-.. literalinclude:: _code/hide_request.curl
+.. literalinclude:: _code/hide_request_ingest.curl
 
 Example response:
 
 .. literalinclude:: _code/hide_response.curl
 
-
 List SIPS Waiting for User Input
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^