.gitlab-ci.yml

@@ -35,7 +35,7 @@ pypi-release:
     DIST_LOCATION: "/dist"
 
 latest-spec:
-  image: python:3.10
+  image: python:3.9
   stage: test
   before_script:
     - pip install poetry

CHANGELOG.md

@@ -5,6 +5,13 @@ 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).
 
+## [3.1.2] - 2024-01-04
+
+### Changes
+
+- Downgrade Python version to ^3.9.
+- Updates API specifications to latest versions.
+
 ## [3.1.1] - 2023-10-02
 
 ### Changes

Dockerfile

@@ -3,7 +3,7 @@
 
 ###############################################################################
 # Base image, which is used for the main building image and the scripts
-FROM python:3.10 as base
+FROM python:3.9 as base
 
 # Some performance and disk-usage optimisations for Python within a docker container.
 ENV PYTHONUNBUFFERED=1 PYTHONDONTWRITEBYTECODE=1

pyproject.toml

 [tool.poetry]
 name = "ucam-identitylib"
-version = "3.1.1"
+version = "3.1.2"
 authors = ["University of Cambridge Information Services <devops+ucam-identitylib@uis.cam.ac.uk>"]
 description = "A module containing helpers and shared code related to identity systems within UIS, University of Cambridge."
 readme = "README.md"
@@ -41,7 +41,7 @@ cmd = """ bash -c "\
 args = [{name="source", required=true}]
 
 [tool.poetry.dependencies]
-python = "^3.10"
+python = "^3.9"
 aenum = "^3.1.15"
 frozendict = "^2.3.8"
 pydantic = "^1.1.0"

specs/card.sha

-54a6779ed312e6dbb92b35ce5fb07e42ba625dec
\ No newline at end of file
+b32ace413540cd95376242dee23ee5e1271afd55
\ No newline at end of file

specs/hr.sha

-dde714b370dcb7f95bbabccf6e70b9796a8e469d
\ No newline at end of file
+faa1daa87da94bee035ad865e828ed8395de5123
\ No newline at end of file

specs/hr.yaml

@@ -236,7 +236,7 @@ info:
 
   title: University Human Resources API
   version: v1alpha2
-openapi: 3.1.0
+openapi: 3.0.3
 paths:
   /staff:
     get:

specs/photo.sha

-9a1dd003b36ca1b1f30ae780b10ea52f628eb010
\ No newline at end of file
+a75ffc201b8d21a109cb8f333aa0db905d45a17c
\ No newline at end of file

specs/photo.yaml

@@ -52,6 +52,9 @@ components:
       type: object
     PaginatedV1Beta1PhotoIdentifierSummaryList:
       properties:
+        count:
+          example: 123
+          type: integer
         next:
           nullable: true
           type: string
@@ -65,6 +68,9 @@ components:
       type: object
     PaginatedV1Beta1PhotoList:
       properties:
+        count:
+          example: 123
+          type: integer
         next:
           nullable: true
           type: string

specs/student.sha

-feaf5a2d52b8bfbdb2ee8a435e4084e62f7c5441
\ No newline at end of file
+42a8ba4b416d4ec6893a24f260a8a47dea358d7b
\ No newline at end of file

specs/student.yaml

@@ -92,15 +92,13 @@ components:
       properties:
         next:
           description: The url to use to retrieve the next page of results.
-          examples:
-            - https://api.apps.cam.ac.uk/university-student/v1alpha2/students?cursor=V2VsbCBhcmV1IGN1cmlvdXM=
+          example: https://api.apps.cam.ac.uk/university-student/v1alpha2/students?cursor=V2VsbCBhcmV1IGN1cmlvdXM=
           nullable: true
           title: Next
           type: string
         previous:
           description: The url to use to retrieve the previous page of results.
-          examples:
-            - https://api.apps.cam.ac.uk/university-student/v1alpha2/students?cursor=5SFSDGcmlvdDFGXM=
+          example: https://api.apps.cam.ac.uk/university-student/v1alpha2/students?cursor=5SFSDGcmlvdDFGXM=
           nullable: true
           title: Previous
           type: string
@@ -239,7 +237,7 @@ info:
 
   title: University Student API
   version: v1alpha2
-openapi: 3.1.0
+openapi: 3.0.3
 paths:
   /recent-graduates:
     get:
@@ -269,24 +267,22 @@ paths:
       operationId: list_v1alpha2_recent_graduates_recent_graduates_get
       parameters:
         - description: An affiliation to filter by, in the format `<value>@<scheme>`. When included only graduates with a matching affiliation are returned.
+          example: CHR@institution.v1.student-records.university.identifiers.cam.ac.uk
           in: query
           name: affiliation
           required: false
           schema:
             description: An affiliation to filter by, in the format `<value>@<scheme>`. When included only graduates with a matching affiliation are returned.
-            examples:
-              - CHR@institution.v1.student-records.university.identifiers.cam.ac.uk
             nullable: true
             title: Affiliation
             type: string
         - description: The cursor indicating a unique page of results - this should be auto generated on the `next` and `previous` fields and does not need to be manually added / updated.
+          example: V2VsbCBhcmVuJ3QgeW91IGN1cmlvdXM=
           in: query
           name: cursor
           required: false
           schema:
             description: The cursor indicating a unique page of results - this should be auto generated on the `next` and `previous` fields and does not need to be manually added / updated.
-            examples:
-              - V2VsbCBhcmVuJ3QgeW91IGN1cmlvdXM=
             title: Cursor
             type: string
       responses:
@@ -328,24 +324,22 @@ paths:
       operationId: list_v1alpha2_students_students_get
       parameters:
         - description: An affiliation to filter by, in the format `<value>@<scheme>`. When included only the students with a matching affiliation are returned.
+          example: CHR@institution.v1.student-records.university.identifiers.cam.ac.uk
           in: query
           name: affiliation
           required: false
           schema:
             description: An affiliation to filter by, in the format `<value>@<scheme>`. When included only the students with a matching affiliation are returned.
-            examples:
-              - CHR@institution.v1.student-records.university.identifiers.cam.ac.uk
             nullable: true
             title: Affiliation
             type: string
         - description: The cursor indicating a unique page of results - this should be auto generated on the `next` and `previous` fields and does not need to be manually added / updated.
+          example: V2VsbCBhcmVuJ3QgeW91IGN1cmlvdXM=
           in: query
           name: cursor
           required: false
           schema:
             description: The cursor indicating a unique page of results - this should be auto generated on the `next` and `previous` fields and does not need to be manually added / updated.
-            examples:
-              - V2VsbCBhcmVuJ3QgeW91IGN1cmlvdXM=
             title: Cursor
             type: string
       responses:
@@ -375,12 +369,11 @@ paths:
       description: "Returns a single student based on the identifier provided. The identifier can be provided in the format `<value>@<scheme>`, if the scheme is omitted it shall be assumed that the scheme is `person.v1.student-records.university.identifiers.cam.ac.uk` (also know as the USN). \n\nCurrently this endpoint only supports querying by `person.v1.student-records.university.identifiers.cam.ac.uk` identifiers, but may be extended to allow querying by additional identifier schemes in future."
       operationId: get_v1alpha2_student_students__identifier__get
       parameters:
-        - in: path
+        - example: 1000@person.v1.student-records.university.identifiers.cam.ac.uk
+          in: path
           name: identifier
           required: true
           schema:
-            examples:
-              - 1000@person.v1.student-records.university.identifiers.cam.ac.uk
             title: The identifier to query by
             type: string
       responses: