CHANGELOG.md

@@ -5,6 +5,18 @@ 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.0.13] - 2022-09-28
+
+### Added
+
+- `created_at__lte` and `created_at__gte` filters to the card API client.
+- Invalidated state for Photos.
+- Added Card API 'refresh' action.
+
+### Changed 
+
+- Card API 'refute' action renamed to 'requeue' action.
+
 ## [1.0.12] - 2022-09-27
 
 ### Changed

Dockerfile

@@ -5,41 +5,43 @@ FROM openapitools/openapi-generator-cli as builder
 
 WORKDIR /generated
 
+COPY ./specs /specs
+
 # openapi-generator-cli v6.2.0 changed the python generator. Using 'python-prior' until we have
 # checked the impact of this change
 
 RUN docker-entrypoint.sh generate \
-    --input-spec https://developer.api.apps.cam.ac.uk/portals/api/sites/api-prod-a3dc87f7-prod/liveportal/apis/card/download_spec \
+    --input-spec /specs/card.yaml \
     --generator-name python-prior \
     --additional-properties packageName=identitylib.card_client \
     --output /generated
 
 RUN docker-entrypoint.sh generate \
-    --input-spec https://developer.api.apps.cam.ac.uk/portals/api/sites/api-prod-a3dc87f7-prod/liveportal/apis/university-human-resources/download_spec \
+    --input-spec /specs/hr.yaml \
     --generator-name python-prior \
     --additional-properties packageName=identitylib.hr_client \
     --output /generated
 
 RUN docker-entrypoint.sh generate \
-    --input-spec https://developer.api.apps.cam.ac.uk/portals/api/sites/api-prod-a3dc87f7-prod/liveportal/apis/lookup/download_spec \
+    --input-spec /specs/lookup.yaml \
     --generator-name python-prior \
     --additional-properties packageName=identitylib.lookup_client \
     --output /generated
 
 RUN docker-entrypoint.sh generate \
-    --input-spec https://developer.api.apps.cam.ac.uk/portals/api/sites/api-prod-a3dc87f7-prod/liveportal/apis/photo/download_spec \
+    --input-spec /specs/photo.yaml \
     --generator-name python-prior \
     --additional-properties packageName=identitylib.photo_client \
     --output /generated
 
 RUN docker-entrypoint.sh generate \
-    --input-spec https://developer.api.apps.cam.ac.uk/portals/api/sites/api-prod-a3dc87f7-prod/liveportal/apis/university-student/download_spec \
+    --input-spec /specs/student.yaml \
     --generator-name python-prior \
     --additional-properties packageName=identitylib.student_client \
     --output /generated
 
 RUN docker-entrypoint.sh generate \
-    --input-spec https://developer.api.apps.cam.ac.uk/portals/api/sites/api-prod-a3dc87f7-prod/liveportal/apis/inst-identifiers/download_spec \
+    --input-spec /specs/inst_identifier.yaml \
     --generator-name python-prior \
     --additional-properties packageName=identitylib.inst_identifier_client \
     --output /generated

MANIFEST.in

+include requirements.txt

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.0.12"
+PACKAGE_VERSION = "1.0.13"
 PACKAGE_URL = "https://gitlab.developers.cam.ac.uk/uis/devops/iam/identity-lib"
 
 

specs/card.sha

-f1717dd0be8fd51396f2da896510f0d335099233
\ No newline at end of file
+c3c9d005cbdb7e60f143ec3f253abb87b3af67c1
\ No newline at end of file

specs/card.yaml

@@ -594,20 +594,20 @@ paths:
           description: ""
           schema:
             required:
-              - v1beta1
               - v1alpha1
+              - v1beta1
             type: object
             properties:
-              v1beta1:
-                type: string
-                format: uri
-                example: <url for version v1beta1>
-                description: The URI for version v1beta1 of the API
               v1alpha1:
                 type: string
                 format: uri
                 example: <url for version v1alpha1>
                 description: The URI for version v1alpha1 of the API
+              v1beta1:
+                type: string
+                format: uri
+                example: <url for version v1beta1>
+                description: The URI for version v1beta1 of the API
       tags:
         - Versions
     parameters: []
@@ -1055,7 +1055,9 @@ paths:
 
         ### Permissions
 
-        Principals with the `CARD_NOTE_CREATOR` permission will be able to affect this endpoint.
+        Principals with the `CARD_NOTE_CREATOR` permission who created the card note instance will be able to affect this endpoint.
+
+        Principals with the `CARD_NOTE_UPDATER` permission will be able to affect this endpoint.
 
       parameters:
         - name: data
@@ -1122,6 +1124,16 @@ paths:
           description: ""
           required: false
           type: string
