CHANGELOG.md

@@ -5,6 +5,12 @@ 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.1] - 2023-10-02
+
+### Changes
+
+- Updates API specifications to latest versions.
+
 ## [3.1.0] - 2023-09-21
 
 ### Changes

pyproject.toml

 [tool.poetry]
 name = "ucam-identitylib"
-version = "3.1.0"
+version = "3.1.1"
 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"

specs/card.sha

-68243e8019e65b309b7e3d255121aecf3995e9fd
\ No newline at end of file
+54a6779ed312e6dbb92b35ce5fb07e42ba625dec
\ No newline at end of file

specs/card.yaml

@@ -1454,6 +1454,39 @@ components:
       required:
         - detail
       type: object
+    IssuedAtType:
+      properties:
+        count:
+          type: integer
+        date:
+          format: date
+          type: string
+        requestorDomain:
+          type: string
+      required:
+        - count
+        - date
+        - requestorDomain
+      type: object
+    MetricsListResponseType:
+      properties:
+        issuedAt:
+          items:
+            $ref: '#/components/schemas/IssuedAtType'
+          type: array
+        revokedAt:
+          items:
+            $ref: '#/components/schemas/RevokedAtType'
+          type: array
+        revokedAtNotes:
+          items:
+            $ref: '#/components/schemas/RevokedAtNotesType'
+          type: array
+      required:
+        - issuedAt
+        - revokedAt
+        - revokedAtNotes
+      type: object
     NotFound:
       properties:
         detail:
@@ -1573,6 +1606,34 @@ components:
         - configuration
         - id
       type: object
+    RevokedAtNotesType:
+      properties:
+        changeOfRole:
+          type: integer
+        date:
+          format: date
+          type: string
+        lostByCardholder:
+          type: integer
+        stolen:
+          type: integer
+      required:
+        - changeOfRole
+        - date
+        - lostByCardholder
+        - stolen
+      type: object
+    RevokedAtType:
+      properties:
+        count:
+          type: integer
+        date:
+          format: date
+          type: string
+      required:
+        - count
+        - date
+      type: object
     Unauthorized:
       properties:
         detail:
@@ -1767,6 +1828,79 @@ paths:
       summary: List permissions
       tags:
         - Permissions
+  /v1beta1/analytics:
+    get:
+      description: Detailed metrics about issued cards, revoked cards, etc.
+      operationId: v1beta1_metrics_list
+      parameters:
+        - in: query
+          name: group_by
+          schema:
+            enum:
+              - day
+              - month
+              - week
+              - year
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MetricsListResponseType'
+          description: Success
+        "400":
+          content:
+            application/json:
+              examples:
+                InvalidRequest:
+                  description: A response indicating that the request could not be processed because it is invalid or malformed
+                  summary: Invalid Request
+                  value:
+                    detail: Malformed request.
+              schema:
+                $ref: '#/components/schemas/BadRequest'
+          description: Bad Request
+        "401":
+          content:
+            application/json:
+              examples:
+                Unauthorized:
+                  description: A response indicating that the request could not be processed because the requester is not authorized to make the request.
+                  value:
+                    detail: Unauthorized request.
+              schema:
+                $ref: '#/components/schemas/Unauthorized'
+          description: Unauthorized
+        "403":
+          content:
+            application/json:
+              examples:
+                Forbidden:
+                  description: A response indicating that the request could not be processed because the requester does not have the permissions required to make the request.
+                  value:
+                    detail: Forbidden
+              schema:
+                $ref: '#/components/schemas/Forbidden'
+          description: Forbidden
+        "500":
+          content:
+            application/json:
+              examples:
+                ServerError:
+                  description: A response indicating that the request could not be processed because of an internal server error.
+                  summary: Server Error
+                  value:
+                    detail: Server error.
+              schema:
+                $ref: '#/components/schemas/InternalServerError'
+          description: Internal Server Error
+      security:
+        - apiGatewayAuthorizationCodeSecurityScheme: []
+        - apiGatewayClientCredentialsSecurityScheme: []
+      summary: List metrics
+      tags:
+        - v1beta1
   /v1beta1/available-barcodes:
     get:
       description: |2+