From c0ee32e580bdffbb8e3919389616625a94cc0dda Mon Sep 17 00:00:00 2001 From: otoroshi-github-actions Date: Mon, 24 Jul 2023 09:40:13 +0000 Subject: [PATCH] Update dev documentation websites --- docs/devmanual/code/openapi.json | 120 +++++++++++++++++++++ docs/devmanual/install/setup-otoroshi.html | 2 + docs/devmanual/snippets/reference-env.conf | 1 + docs/devmanual/snippets/reference.conf | 1 + 4 files changed, 124 insertions(+) diff --git a/docs/devmanual/code/openapi.json b/docs/devmanual/code/openapi.json index c18b306f1a..67664e8f61 100644 --- 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 index e399463bcb..2f9d3e4766 100644 --- a/docs/devmanual/install/setup-otoroshi.html +++ b/docs/devmanual/install/setup-otoroshi.html @@ -997,6 +997,7 @@