+        - name: created_at__lte
+          in: query
+          description: ""
+          required: false
+          type: string
+        - name: created_at__gte
+          in: query
+          description: ""
+          required: false
+          type: string
         - name: workflow_state
           in: query
           description: Filter card requests by their current workflow state
@@ -1388,9 +1400,10 @@ paths:
                         - release_hold
                         - add
                         - start
+                        - refresh
                         - abandon
                         - make
-                        - refute
+                        - requeue
                         - complete
                         - cancel
                     fields:
@@ -1492,7 +1505,7 @@ paths:
 
         ## Update the card request
 
-        This method allows a client to submit an action in the request body and optional identifier for a given card request. The available actions are `update`, `set_hold`, `release_hold`, `add`, `start`, `abandon`, `make`, `refute`, `complete` and `cancel`.
+        This method allows a client to submit an action in the request body and optional identifier for a given card request. The available actions are `update`, `set_hold`, `release_hold`, `add`, `start`, `refresh`, `abandon`, `make`, `requeue`, `complete` and `cancel`.
 
         For the `set_hold` action, the client can optionally append a `hold_reason` field describing the reason for holding the card request.
 
@@ -1525,9 +1538,10 @@ paths:
                   - release_hold
                   - add
                   - start
+                  - refresh
                   - abandon
                   - make
-                  - refute
+                  - requeue
                   - complete
                   - cancel
               fields:
@@ -1830,6 +1844,7 @@ definitions:
         type: string
         format: date-time
         readOnly: true
+        x-nullable: true
       canUpdate:
         title: Can update
         type: boolean
@@ -1871,11 +1886,13 @@ definitions:
         description: The height of the logo in pixels - not populated for svg logos
         type: integer
         readOnly: true
+        x-nullable: true
       imageWidth:
         title: Image width
         description: The width of the logo in pixels - not populated for svg logos
         type: integer
         readOnly: true
+        x-nullable: true
       createdAt:
         title: Created at
         description: When this logo was created
@@ -2005,12 +2022,14 @@ definitions:
         type: string
         format: date-time
         readOnly: true
+        x-nullable: true
       updatedAt:
         title: Updated at
         description: When this record was updated
         type: string
         format: date-time
         readOnly: true
+        x-nullable: true
       updatedBy:
         title: Updated by
         description: The identifier of the client who last updated this record
@@ -2128,12 +2147,14 @@ definitions:
         type: string
         format: date-time
         readOnly: true
+        x-nullable: true
       updatedAt:
         title: Updated at
         description: When this record was updated
         type: string
         format: date-time
         readOnly: true
+        x-nullable: true
       updatedBy:
         title: Updated by
         description: The identifier of the client who last updated this record
@@ -2240,6 +2261,7 @@ definitions:
         type: string
         format: date-time
         readOnly: true
+        x-nullable: true
   CardNote:
     required:
       - cardId

specs/photo.sha

-c5b5c999fd53ab4f9dd32f9e474b1b241521e22d
\ No newline at end of file
+0aafe76d2166c6fc0029a26852a3c4a405829939
\ No newline at end of file

specs/photo.yaml

@@ -71,6 +71,7 @@ components:
       enum:
         - APPROVED
         - UNAPPROVED
+        - INVALIDATED
       type: string
     TransientImageUrl:
       description: |-
@@ -133,6 +134,15 @@ components:
           description: The width of the image
           readOnly: true
           type: integer
+        invalidatedAt:
+          description: If non-NULL, the date & time that the photo was invalidated
+          format: date-time
+          nullable: true
+          type: string
+        invalidatedBy:
+          description: The identifier of the user who invalidated this photo.
+          nullable: true
+          type: string
         metadata:
           additionalProperties: {}
           description: A freeform block of JSON metadata related to this photo
@@ -1014,6 +1024,7 @@ paths:
           schema:
             enum:
               - APPROVED
+              - INVALIDATED
               - UNAPPROVED
             type: string
       responses:
@@ -1131,6 +1142,7 @@ paths:
           schema:
             enum:
               - APPROVED
+              - INVALIDATED
               - UNAPPROVED
             type: string
       requestBody:
@@ -1513,12 +1525,13 @@ paths:
           name: postponeReview
           schema:
             type: boolean
-        - description: The status to assign to this photo. This can only be `APPROVED` and only principals with the `PHOTO_REVIEWER` permission can set this status.
+        - description: The status to assign to this photo. This can be `APPROVED` or `INVALIDATED` and only principals with the `PHOTO_REVIEWER` permission  can set this status.
           in: query
           name: status
           schema:
             enum:
               - APPROVED
+              - INVALIDATED
             type: string
       responses:
         "200":