Update schema for stomp endpoint

Author: tpoliaw

docs/reference/openapi.yaml

@@ -1,5 +1,22 @@
 components:
   schemas:
+    BasicAuthentication:
+      additionalProperties: false
+      description: User credentials for basic authentication
+      properties:
+        password:
+          description: Password to verify user's identity
+          title: Password
+          type: string
+        username:
+          description: Unique identifier for user
+          title: Username
+          type: string
+      required:
+      - username
+      - password
+      title: BasicAuthentication
+      type: object
     DeviceModel:
       additionalProperties: false
       description: Representation of a device
@@ -224,6 +241,28 @@ components:
       - new_state
       title: StateChangeRequest
       type: object
+    StompConfig:
+      additionalProperties: false
+      description: Config for connecting to stomp broker
+      properties:
+        auth:
+          $ref: '#/components/schemas/BasicAuthentication'
+          description: Auth information for communicating with STOMP broker, if required
+          title: Auth
+        enabled:
+          default: false
+          description: True if blueapi should connect to stomp for asynchronous event
+            publishing
+          title: Enabled
+          type: boolean
+        url:
+          default: tcp://localhost:61613
+          format: uri
+          minLength: 1
+          title: Url
+          type: string
+      title: StompConfig
+      type: object
     Task:
       additionalProperties: false
       description: Task that will run a plan
@@ -401,6 +440,22 @@ paths:
       summary: Get Oidc Config
       tags:
       - Meta
+  /config/stomp:
+    get:
+      description: Retrieve the stomp configuration for the server.
+      operationId: get_stomp_config_config_stomp_get
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/StompConfig'
+          description: Successful Response
+        '204':
+          description: No Stomp configured
+      summary: Get Stomp Config
+      tags:
+      - Meta
   /devices:
     get:
       description: Retrieve information about all available devices.

helm/blueapi/config_schema.json

@@ -453,16 +453,10 @@
                     "type": "string"
                 },
                 "auth": {
-                    "anyOf": [
-                        {
-                            "$ref": "BasicAuthentication"
-                        },
-                        {
-                            "type": "null"
-                        }
-                    ],
+                    "$ref": "BasicAuthentication",
                     "default": null,
-                    "description": "Auth information for communicating with STOMP broker, if required"
+                    "description": "Auth information for communicating with STOMP broker, if required",
+                    "title": "Auth"
                 }
             },
             "title": "StompConfig",

helm/blueapi/values.schema.json

@@ -862,15 +862,9 @@
             "type": "object",
             "properties": {
                 "auth": {
+                    "title": "Auth",
                     "description": "Auth information for communicating with STOMP broker, if required",
-                    "anyOf": [
-                        {
-                            "$ref": "BasicAuthentication"
-                        },
-                        {
-                            "type": "null"
-                        }
-                    ]
+                    "$ref": "BasicAuthentication"
                 },
                 "enabled": {
                     "title": "Enabled",

src/blueapi/config.py

@@ -21,6 +21,7 @@
     ValidationError,
     field_validator,
 )
+from pydantic.json_schema import SkipJsonSchema
 
 from blueapi.utils import BlueapiBaseModel, InvalidConfigError
 
@@ -100,7 +101,7 @@ class StompConfig(BlueapiBaseModel):
         default=False,
     )
     url: TcpUrl = TcpUrl("tcp://localhost:61613")
-    auth: BasicAuthentication | None = Field(
+    auth: BasicAuthentication | SkipJsonSchema[None] = Field(
         description="Auth information for communicating with STOMP broker, if required",
         default=None,
     )