Update API docs

datarhei · Oct 24, 2024 · e2def57 · e2def57
1 parent b6daea1
commit e2def57
Show file tree

Hide file tree

Showing 6 changed files with 506 additions and 3 deletions.
diff --git a/cluster/docs/ClusterAPI_docs.go b/cluster/docs/ClusterAPI_docs.go
@@ -1307,6 +1307,14 @@ const docTemplateClusterAPI = `{
                     "description": "percent",
                     "type": "number"
                 },
+                "limitGPU": {
+                    "description": "GPU limits",
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/app.ConfigLimitGPU"
+                        }
+                    ]
+                },
                 "limitMemory": {
                     "description": "bytes",
                     "type": "integer"
@@ -1401,6 +1409,27 @@ const docTemplateClusterAPI = `{
                 }
             }
         },
+        "app.ConfigLimitGPU": {
+            "type": "object",
+            "properties": {
+                "decoder": {
+                    "description": "percent 0-100",
+                    "type": "number"
+                },
+                "encoder": {
+                    "description": "percent 0-100",
+                    "type": "number"
+                },
+                "memory": {
+                    "description": "bytes",
+                    "type": "integer"
+                },
+                "usage": {
+                    "description": "percent 0-100",
+                    "type": "number"
+                }
+            }
+        },
         "client.AddIdentityRequest": {
             "type": "object",
             "properties": {
@@ -1669,6 +1698,26 @@ const docTemplateClusterAPI = `{
                         }
                     }
                 },
+                "compress": {
+                    "type": "object",
+                    "properties": {
+                        "encoding": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "mimetypes": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "min_length": {
+                            "type": "integer"
+                        }
+                    }
+                },
                 "created_at": {
                     "description": "When this config has been persisted",
                     "type": "string"
@@ -1861,6 +1910,14 @@ const docTemplateClusterAPI = `{
                             "description": "percent 0-100",
                             "type": "number"
                         },
+                        "max_gpu_memory_usage": {
+                            "description": "percent 0-100",
+                            "type": "number"
+                        },
+                        "max_gpu_usage": {
+                            "description": "percent 0-100",
+                            "type": "number"
+                        },
                         "max_memory_usage": {
                             "description": "percent 0-100",
                             "type": "number"

diff --git a/cluster/docs/ClusterAPI_swagger.json b/cluster/docs/ClusterAPI_swagger.json
@@ -1300,6 +1300,14 @@
                     "description": "percent",
                     "type": "number"
                 },
+                "limitGPU": {
+                    "description": "GPU limits",
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/app.ConfigLimitGPU"
+                        }
+                    ]
+                },
                 "limitMemory": {
                     "description": "bytes",
                     "type": "integer"
@@ -1394,6 +1402,27 @@
                 }
             }
         },
+        "app.ConfigLimitGPU": {
+            "type": "object",
+            "properties": {
+                "decoder": {
+                    "description": "percent 0-100",
+                    "type": "number"
+                },
+                "encoder": {
+                    "description": "percent 0-100",
+                    "type": "number"
+                },
+                "memory": {
+                    "description": "bytes",
+                    "type": "integer"
+                },
+                "usage": {
+                    "description": "percent 0-100",
+                    "type": "number"
+                }
+            }
+        },
         "client.AddIdentityRequest": {
             "type": "object",
             "properties": {
@@ -1662,6 +1691,26 @@
                         }
                     }
                 },
+                "compress": {
+                    "type": "object",
+                    "properties": {
+                        "encoding": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "mimetypes": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "min_length": {
+                            "type": "integer"
+                        }
+                    }
+                },
                 "created_at": {
                     "description": "When this config has been persisted",
                     "type": "string"
@@ -1854,6 +1903,14 @@
                             "description": "percent 0-100",
                             "type": "number"
                         },
+                        "max_gpu_memory_usage": {
+                            "description": "percent 0-100",
+                            "type": "number"
+                        },
+                        "max_gpu_usage": {
+                            "description": "percent 0-100",
+                            "type": "number"
+                        },
                         "max_memory_usage": {
                             "description": "percent 0-100",
                             "type": "number"

diff --git a/cluster/docs/ClusterAPI_swagger.yaml b/cluster/docs/ClusterAPI_swagger.yaml
@@ -17,6 +17,10 @@ definitions:
       limitCPU:
         description: percent
         type: number
+      limitGPU:
+        allOf:
+        - $ref: '#/definitions/app.ConfigLimitGPU'
+        description: GPU limits
       limitMemory:
         description: bytes
         type: integer
@@ -81,6 +85,21 @@ definitions:
       purgeOnDelete:
         type: boolean
     type: object
+  app.ConfigLimitGPU:
+    properties:
+      decoder:
+        description: percent 0-100
+        type: number
+      encoder:
+        description: percent 0-100
+        type: number
+      memory:
+        description: bytes
+        type: integer
+      usage:
+        description: percent 0-100
+        type: number
+    type: object
   client.AddIdentityRequest:
     properties:
       identity:
@@ -256,6 +275,19 @@ definitions:
             format: int64
             type: integer
         type: object
+      compress:
+        properties:
+          encoding:
+            items:
+              type: string
+            type: array
+          mimetypes:
+            items:
+              type: string
+            type: array
+          min_length:
+            type: integer
+        type: object
       created_at:
         description: When this config has been persisted
         type: string
@@ -387,6 +419,12 @@ definitions:
           max_cpu_usage:
             description: percent 0-100
             type: number
+          max_gpu_memory_usage:
+            description: percent 0-100
+            type: number
+          max_gpu_usage:
+            description: percent 0-100
+            type: number
           max_memory_usage:
             description: percent 0-100
             type: number