chore: ROOT-97: annotation reviews to SDK and docs (#566)

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: Jo Booth <[email protected]>

Author: 3 people

.mock/definition/annotationHistory.yml

@@ -4,7 +4,7 @@ service:
   auth: false
   base-path: ''
   endpoints:
-    api_annotation_history_list:
+    list:
       path: /api/annotation-history/
       method: GET
       auth: true
@@ -17,8 +17,11 @@ service:
         openapi: openapi/openapi.yaml
       display-name: List all annotation history items for annotation
       request:
-        name: ApiAnnotationHistoryListRequest
+        name: AnnotationHistoryListRequest
         query-parameters:
+          annotation:
+            type: optional<integer>
+            docs: Annotation ID to get annotation history items for.
           ordering:
             type: optional<string>
             docs: Which field to use when ordering the results.
@@ -44,7 +47,9 @@ service:
                 review_id: 1
                 started_at: '2024-01-15T09:30:00Z'
                 task_id: 1
-    api_annotation_history_destroy:
+      audiences:
+        - public
+    delete:
       path: /api/annotation-history/
       method: DELETE
       auth: true
@@ -55,14 +60,28 @@ service:
       source:
         openapi: openapi/openapi.yaml
       display-name: Delete annotation history items
+      request:
+        name: AnnotationHistoryDeleteRequest
+        query-parameters:
+          annotation:
+            type: optional<integer>
+            docs: Annotation ID to delete annotation history items for.
+          project:
+            type: optional<integer>
+            docs: Project ID to delete annotation history items for.
+          task:
+            type: optional<integer>
+            docs: Task ID to delete annotation history items for.
       response:
         docs: Returns a dict containing the count of removed items.
-        type: ApiAnnotationHistoryDestroyResponse
+        type: AnnotationHistoryDeleteResponse
       examples:
         - response:
             body:
               removed: 1
-    api_projects_annotation_history_list:
+      audiences:
+        - public
+    list_for_project:
       path: /api/projects/{id}/annotation-history/
       method: GET
       auth: true
@@ -73,7 +92,7 @@ service:
         id: integer
       display-name: List annotation history items for project
       request:
-        name: ApiProjectsAnnotationHistoryListRequest
+        name: AnnotationHistoryListForProjectRequest
         query-parameters:
           page:
             type: optional<integer>
@@ -109,10 +128,12 @@ service:
                   review_id: 1
                   started_at: '2024-01-15T09:30:00Z'
                   task_id: 1
+      audiences:
+        - public
   source:
     openapi: openapi/openapi.yaml
 types:
-  ApiAnnotationHistoryDestroyResponse:
+  AnnotationHistoryDeleteResponse:
     properties:
       removed:
         type: optional<integer>

.mock/definition/annotationReviews.yml

@@ -4,7 +4,7 @@ service:
   auth: false
   base-path: ''
   endpoints:
-    api_annotation_reviews_list:
+    list:
       path: /api/annotation-reviews/
       method: GET
       auth: true
@@ -13,7 +13,7 @@ service:
         openapi: openapi/openapi.yaml
       display-name: List reviews
       request:
-        name: ApiAnnotationReviewsListRequest
+        name: AnnotationReviewsListRequest
         query-parameters:
           annotation: optional<integer>
           annotation__task__project: optional<integer>
@@ -38,7 +38,9 @@ service:
                 result:
                   key: value
                 started_at: '2024-01-15T09:30:00Z'
-    api_annotation_reviews_create:
+      audiences:
+        - public
+    create:
       path: /api/annotation-reviews/
       method: POST
       auth: true
@@ -48,6 +50,11 @@ service:
       display-name: Create review
       request:
         body: root.AnnotationReviewRequest
+        query-parameters:
+          async_postprocess:
+            type: optional<boolean>
+            docs: Whether to postprocess the review asynchronously.
+        name: AnnotationReviewsCreateRequest
         content-type: application/json
       response:
         docs: ''
@@ -69,7 +76,9 @@ service:
               result:
                 key: value
               started_at: '2024-01-15T09:30:00Z'
-    api_annotation_reviews_retrieve:
+      audiences:
+        - public
+    get:
       path: /api/annotation-reviews/{id}/
       method: GET
       auth: true
@@ -101,6 +110,8 @@ service:
               result:
                 key: value
               started_at: '2024-01-15T09:30:00Z'
+      audiences:
+        - public
     api_annotation_reviews_update:
       path: /api/annotation-reviews/{id}/
       method: PUT
@@ -138,7 +149,9 @@ service:
               result:
                 key: value
               started_at: '2024-01-15T09:30:00Z'
-    api_annotation_reviews_destroy:
+      audiences:
+        - internal
+    delete:
       path: /api/annotation-reviews/{id}/
       method: DELETE
       auth: true
@@ -153,7 +166,9 @@ service:
       examples:
         - path-parameters:
             id: 1
-    api_annotation_reviews_partial_update:
+      audiences:
+        - public
+    update:
       path: /api/annotation-reviews/{id}/
       method: PATCH
       auth: true
@@ -205,5 +220,7 @@ service:
               result:
                 key: value
               started_at: '2024-01-15T09:30:00Z'
+      audiences:
+        - public
   source:
     openapi: openapi/openapi.yaml

.mock/definition/blueprints.yml

@@ -4,7 +4,7 @@ service:
   auth: false
   base-path: ''
   endpoints:
-    api_blueprints_create:
+    create:
       path: /api/blueprints/
       method: POST
       auth: true
@@ -23,6 +23,7 @@ service:
             label_config:
               type: optional<string>
               docs: Labeling configuration in XML format
+            project: integer
             title:
               type: optional<string>
               docs: Blueprint name. Must be between 3 and 50 characters long.
@@ -33,7 +34,8 @@ service:
         docs: ''
         type: root.Blueprint
       examples:
-        - request: {}
+        - request:
+            project: 1
           response:
             body:
               created_at: '2024-01-15T09:30:00Z'
@@ -46,7 +48,9 @@ service:
               short_url: short_url
               title: title
               updated_at: '2024-01-15T09:30:00Z'
-    api_blueprints_destroy:
+      audiences:
+        - public
+    delete:
       path: /api/blueprints/{id}/
       method: DELETE
       auth: true
@@ -59,11 +63,15 @@ service:
       examples:
         - path-parameters:
             id: id
+      audiences:
+        - public
     api_blueprints_create_project_retrieve:
       path: /api/blueprints/{share_id}/create-project
       method: GET
       auth: true
-      docs: Create a new project from an existing blueprint
+      docs: >-
+        Create a new project from an existing blueprint. On success, user is
+        redirected to the new project with a 302.
       source:
         openapi: openapi/openapi.yaml
       path-parameters:
@@ -76,5 +84,7 @@ service:
       examples:
         - path-parameters:
             share_id: share_id
+      audiences:
+        - internal
   source:
     openapi: openapi/openapi.yaml