CHANGELOG.md

@@ -5,15 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.0] - 2023-04-05
+
+### Added
+
+- Card API /card-identifiers bulk update endpoint.
+- Card API added 'soft_delete' action to /card-identifiers endpoint.
+
 ## [1.3.0] - 2023-03-30
 
 ### Added
 
-- Card API /card-identifiers filter by is_highest_primary_identifier
+- Card API /card-identifiers filter by is_highest_primary_identifier.
 
 ### Changed
 
-- Card API /card-identifiers delete operation returns 200
+- Card API /card-identifiers delete operation returns 200.
 
 ## [1.2.0] - 2023-03-16
 
@@ -24,8 +31,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Card API /card-identifiers action 'update' renamed to 'set_retention'
-- Photo API /card-identifiers action 'update' renamed to 'set_retention'
+- Card API /card-identifiers action 'update' renamed to 'set_retention'.
+- Photo API /card-identifiers action 'update' renamed to 'set_retention'.
 
 ## [1.1.0] - 2023-03-08
 

requirements-tests.txt

 coverage
+freezegun
 pytest
 pytest-cov
 requests_mock
-urllib3-mock
-freezegun
\ No newline at end of file
+urllib3-mock
\ No newline at end of file

requirements.txt

 dataclasses
 frozendict
 python-dateutil
-urllib3
 requests
+urllib3

setup.py

@@ -8,7 +8,7 @@ PACKAGE_DESCRIPTION = (
     "A module containing helpers and shared code related to identity systems within UIS, "
     "University of Cambridge."
 )
-PACKAGE_VERSION = "1.3.0"
+PACKAGE_VERSION = "1.4.0"
 PACKAGE_URL = "https://gitlab.developers.cam.ac.uk/uis/devops/iam/identity-lib"
 
 

specs/card.sha

-6a7f39b11c79b2a4b777e282d4e67083ad5c88d3
\ No newline at end of file
+f095fe5713abb02bfa6a209036ca494dce5e50d2
\ No newline at end of file

specs/card.yaml

@@ -1179,6 +1179,76 @@ paths:
       tags:
         - v1beta1
     parameters: []
+  /v1beta1/card-identifiers/update:
+    parameters: []
+    put:
+      description: |2+
+
+        ## Update multiple card identifiers
+
+        Allows multiple card identifiers to be updated in one call. For large number of card identifiers, this endpoint will be faster than PUT-ing each update.
+
+        Updates are processed in the order they are received. The response includes the detail of the operation, the UUID of the card identifier that was updated, and HTTP status code which would have been returned from separate PUTs. If the status code is 404, the `id` property is omitted.
+
+        ### Permissions
+
+        Principals with the `CARD_ADMIN` permission will be able to affect this endpoint.
+
+      operationId: v1beta1_card-identifiers_bulk_update
+      parameters:
+        - in: body
+          name: data
+          required: true
+          schema:
+            properties:
+              updates:
+                items:
+                  properties:
+                    action:
+                      description: The action to apply to this card identifier.
+                      enum:
+                        - set_retention
+                        - restore
+                        - soft_delete
+                        - hard_delete
+                      title: CardIdentifierUpdateRequesstActionEnum
+                      type: string
+                    id:
+                      description: id of the card identifier
+                      type: string
+                  type: object
+                type: array
+            title: CardIdentifierBulkUpdateRequestType
+            type: object
+      responses:
+        "200":
+          description: ""
+          schema:
+            properties:
+              details:
+                items:
+                  properties:
+                    detail:
+                      type: string
+                    id:
+                      type: string
+                    status:
+                      type: number
+                  type: object
+                type: array
+            title: CardIdentifierBulkUpdateResponseType
+            type: object
+        "400":
+          description: Invalid input.
+          schema:
+            $ref: '#/definitions/ValidationError'
+        "401":
+          description: Authentication credentials are invalid or absent.
+        "500":
+          description: An error has occurred - retry the request after a pause.
+      summary: Update multiple card identifiers
+      tags:
+        - v1beta1
   /v1beta1/card-identifiers/{id}:
     delete:
       description: |2+
@@ -1274,7 +1344,7 @@ paths:
 
         ## Update the card identifier
 
-        This method allows a client to submit an action in the request body for a given card identifier. The allowed actions are `set_retention`, `restore` and `hard_delete`.
+        This method allows a client to submit an action in the request body for a given card identifier. The allowed actions are `set_retention`, `restore`, `soft_delete` and `hard_delete`.
 
         ### Permissions
 
@@ -1293,6 +1363,7 @@ paths:
                 enum:
                   - set_retention
                   - restore
+                  - soft_delete
                   - hard_delete
                 title: CardIdentifierUpdateRequesstActionEnum
                 type: string