adding tags info to annotations dogs (#2121)

Co-authored-by: Andrew <[email protected]>

Author: andrewhallacy

openapi/src/annotations.openapi.yaml

@@ -63,6 +63,8 @@ paths:
                   $ref: '#/components/schemas/InputDate'
                 description:
                   $ref: '#/components/schemas/InputDescription'
+                tags:
+                  $ref: '#/components/schemas/TagIds'
       tags:
         - Create Annotations
       summary: Create Annotations
@@ -119,6 +121,8 @@ paths:
               properties:
                 description:
                   $ref: '#/components/schemas/InputDescription'
+                tags:
+                  $ref: '#/components/schemas/TagIds'
       responses:
         '200':
           description: Success
@@ -147,6 +151,51 @@ paths:
           $ref: ./common/responses.yaml#/401Unauthorized
         '403':
           $ref: ./common/responses.yaml#/403Forbidden
+  /projects/{projectId}/annotations/tags:
+    parameters:
+      - $ref: ./common/parameters.yaml#/path/projectId
+    get:
+      operationId: get-annotation-tags
+      tags:
+        - Get Annotation tags
+      description: Get all tags that have been added to at least one annotation. Requires a role of at least Analyst
+      summary: Get Annotation Tags
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetAnnotationTagsResponse'
+        '401':
+          $ref: ./common/responses.yaml#/401Unauthorized
+        '403':
+          $ref: ./common/responses.yaml#/403Forbidden
+    post:
+      operationId: create-annotation-tag
+      tags:
+        - Create Annotation tag
+      description: Creates a new tag using the provided name. Requires a role of at least Analyst
+      summary: Create Annotation Tag
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                name:
+                  $ref: '#/components/schemas/TagName'
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AnnotationTag'
+        '401':
+          $ref: ./common/responses.yaml#/401Unauthorized
+        '403':
+          $ref: ./common/responses.yaml#/403Forbidden
 components:
   securitySchemes:
     $ref: ./common/securitySchemes.yaml
@@ -181,7 +230,6 @@ components:
             id:
               type: number
               description: 'The id of the deleted annotation'
-
     ListAnnotationsResponse:
       title: ListAnnotationsResponse
       description: "A JSON response object containing all annotations in the project'"
@@ -211,6 +259,25 @@ components:
           type: number
         user:
           $ref: '#/components/schemas/UserInfo'
+        tags:
+          type: array
+          items:
+            $ref: '#/components/schemas/SimpleTag'
+    SimpleTag:
+      title: SimpleTag
+      description: Basic info about an Annotation Tag
+      type: object
+      properties:
+        id:
+          type: number
+        name:
+          type: string
+    TagIds:
+      title: TagIds
+      description: The ids of the tags to be added to the annotation
+      type: array
+      items:
+        type: number
     UserInfo:
       title: UserInfo
       description: Info about the creator of the annotation
@@ -224,6 +291,29 @@ components:
         last_name:
           example: Smith
           type: string
+    GetAnnotationTagsResponse:
+      title: GetAnnotationTagsResponse
+      description: The list of annotation tags that have been created
+      type: array
+      items:
+        $ref: '#/components/schemas/AnnotationTag'
+    AnnotationTag:
+      title: AnnotationTag
+      description: An annotation tag
+      type: object
+      properties:
+        id:
+          type: number
+        name:
+          type: string
+        project_id:
+          type: number
+        has_annotations:
+          type: boolean
+          description: whether the tag is currently attached to any annotations
+    TagName:
+      type: string
+      description: 'The text that will be shown when the tag is added to an annotation'
     InputDate:
       type: string
       description: 'A string representation of a date in "YYYY-MM-DD HH:mm:ss" format'