add update directory openapi spec (#86)

Signed-off-by: Mike Mason <mimason@equinix.com>

internal/httpsrv/treemanager/treemanager.go

@@ -250,8 +250,8 @@ func updateDirectory(s *common.Server) gin.HandlerFunc {
 			return
 		}
 
-		if req.Name != "" {
-			d.Name = req.Name
+		if req.Name != nil && *req.Name != "" {
+			d.Name = *req.Name
 		}
 
 		if req.Metadata != nil {

internal/httpsrv/treemanager/treemanager_test.go

@@ -220,7 +220,7 @@ func TestDirectoryOperations(t *testing.T) {
 	assert.Equal(t, rd.Directory.Id, listrd.Directories[0], "directory is not the same")
 
 	d2, err := cli.UpdateDirectory(context.Background(), d.Directory.Id, &apiv1.UpdateDirectoryRequest{
-		Name: "test2",
+		Name: ptr("test2"),
 		Metadata: &apiv1.DirectoryMetadata{
 			"item1": "value1",
 		},
@@ -230,7 +230,7 @@ func TestDirectoryOperations(t *testing.T) {
 	assert.Contains(t, map[string]string(*d2.Directory.Metadata), "item1", "expected metadata to be updated")
 
 	d2, err = cli.UpdateDirectory(context.Background(), d.Directory.Id, &apiv1.UpdateDirectoryRequest{
-		Name: "",
+		Name: nil,
 		Metadata: &apiv1.DirectoryMetadata{
 			"item2": "value2",
 		},
@@ -240,11 +240,21 @@ func TestDirectoryOperations(t *testing.T) {
 	assert.Contains(t, map[string]string(*d2.Directory.Metadata), "item2", "expected metadata to be updated")
 
 	d2, err = cli.UpdateDirectory(context.Background(), d.Directory.Id, &apiv1.UpdateDirectoryRequest{
-		Name: "test3",
+		Name: ptr(""),
+		Metadata: &apiv1.DirectoryMetadata{
+			"item3": "value3",
+		},
+	})
+	assert.NoError(t, err, "expected no error updating directory")
+	assert.Equal(t, "test2", d2.Directory.Name, "expected name to be not change")
+	assert.Contains(t, map[string]string(*d2.Directory.Metadata), "item3", "expected metadata to be updated")
+
+	d2, err = cli.UpdateDirectory(context.Background(), d.Directory.Id, &apiv1.UpdateDirectoryRequest{
+		Name: ptr("test3"),
 	})
 	assert.NoError(t, err, "expected no error updating directory")
 	assert.Equal(t, "test3", d2.Directory.Name, "expected name to be updated")
-	assert.Contains(t, map[string]string(*d2.Directory.Metadata), "item2", "expected metadata to not be updated")
+	assert.Contains(t, map[string]string(*d2.Directory.Metadata), "item3", "expected metadata to not be updated")
 
 	// Delete directory
 	affected, err := cli.DeleteDirectory(context.Background(), d.Directory.Id)
@@ -327,6 +337,10 @@ func (m *mockDriver) UpdateDirectory(ctx context.Context, d *apiv1.Directory) er
 	return m.DirectoryAdmin.UpdateDirectory(ctx, d)
 }
 
+func ptr[T any](v T) *T {
+	return &v
+}
+
 func TestUpdateDirectoryError(t *testing.T) {
 	t.Parallel()
 
@@ -375,7 +389,7 @@ func TestUpdateDirectoryError(t *testing.T) {
 	assert.NotNil(t, d, "directory is nil")
 
 	_, err = cli.UpdateDirectory(context.Background(), d.Directory.Id, &apiv1.UpdateDirectoryRequest{
-		Name: "test2",
+		Name: ptr("test2"),
 		Metadata: &apiv1.DirectoryMetadata{
 			"item1": "value1",
 		},

treeman-openapi-v1.yaml

@@ -116,6 +116,37 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+    patch:
+      description: Updates the given directory for the provided ID
+      operationId: updateDirectory
+      parameters:
+        - name: id
+          in: path
+          description: ID of the directory to update
+          required: true
+          schema:
+            type: string
+            x-go-type: DirectoryID
+      requestBody:
+        description: Fields to update for the directory
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdateDirectoryRequest'
+      responses:
+        '201':
+          description: directory response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DirectoryFetch'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
 
     # TODO: Implement this
     # put:
@@ -287,6 +318,17 @@ components:
         - $ref: '#/components/schemas/DirectoryRequestMeta'
         - $ref: '#/components/schemas/NewDirectory'
 
+    UpdateDirectoryRequest:
+      allOf:
+        - $ref: '#/components/schemas/DirectoryRequestMeta'
+        - type: object
+          properties:
+            name:
+              type: string
+            metadata:
+              type: object
+              x-go-type: DirectoryMetadata
+
     # Response for fetching directories
     DirectoryFetch:
       allOf: