diff --git a/front/pages/api/v1/w/[wId]/swagger_schemas.ts b/front/pages/api/v1/w/[wId]/swagger_schemas.ts index 88fd59278f98..2d912f303537 100644 --- a/front/pages/api/v1/w/[wId]/swagger_schemas.ts +++ b/front/pages/api/v1/w/[wId]/swagger_schemas.ts @@ -2,11 +2,10 @@ * @swagger * components: * securitySchemes: - * ApiKeyAuth: - * type: apiKey - * in: header - * name: Authorization - * description: API key authentication. Prefix the key with 'Bearer ' + * BearerAuth: + * type: http + * scheme: bearer + * description: Your DUST API key prefixed by `Bearer sk-...` * schemas: * User: * type: object diff --git a/front/public/swagger.json b/front/public/swagger.json index 97679e50c2ea..162607262af0 100644 --- a/front/public/swagger.json +++ b/front/public/swagger.json @@ -15,7 +15,9 @@ "get": { "summary": "Get an app run", "description": "Retrieve a run for an app in the workspace identified by {wId}.", - "tags": ["Apps"], + "tags": [ + "Apps" + ], "parameters": [ { "in": "path", @@ -135,7 +137,9 @@ "post": { "summary": "Create an app run", "description": "Create a run for an app in the workspace identified by {wId}.", - "tags": ["Apps"], + "tags": [ + "Apps" + ], "parameters": [ { "in": "path", @@ -243,7 +247,9 @@ "get": { "summary": "List apps", "description": "Get all apps of a workspace.", - "tags": ["Apps"], + "tags": [ + "Apps" + ], "parameters": [ { "in": "path", @@ -290,7 +296,9 @@ "get": { "summary": "List assistants", "description": "Get the agent configurations for the workspace identified by {wId}.", - "tags": ["Workspace"], + "tags": [ + "Workspace" + ], "parameters": [ { "in": "path", @@ -432,7 +440,9 @@ "post": { "summary": "Create a content fragment", "description": "Create a new content fragment in the workspace identified by {wId}.", - "tags": ["Conversations"], + "tags": [ + "Conversations" + ], "parameters": [ { "in": "path", @@ -539,7 +549,9 @@ "get": { "summary": "Get the events for a conversation", "description": "Get the events for a conversation in the workspace identified by {wId}.", - "tags": ["Conversations"], + "tags": [ + "Conversations" + ], "parameters": [ { "in": "path", @@ -595,7 +607,9 @@ "get": { "summary": "Get a conversation", "description": "Get a conversation in the workspace identified by {wId}.", - "tags": ["Conversations"], + "tags": [ + "Conversations" + ], "security": [ { "ApiKeyAuth": [] @@ -654,7 +668,9 @@ "get": { "summary": "Get events for a message", "description": "Get events for a message in the workspace identified by {wId}.", - "tags": ["Conversations"], + "tags": [ + "Conversations" + ], "parameters": [ { "in": "path", @@ -741,7 +757,9 @@ "post": { "summary": "Create a message", "description": "Create a message in the workspace identified by {wId}.", - "tags": ["Conversations"], + "tags": [ + "Conversations" + ], "parameters": [ { "in": "path", @@ -835,7 +853,12 @@ "type": "string", "nullable": true, "description": "The origin of the message", - "enum": ["api", "web", "slack", "null"], + "enum": [ + "api", + "web", + "slack", + "null" + ], "default": "api", "example": "api" } @@ -866,7 +889,9 @@ "post": { "summary": "Create a new conversation", "description": "Create a new conversation in the workspace identified by {wId}.", - "tags": ["Conversations"], + "tags": [ + "Conversations" + ], "parameters": [ { "in": "path", @@ -959,7 +984,11 @@ "visibility": { "type": "string", "description": "The visibility of the conversation", - "enum": ["public", "private", "unlisted"], + "enum": [ + "public", + "private", + "unlisted" + ], "default": "public", "example": "private" } @@ -995,7 +1024,9 @@ "get": { "summary": "Retrieve a document from a data source", "description": "Retrieve a document from a data source in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -1058,7 +1089,9 @@ "post": { "summary": "Upsert a document in a data source", "description": "Upsert a document in a data source in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -1145,7 +1178,9 @@ "delete": { "summary": "Delete a document from a data source", "description": "Delete a document from a data source in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -1207,7 +1242,9 @@ "post": { "summary": "Update the parents of a document", "description": "Update the parents of a document in the data source identified by {name} in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -1290,7 +1327,9 @@ "get": { "summary": "Get documents", "description": "Get documents in the data source identified by {name} in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -1353,7 +1392,9 @@ "get": { "summary": "Search the data source", "description": "Search the data source identified by {name} in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -1545,7 +1586,9 @@ "get": { "summary": "Get a table", "description": "Get a table in the data source identified by {name} in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -1599,7 +1642,9 @@ "delete": { "summary": "Delete a table", "description": "Delete a table in the data source identified by {name} in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -1655,7 +1700,9 @@ "get": { "summary": "Get a row", "description": "Get a row in the table identified by {tId} in the data source identified by {name} in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -1718,7 +1765,9 @@ "delete": { "summary": "Delete a row", "description": "Delete a row in the table identified by {tId} in the data source identified by {name} in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -1783,7 +1832,9 @@ "get": { "summary": "List rows", "description": "List rows in the table identified by {tId} in the data source identified by {name} in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -1850,7 +1901,9 @@ "post": { "summary": "Upsert rows", "description": "Upsert rows in the table identified by {tId} in the data source identified by {name} in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -1922,7 +1975,9 @@ "properties": { "type": { "type": "string", - "enum": ["datetime"] + "enum": [ + "datetime" + ] }, "epoch": { "type": "number" @@ -1969,7 +2024,9 @@ "post": { "summary": "Upsert CSV to table", "description": "Upsert CSV data to a table in the data source identified by {name} in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -2040,7 +2097,9 @@ "get": { "summary": "Get tables", "description": "Get tables in the data source identified by {name} in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -2079,7 +2138,9 @@ "post": { "summary": "Upsert a table", "description": "Upsert a table in the data source identified by {name} in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -2147,7 +2208,9 @@ "post": { "summary": "Tokenize text", "description": "Tokenize text for the data source identified by {name} in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -2209,7 +2272,9 @@ "get": { "summary": "Get data sources", "description": "Get data sources in the workspace identified by {wId}.", - "tags": ["Datasources"], + "tags": [ + "Datasources" + ], "parameters": [ { "in": "path", @@ -2247,7 +2312,9 @@ "get": { "summary": "List feature flags", "description": "Get the feature flags for the workspace identified by {wId}.", - "tags": ["Workspace"], + "tags": [ + "Workspace" + ], "parameters": [ { "in": "path", @@ -2294,7 +2361,9 @@ "get": { "summary": "List member emails", "description": "List the emails of all members in the workspace identified by {wId}.", - "tags": ["Workspace"], + "tags": [ + "Workspace" + ], "parameters": [ { "in": "path", @@ -2350,7 +2419,9 @@ "get": { "summary": "Get workspace usage data", "description": "Get usage data for the workspace identified by {wId}.", - "tags": ["Workspace"], + "tags": [ + "Workspace" + ], "parameters": [ { "in": "path", @@ -2408,7 +2479,9 @@ "get": { "summary": "Get verified domains", "description": "Get the verified domain for the workspace identified by {wId}.", - "tags": ["Workspace"], + "tags": [ + "Workspace" + ], "parameters": [ { "in": "path", @@ -2445,11 +2518,10 @@ }, "components": { "securitySchemes": { - "ApiKeyAuth": { - "type": "apiKey", - "in": "header", - "name": "Authorization", - "description": "API key authentication. Prefix the key with 'Bearer '" + "BearerAuth": { + "type": "http", + "scheme": "bearer", + "description": "Your DUST API key prefixed by `Bearer sk-...`" } }, "schemas": { @@ -2834,4 +2906,4 @@ } }, "tags": [] -} +} \ No newline at end of file