CHANGELOG.md

@@ -5,6 +5,16 @@ 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.16] - 2022-11-11
+
+### Added
+- Added ability to set the college-institution-id for each card request via the Card API.
+- Added college-institution-ids list endpoint to the Card API.
+
+### Changed
+- Updated requirements to allow ./pull-spects.sh from from blank environment.
+
 ## [1.0.15] - 2022-10-24
 
 ### Added

README.md

@@ -56,6 +56,9 @@ $ ./pull-specs.sh
 # If an access token required for https clones from gitlab repositories
 # then this can be specified using:
 $ ./pull-specs.sh --token "ACCESS_TOKEN_HERE"
+
+# You may need to first set the $USER environment variable to match the GitLab account name.
+
 ```
 
 ### Generating the identitylib

requirements.txt

@@ -2,4 +2,4 @@ dataclasses
 frozendict
 python-dateutil
 urllib3
-requests
\ No newline at end of file
+requests

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

specs/card.sha

-aa15a8e2f93edca9a4fb57a891252224ab71a4e0
\ No newline at end of file
+21b94b26658e2ee7f45dee38bd3cb8998302dba7
\ No newline at end of file

specs/card.yaml

@@ -271,6 +271,48 @@ definitions:
         minLength: 1
         title: Cardholder status
         type: string
+      collegeInstitutionId:
+        description: The college institution id used to set the card request scarf
+        enum:
+          - NO_COLLEGE
+          - CHRISTS
+          - CHURCH
+          - CLAREH
+          - CLARE
+          - CORPUS
+          - DARWIN
+          - DOWN
+          - EMM
+          - FITZ
+          - GIRTON
+          - CAIUS
+          - HOM
+          - HUGHES
+          - JESUS
+          - KINGS
+          - LCC
+          - MAGD
+          - NEWH
+          - NEWN
+          - PEMB
+          - PET
+          - QUEENS
+          - RIDLEY
+          - ROBIN
+          - SEL
+          - SID
+          - CATH
+          - EDMUND
+          - JOHNS
+          - TRINH
+          - TRIN
+          - WESLEY
+          - WESTCOT
+          - WESTMIN
+          - WOLFC
+        title: College institution id
+        type: string
+        x-nullable: true
       createdAt:
         description: When this record was created
         format: date-time
@@ -401,6 +443,48 @@ definitions:
         minLength: 1
         title: Cardholder status
         type: string
+      collegeInstitutionId:
+        description: The college institution id used to set the card request scarf
+        enum:
+          - NO_COLLEGE
+          - CHRISTS
+          - CHURCH
+          - CLAREH
+          - CLARE
+          - CORPUS
+          - DARWIN
+          - DOWN
+          - EMM
+          - FITZ
+          - GIRTON
+          - CAIUS
+          - HOM
+          - HUGHES
+          - JESUS
+          - KINGS
+          - LCC
+          - MAGD
+          - NEWH
+          - NEWN
+          - PEMB
+          - PET
+          - QUEENS
+          - RIDLEY
+          - ROBIN
+          - SEL
+          - SID
+          - CATH
+          - EDMUND
+          - JOHNS
+          - TRINH
+          - TRIN
+          - WESLEY
+          - WESTCOT
+          - WESTMIN
+          - WOLFC
+        title: College institution id
+        type: string
+        x-nullable: true
       createdAt:
         description: When this record was created
         format: date-time
@@ -1612,13 +1696,16 @@ paths:
                       type: string
                     fields:
                       properties:
-                        cancelReason:
+                        cancel_reason:
+                          description: string
+                          type: string
+                        college_institution_id:
                           description: string
                           type: string
                         destination:
                           description: string
                           type: string
-                        holdReason:
+                        hold_reason:
                           description: string
                           type: string
                       type: object
@@ -1763,13 +1850,16 @@ paths:
                 type: string
               fields:
                 properties:
-                  cancelReason:
+                  cancel_reason:
+                    description: string
+                    type: string
+                  college_institution_id:
                     description: string
                     type: string
                   destination:
                     description: string
                     type: string
-                  holdReason:
+                  hold_reason:
                     description: string
                     type: string
                 type: object
@@ -2436,6 +2526,51 @@ paths:
         name: id
         required: true
         type: string
+  /v1beta1/college-institution-ids:
+    get:
+      description: |2+
+
+        ## List College Institution Ids
+
+        Returns a list of the college institution ids used to set the card request scarf-code.
+
+        ### Permissions
+
+        Only principals with the `CARD_DATA_READERS` permission are able to list college institution ids.
+
+      operationId: v1beta1_college-institution-ids_list
+      parameters: []
+      responses:
+        "200":
+          description: ""
+          schema:
+            properties:
+              results:
+                items:
+                  type: string
+                type: array
+            required:
+              - results
+            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.
+      security:
+        - API Service OAuth2 Client Credentials:
+            - https://api.apps.cam.ac.uk/card/card-requests
+            - https://api.apps.cam.ac.uk/card/card-requests.readonly
+        - API Service OAuth2 Access Code:
+            - https://api.apps.cam.ac.uk/card/card-requests
+            - https://api.apps.cam.ac.uk/card/card-requests.readonly
+      summary: List college institution ids
+      tags:
+        - v1beta1
+    parameters: []
 produces:
   - application/json
 schemes: