provisioning_api: Add OpenAPI spec

Signed-off-by: jld3103 <jld3103yt@gmail.com>

1 files changed, 88 insertions, 208 deletions

diff --git a/apps/provisioning_api/openapi.json b/apps/provisioning_api/openapi.json
index 82ee9b16e31..6eb16aa6ad1 100644
--- a/apps/provisioning_api/openapi.json
+++ b/apps/provisioning_api/openapi.json
@@ -325,45 +325,30 @@
                 "type": "object",
                 "required": [
                     "additional_mail",
-                    "additional_mailScope",
                     "address",
-                    "addressScope",
-                    "avatarScope",
                     "backend",
                     "backendCapabilities",
                     "biography",
-                    "biographyScope",
-                    "displayname",
                     "display-name",
-                    "displaynameScope",
+                    "displayname",
                     "email",
-                    "emailScope",
-                    "enabled",
                     "fediverse",
-                    "fediverseScope",
                     "groups",
                     "headline",
-                    "headlineScope",
                     "id",
                     "language",
                     "lastLogin",
                     "locale",
+                    "manager",
                     "notify_email",
                     "organisation",
-                    "organisationScope",
                     "phone",
-                    "phoneScope",
                     "profile_enabled",
-                    "profile_enabledScope",
                     "quota",
                     "role",
-                    "roleScope",
-                    "storageLocation",
                     "subadmin",
                     "twitter",
-                    "twitterScope",
-                    "website",
-                    "websiteScope"
+                    "website"
                 ],
                 "properties": {
                     "additional_mail": {
@@ -374,7 +359,6 @@
                     },
                     "additional_mailScope": {
                         "type": "array",
-                        "nullable": true,
                         "items": {
                             "type": "string"
                         }
@@ -383,12 +367,10 @@
                         "type": "string"
                     },
                     "addressScope": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
                     },
                     "avatarScope": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
                     },
                     "backend": {
                         "type": "string"
@@ -412,38 +394,32 @@
                         "type": "string"
                     },
                     "biographyScope": {
-                        "type": "string",
-                        "nullable": true
-                    },
-                    "displayname": {
                         "type": "string"
                     },
                     "display-name": {
                         "type": "string"
                     },
+                    "displayname": {
+                        "type": "string"
+                    },
                     "displaynameScope": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
                     },
                     "email": {
                         "type": "string",
                         "nullable": true
                     },
                     "emailScope": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
                     },
                     "enabled": {
-                        "type": "boolean",
-                        "nullable": true
+                        "type": "boolean"
                     },
                     "fediverse": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
                     },
                     "fediverseScope": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
                     },
                     "groups": {
                         "type": "array",
@@ -455,8 +431,7 @@
                         "type": "string"
                     },
                     "headlineScope": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
                     },
                     "id": {
                         "type": "string"
@@ -471,6 +446,9 @@
                     "locale": {
                         "type": "string"
                     },
+                    "manager": {
+                        "type": "string"
+                    },
                     "notify_email": {
                         "type": "string",
                         "nullable": true
@@ -479,78 +457,31 @@
                         "type": "string"
                     },
                     "organisationScope": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
                     },
                     "phone": {
                         "type": "string"
                     },
                     "phoneScope": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
                     },
                     "profile_enabled": {
                         "type": "string"
                     },
                     "profile_enabledScope": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
                     },
                     "quota": {
-                        "type": "object",
-                        "required": [
-                            "free",
-                            "quota",
-                            "relative",
-                            "total",
-                            "used"
-                        ],
-                        "properties": {
-                            "free": {
-                                "type": "integer",
-                                "format": "int64",
-                                "nullable": true
-                            },
-                            "quota": {
-                                "oneOf": [
-                                    {
-                                        "type": "string"
-                                    },
-                                    {
-                                        "type": "integer",
-                                        "format": "int64"
-                                    },
-                                    {
-                                        "type": "boolean"
-                                    }
-                                ]
-                            },
-                            "relative": {
-                                "type": "number",
-                                "format": "float",
-                                "nullable": true
-                            },
-                            "total": {
-                                "type": "integer",
-                                "format": "int64",
-                                "nullable": true
-                            },
-                            "used": {
-                                "type": "integer",
-                                "format": "int64"
-                            }
-                        }
+                        "$ref": "#/components/schemas/UserDetailsQuota"
                     },
                     "role": {
                         "type": "string"
                     },
                     "roleScope": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
                     },
                     "storageLocation": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
                     },
                     "subadmin": {
                         "type": "array",
@@ -562,15 +493,45 @@
                         "type": "string"
                     },
                     "twitterScope": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
                     },
                     "website": {
                         "type": "string"
                     },
                     "websiteScope": {
-                        "type": "string",
-                        "nullable": true
+                        "type": "string"
+                    }
+                }
+            },
+            "UserDetailsQuota": {
+                "type": "object",
+                "properties": {
+                    "free": {
+                        "type": "number",
+                        "format": "float"
+                    },
+                    "quota": {
+                        "oneOf": [
+                            {
+                                "type": "number",
+                                "format": "float"
+                            },
+                            {
+                                "type": "string"
+                            }
+                        ]
+                    },
+                    "relative": {
+                        "type": "number",
+                        "format": "float"
+                    },
+                    "total": {
+                        "type": "number",
+                        "format": "float"
+                    },
+                    "used": {
+                        "type": "number",
+                        "format": "float"
                     }
                 }
             }
@@ -783,10 +744,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -852,10 +810,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -1030,10 +985,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -1600,10 +1552,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -1670,10 +1619,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -2152,10 +2098,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -2307,10 +2250,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -2375,10 +2315,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -2668,10 +2605,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -2738,10 +2672,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -2808,10 +2739,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -2878,10 +2806,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -3035,10 +2960,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -3112,10 +3034,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -3263,10 +3182,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -3341,10 +3257,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -3411,10 +3324,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -3576,7 +3486,7 @@
                         }
                     },
                     "403": {
-                        "description": "App not allowed",
+                        "description": "App is not allowed",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -3718,7 +3628,7 @@
                         }
                     },
                     "403": {
-                        "description": "App not allowed",
+                        "description": "App is not allowed",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -3838,10 +3748,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -3850,7 +3757,7 @@
                         }
                     },
                     "403": {
-                        "description": "App or key not allowed",
+                        "description": "App or key is not allowed",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -3962,10 +3869,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -3974,7 +3878,7 @@
                         }
                     },
                     "403": {
-                        "description": "App or key not allowed",
+                        "description": "App or key is not allowed",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -4096,10 +4000,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -4127,10 +4028,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -4204,10 +4102,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -4235,10 +4130,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -4314,10 +4206,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -4345,10 +4234,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -4422,10 +4308,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }
@@ -4453,10 +4336,7 @@
                                                 "meta": {
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
-                                                "data": {
-                                                    "type": "object",
-                                                    "additionalProperties": true
-                                                }
+                                                "data": {}
                                             }
                                         }
                                     }