Update dev documentation websites

MAIF · Jul 24, 2023 · c0ee32e · c0ee32e
1 parent 8777093
commit c0ee32e
Show file tree

Hide file tree

Showing 4 changed files with 124 additions and 0 deletions.
diff --git a/docs/devmanual/code/openapi.json b/docs/devmanual/code/openapi.json
@@ -17867,6 +17867,66 @@
       }
     },
     "/api/admins/simple/{username}" : {
+      "get" : {
+        "tags" : [ "admins" ],
+        "summary" : "???",
+        "operationId" : "otoroshi.controllers.adminapi.UsersController.findAdmin",
+        "parameters" : [ {
+          "name" : "username",
+          "in" : "path",
+          "schema" : {
+            "type" : "string"
+          },
+          "required" : true,
+          "description" : "the username parameter"
+        } ],
+        "security" : [ {
+          "otoroshi_auth" : [ ]
+        } ],
+        "responses" : {
+          "401" : {
+            "description" : "You have to provide an Api Key. Api Key can be passed with 'Otoroshi-Client-Id' and 'Otoroshi-Client-Secret' headers, or use basic http authentication",
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          },
+          "400" : {
+            "description" : "Bad resource format. Take another look to the swagger, or open an issue",
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          },
+          "404" : {
+            "description" : "Resource not found or does not exist",
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          },
+          "200" : {
+            "description" : "Successful operation",
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "description" : "unknown type",
+                  "type" : "object"
+                }
+              }
+            }
+          }
+        }
+      },
       "put" : {
         "tags" : [ "admins" ],
         "summary" : "???",
@@ -18119,6 +18179,66 @@
       }
     },
     "/api/admins/webauthn/{username}" : {
+      "get" : {
+        "tags" : [ "admins" ],
+        "summary" : "???",
+        "operationId" : "otoroshi.controllers.adminapi.UsersController.findWebAuthnAdmin",
+        "parameters" : [ {
+          "name" : "username",
+          "in" : "path",
+          "schema" : {
+            "type" : "string"
+          },
+          "required" : true,
+          "description" : "the username parameter"
+        } ],
+        "security" : [ {
+          "otoroshi_auth" : [ ]
+        } ],
+        "responses" : {
+          "401" : {
+            "description" : "You have to provide an Api Key. Api Key can be passed with 'Otoroshi-Client-Id' and 'Otoroshi-Client-Secret' headers, or use basic http authentication",
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          },
+          "400" : {
+            "description" : "Bad resource format. Take another look to the swagger, or open an issue",
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          },
+          "404" : {
+            "description" : "Resource not found or does not exist",
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          },
+          "200" : {
+            "description" : "Successful operation",
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "description" : "unknown type",
+                  "type" : "object"
+                }
+              }
+            }
+          }
+        }
+      },
       "put" : {
         "tags" : [ "admins" ],
         "summary" : "???",

diff --git a/docs/devmanual/install/setup-otoroshi.html b/docs/devmanual/install/setup-otoroshi.html
@@ -997,6 +997,7 @@ <h3><a href="#reference-configuration" name="reference-configuration" class="anc
     number =  ${?INSTANCE_NUMBER} # the instance number. Can be found in otoroshi events
     name = &quot;otoroshi&quot; # instance name
     name = ${?OTOROSHI_INSTANCE_NAME} # instance name
+		logo = ${?OTOROSHI_INSTANCE_LOGO} # instance logo
     zone = &quot;local&quot; # instance zone (optional)
     zone = ${?OTOROSHI_INSTANCE_ZONE} # instance zone (optional)
     region = &quot;local&quot; # instance region (optional)
@@ -2630,6 +2631,7 @@ <h2><a href="#reference-configuration-for-env-variables" name="reference-configu
     number =  ${?OTOROSHI_INSTANCE_NUMBER} # the instance number. Can be found in otoroshi events
     number =  ${?INSTANCE_NUMBER} # the instance number. Can be found in otoroshi events
     name = ${?OTOROSHI_INSTANCE_NAME} # instance name
+		logo = ${?OTOROSHI_INSTANCE_LOGO} # instance logo
     zone = ${?OTOROSHI_INSTANCE_ZONE} # instance zone (optional)
     region = ${?OTOROSHI_INSTANCE_REGION} # instance region (optional)
     dc = ${?OTOROSHI_INSTANCE_DATACENTER} # instance dc (optional)

diff --git a/docs/devmanual/snippets/reference-env.conf b/docs/devmanual/snippets/reference-env.conf
@@ -44,6 +44,7 @@ app {
     number =  ${?OTOROSHI_INSTANCE_NUMBER} # the instance number. Can be found in otoroshi events
     number =  ${?INSTANCE_NUMBER} # the instance number. Can be found in otoroshi events
     name = ${?OTOROSHI_INSTANCE_NAME} # instance name
+		logo = ${?OTOROSHI_INSTANCE_LOGO} # instance logo
     zone = ${?OTOROSHI_INSTANCE_ZONE} # instance zone (optional)
     region = ${?OTOROSHI_INSTANCE_REGION} # instance region (optional)
     dc = ${?OTOROSHI_INSTANCE_DATACENTER} # instance dc (optional)

diff --git a/docs/devmanual/snippets/reference.conf b/docs/devmanual/snippets/reference.conf
@@ -77,6 +77,7 @@ app {
     number =  ${?INSTANCE_NUMBER} # the instance number. Can be found in otoroshi events
     name = "otoroshi" # instance name
     name = ${?OTOROSHI_INSTANCE_NAME} # instance name
+		logo = ${?OTOROSHI_INSTANCE_LOGO} # instance logo
     zone = "local" # instance zone (optional)
     zone = ${?OTOROSHI_INSTANCE_ZONE} # instance zone (optional)
     region = "local" # instance region (optional)