openapi: audit endpoints

openapi.yaml

@@ -269,6 +269,56 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Error"
+  /mapfixes/{MapfixID}/audit-events:
+    get:
+      summary: Retrieve a list of audit events
+      operationId: listMapfixAuditEvents
+      tags:
+        - Mapfixes
+      security: []
+      parameters:
+        - $ref: '#/components/parameters/MapfixID'
+        - $ref: "#/components/parameters/Page"
+        - $ref: "#/components/parameters/Limit"
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/AuditEvent"
+        default:
+          description: General Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /mapfixes/{MapfixID}/comment:
+    post:
+      summary: Post a comment to the audit log
+      operationId: createMapfixAuditComment
+      tags:
+        - Mapfixes
+      parameters:
+        - $ref: '#/components/parameters/MapfixID'
+      requestBody:
+        required: true
+        content:
+          text/plain:
+            schema:
+              type: string
+              maxLength: 1024
+      responses:
+        "204":
+          description: Successful response
+        default:
+          description: General Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
   /mapfixes/{MapfixID}/model:
     post:
       summary: Update model following role restrictions
@@ -609,6 +659,56 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Error"
+  /submissions/{SubmissionID}/audit-events:
+    get:
+      summary: Retrieve a list of audit events
+      operationId: listSubmissionAuditEvents
+      tags:
+        - Submissions
+      security: []
+      parameters:
+        - $ref: '#/components/parameters/SubmissionID'
+        - $ref: "#/components/parameters/Page"
+        - $ref: "#/components/parameters/Limit"
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/AuditEvent"
+        default:
+          description: General Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /submissions/{SubmissionID}/comment:
+    post:
+      summary: Post a comment to the audit log
+      operationId: createSubmissionAuditComment
+      tags:
+        - Submissions
+      parameters:
+        - $ref: '#/components/parameters/SubmissionID'
+      requestBody:
+        required: true
+        content:
+          text/plain:
+            schema:
+              type: string
+              maxLength: 1024
+      responses:
+        "204":
+          description: Successful response
+        default:
+          description: General Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
   /submissions/{SubmissionID}/model:
     post:
       summary: Update model following role restrictions
@@ -1178,6 +1278,40 @@ components:
         minimum: 1
         maximum: 100
   schemas:
+    AuditEvent:
+      type: object
+      required:
+      - ID
+      - Date
+      - User
+      - ResourceType
+      - ResourceID
+      - EventType
+      - EventData
+      properties:
+        ID:
+          type: integer
+          format: int64
+        Date:
+          type: integer
+          format: int64
+        User:
+          type: integer
+          format: int64
+        ResourceType:
+          type: integer
+          format: int32
+          description: Is this a submission or is it a mapfix
+        ResourceID:
+          type: integer
+          format: int64
+        EventType:
+          type: integer
+          format: int32
+        EventData:
+          type: object
+          description: Arbitrary event data
+          additionalProperties: true
     OperationID:
       required:
       - OperationID