docs: Remove unnecessary types from OpenAPI documentation

anarsultanov · Feb 26, 2024 · 7eed2c7 · 7eed2c7
1 parent 3564372
commit 7eed2c7
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 578 deletions.
diff --git a/docs/openapi.json b/docs/openapi.json
@@ -426,111 +426,6 @@
   },
   "components" : {
     "schemas" : {
-      "CredentialRepresentation" : {
-        "type" : "object",
-        "properties" : {
-          "id" : {
-            "type" : "string"
-          },
-          "type" : {
-            "type" : "string"
-          },
-          "userLabel" : {
-            "type" : "string"
-          },
-          "createdDate" : {
-            "format" : "int64",
-            "type" : "integer"
-          },
-          "secretData" : {
-            "type" : "string"
-          },
-          "credentialData" : {
-            "type" : "string"
-          },
-          "priority" : {
-            "format" : "int32",
-            "type" : "integer"
-          },
-          "value" : {
-            "type" : "string"
-          },
-          "temporary" : {
-            "type" : "boolean"
-          },
-          "device" : {
-            "type" : "string",
-            "deprecated" : true
-          },
-          "hashedSaltedValue" : {
-            "type" : "string",
-            "deprecated" : true
-          },
-          "salt" : {
-            "type" : "string",
-            "deprecated" : true
-          },
-          "hashIterations" : {
-            "format" : "int32",
-            "type" : "integer",
-            "deprecated" : true
-          },
-          "counter" : {
-            "format" : "int32",
-            "type" : "integer",
-            "deprecated" : true
-          },
-          "algorithm" : {
-            "type" : "string",
-            "deprecated" : true
-          },
-          "digits" : {
-            "format" : "int32",
-            "type" : "integer",
-            "deprecated" : true
-          },
-          "period" : {
-            "format" : "int32",
-            "type" : "integer",
-            "deprecated" : true
-          },
-          "config" : {
-            "type" : "object",
-            "additionalProperties" : {
-              "type" : "string"
-            },
-            "deprecated" : true
-          }
-        }
-      },
-      "FederatedIdentityRepresentation" : {
-        "type" : "object",
-        "properties" : {
-          "identityProvider" : {
-            "type" : "string"
-          },
-          "userId" : {
-            "type" : "string"
-          },
-          "userName" : {
-            "type" : "string"
-          }
-        }
-      },
-      "SocialLinkRepresentation" : {
-        "type" : "object",
-        "properties" : {
-          "socialProvider" : {
-            "type" : "string"
-          },
-          "socialUserId" : {
-            "type" : "string"
-          },
-          "socialUsername" : {
-            "type" : "string"
-          }
-        }
-      },
       "TenantInvitationRepresentation" : {
         "required" : [ "email", "roles" ],
         "type" : "object",
@@ -571,11 +466,36 @@
             "readOnly" : true
           },
           "user" : {
-            "description" : "Returns basic user info only including id, username, creation date, names, email, enabled state, email verification and federation link.",
             "type" : "object",
-            "allOf" : [ {
-              "$ref" : "#/components/schemas/UserRepresentation"
-            } ],
+            "properties" : {
+              "id" : {
+                "type" : "string"
+              },
+              "createdTimestamp" : {
+                "type" : "number"
+              },
+              "username" : {
+                "type" : "string"
+              },
+              "enabled" : {
+                "type" : "boolean"
+              },
+              "firstName" : {
+                "type" : "string"
+              },
+              "lastName" : {
+                "type" : "string"
+              },
+              "email" : {
+                "type" : "string"
+              },
+              "emailVerified" : {
+                "type" : "boolean"
+              },
+              "federationLink" : {
+                "type" : "string"
+              }
+            },
             "readOnly" : true
           },
           "roles" : {
@@ -603,237 +523,6 @@
             "readOnly" : true
           }
         }
-      },
-      "UserConsentRepresentation" : {
-        "type" : "object",
-        "properties" : {
-          "clientId" : {
-            "type" : "string"
-          },
-          "grantedClientScopes" : {
-            "type" : "array",
-            "items" : {
-              "type" : "string"
-            }
-          },
-          "createdDate" : {
-            "format" : "int64",
-            "type" : "integer"
-          },
-          "lastUpdatedDate" : {
-            "format" : "int64",
-            "type" : "integer"
-          },
-          "grantedRealmRoles" : {
-            "type" : "array",
-            "items" : {
-              "type" : "string"
-            },
-            "deprecated" : true
-          }
-        }
-      },
-      "UserProfileAttributeGroupMetadata" : {
-        "type" : "object",
-        "properties" : {
-          "name" : {
-            "type" : "string"
-          },
-          "displayHeader" : {
-            "type" : "string"
-          },
-          "displayDescription" : {
-            "type" : "string"
-          },
-          "annotations" : {
-            "type" : "object",
-            "additionalProperties" : { }
-          }
-        }
-      },
-      "UserProfileAttributeMetadata" : {
-        "type" : "object",
-        "properties" : {
-          "name" : {
-            "type" : "string"
-          },
-          "displayName" : {
-            "type" : "string"
-          },
-          "required" : {
-            "type" : "boolean"
-          },
-          "readOnly" : {
-            "type" : "boolean"
-          },
-          "annotations" : {
-            "type" : "object",
-            "additionalProperties" : { }
-          },
-          "validators" : {
-            "type" : "object",
-            "additionalProperties" : {
-              "type" : "object",
-              "additionalProperties" : { }
-            }
-          },
-          "group" : {
-            "type" : "string"
-          }
-        }
-      },
-      "UserProfileMetadata" : {
-        "type" : "object",
-        "properties" : {
-          "attributes" : {
-            "type" : "array",
-            "items" : {
-              "$ref" : "#/components/schemas/UserProfileAttributeMetadata"
-            }
-          },
-          "groups" : {
-            "type" : "array",
-            "items" : {
-              "$ref" : "#/components/schemas/UserProfileAttributeGroupMetadata"
-            }
-          }
-        }
-      },
-      "UserRepresentation" : {
-        "type" : "object",
-        "properties" : {
-          "self" : {
-            "type" : "string"
-          },
-          "id" : {
-            "type" : "string"
-          },
-          "origin" : {
-            "type" : "string"
-          },
-          "createdTimestamp" : {
-            "format" : "int64",
-            "type" : "integer"
-          },
-          "username" : {
-            "type" : "string"
-          },
-          "enabled" : {
-            "type" : "boolean"
-          },
-          "totp" : {
-            "type" : "boolean"
-          },
-          "emailVerified" : {
-            "type" : "boolean"
-          },
-          "firstName" : {
-            "type" : "string"
-          },
-          "lastName" : {
-            "type" : "string"
-          },
-          "email" : {
-            "type" : "string"
-          },
-          "federationLink" : {
-            "type" : "string"
-          },
-          "serviceAccountClientId" : {
-            "type" : "string"
-          },
-          "attributes" : {
-            "type" : "object",
-            "additionalProperties" : {
-              "type" : "array",
-              "items" : {
-                "type" : "string"
-              }
-            }
-          },
-          "credentials" : {
-            "type" : "array",
-            "items" : {
-              "$ref" : "#/components/schemas/CredentialRepresentation"
-            }
-          },
-          "disableableCredentialTypes" : {
-            "uniqueItems" : true,
-            "type" : "array",
-            "items" : {
-              "type" : "string"
-            }
-          },
-          "requiredActions" : {
-            "type" : "array",
-            "items" : {
-              "type" : "string"
-            }
-          },
-          "federatedIdentities" : {
-            "type" : "array",
-            "items" : {
-              "$ref" : "#/components/schemas/FederatedIdentityRepresentation"
-            }
-          },
-          "realmRoles" : {
-            "type" : "array",
-            "items" : {
-              "type" : "string"
-            }
-          },
-          "clientRoles" : {
-            "type" : "object",
-            "additionalProperties" : {
-              "type" : "array",
-              "items" : {
-                "type" : "string"
-              }
-            }
-          },
-          "clientConsents" : {
-            "type" : "array",
-            "items" : {
-              "$ref" : "#/components/schemas/UserConsentRepresentation"
-            }
-          },
-          "notBefore" : {
-            "format" : "int32",
-            "type" : "integer"
-          },
-          "applicationRoles" : {
-            "type" : "object",
-            "additionalProperties" : {
-              "type" : "array",
-              "items" : {
-                "type" : "string"
-              }
-            },
-            "deprecated" : true
-          },
-          "socialLinks" : {
-            "type" : "array",
-            "items" : {
-              "$ref" : "#/components/schemas/SocialLinkRepresentation"
-            },
-            "deprecated" : true
-          },
-          "groups" : {
-            "type" : "array",
-            "items" : {
-              "type" : "string"
-            }
-          },
-          "access" : {
-            "type" : "object",
-            "additionalProperties" : {
-              "type" : "boolean"
-            }
-          },
-          "userProfileMetadata" : {
-            "$ref" : "#/components/schemas/UserProfileMetadata"
-          }
-        }
       }
     }
   }