From 1db222a5b970b1096b87d371a319a892d4eb949e Mon Sep 17 00:00:00 2001
From: Thomas Heartman <thomas@getunleash.io>
Date: Fri, 9 Aug 2024 11:18:37 +0200
Subject: [PATCH] feat: add collaborators to feature schema (#7821)

Update the feature schema to include collaborator information
---
 src/lib/openapi/spec/feature-schema.ts | 36 ++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/src/lib/openapi/spec/feature-schema.ts b/src/lib/openapi/spec/feature-schema.ts
index ec1c70a95932..7c7be1fe1cb5 100644
--- a/src/lib/openapi/spec/feature-schema.ts
+++ b/src/lib/openapi/spec/feature-schema.ts
@@ -212,6 +212,42 @@ export const featureSchema = {
             description:
                 'The list of parent dependencies. This is an experimental field and may change.',
         },
+        collaborators: {
+            type: 'object',
+            required: ['users'],
+            description:
+                'Information related to users who have made changes to this feature flage.',
+            properties: {
+                users: {
+                    description:
+                        'Users who have made any changes to this feature flags. The list is sorted in reverse chronological order (most recent changes first)',
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        required: ['id', 'name', 'imageUrl'],
+                        description: 'A simple representation of a user.',
+                        properties: {
+                            id: {
+                                description: "The user's id",
+                                type: 'integer',
+                                example: 123,
+                            },
+                            name: {
+                                description:
+                                    "The user's name, username, or email (prioritized in that order). If none of those are present, this property will be set to the string `unknown`",
+                                type: 'string',
+                                example: 'User',
+                            },
+                            imageUrl: {
+                                description: `The URL to the user's profile image`,
+                                type: 'string',
+                                example: 'https://example.com/242x200.png',
+                            },
+                        },
+                    },
+                },
+            },
+        },
     },
     components: {
         schemas: {