From 55b473c0568e595239b09be218ded9151b33cc48 Mon Sep 17 00:00:00 2001
From: Zoheb Shaikh <zoheb.shaikh@diamond.ac.uk>
Date: Thu, 27 Feb 2025 15:29:01 +0000
Subject: [PATCH] Update schema

---
 docs/reference/openapi.yaml | 39 +++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/docs/reference/openapi.yaml b/docs/reference/openapi.yaml
index 8ffcf2217..a38df9ef3 100644
--- a/docs/reference/openapi.yaml
+++ b/docs/reference/openapi.yaml
@@ -106,6 +106,34 @@ components:
       - plans
       title: PlanResponse
       type: object
+    ScratchResponse:
+      additionalProperties: false
+      description: State of the scratch area.
+      properties:
+        is_dirty:
+          description: Does the package have uncommitted changes
+          items:
+            type: boolean
+          title: Is Dirty
+          type: array
+        package_name:
+          description: Name of the package
+          items:
+            type: string
+          title: Package Name
+          type: array
+        version:
+          description: Version of the package
+          items:
+            type: string
+          title: Version
+          type: array
+      required:
+      - package_name
+      - version
+      - is_dirty
+      title: ScratchResponse
+      type: object
     StateChangeRequest:
       additionalProperties: false
       description: Request to change the state of the worker.
@@ -353,6 +381,17 @@ paths:
                 $ref: '#/components/schemas/HTTPValidationError'
           description: Validation Error
       summary: Get Plan By Name
+  /scratch:
+    get:
+      operationId: get_scratch_packages_scratch_get
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ScratchResponse'
+          description: Successful Response
+      summary: Get Scratch Packages
   /tasks:
     get:
       description: 'Retrieve tasks based on their status.