diff --git a/documentation/api/v1/auth_api_doc.rb b/documentation/api/v1/auth_api_doc.rb index b4fe1223d1..d647dbc6fa 100644 --- a/documentation/api/v1/auth_api_doc.rb +++ b/documentation/api/v1/auth_api_doc.rb @@ -46,13 +46,6 @@ module AuthApiDoc end end - response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' - schema do - key :'$ref', :ErrorModel - end - end - response 401 do key :description, 'Invalid username or password. Authenticate to access this resource.' schema do @@ -60,6 +53,14 @@ module AuthApiDoc end end + response 500 do + key :description, 'An error occurred during the operation. See the message for more details.' + schema do + key :'$ref', :ErrorModel + end + end + + end end end diff --git a/documentation/api/v1/credential_api_doc.rb b/documentation/api/v1/credential_api_doc.rb index ab90fc1df3..bc959d23f1 100644 --- a/documentation/api/v1/credential_api_doc.rb +++ b/documentation/api/v1/credential_api_doc.rb @@ -167,6 +167,13 @@ module CredentialApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -212,6 +219,13 @@ module CredentialApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -237,6 +251,13 @@ module CredentialApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -274,6 +295,13 @@ module CredentialApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -308,6 +336,13 @@ module CredentialApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do diff --git a/documentation/api/v1/db_export_api_doc.rb b/documentation/api/v1/db_export_api_doc.rb index e3f0b9841d..165498d1a1 100644 --- a/documentation/api/v1/db_export_api_doc.rb +++ b/documentation/api/v1/db_export_api_doc.rb @@ -36,6 +36,13 @@ module DbExportApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do diff --git a/documentation/api/v1/event_api_doc.rb b/documentation/api/v1/event_api_doc.rb index 3049265568..33f6039370 100644 --- a/documentation/api/v1/event_api_doc.rb +++ b/documentation/api/v1/event_api_doc.rb @@ -56,6 +56,13 @@ module EventApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -64,4 +71,4 @@ module EventApiDoc end end end -end \ No newline at end of file +end diff --git a/documentation/api/v1/exploit_api_doc.rb b/documentation/api/v1/exploit_api_doc.rb index 4f9eda6d50..535ac35100 100644 --- a/documentation/api/v1/exploit_api_doc.rb +++ b/documentation/api/v1/exploit_api_doc.rb @@ -64,6 +64,13 @@ module ExploitApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do diff --git a/documentation/api/v1/host_api_doc.rb b/documentation/api/v1/host_api_doc.rb index 7364727eca..e1564c6640 100644 --- a/documentation/api/v1/host_api_doc.rb +++ b/documentation/api/v1/host_api_doc.rb @@ -113,6 +113,13 @@ module HostApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -168,6 +175,13 @@ module HostApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -195,6 +209,13 @@ module HostApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -228,6 +249,13 @@ module HostApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -262,6 +290,13 @@ module HostApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -270,4 +305,4 @@ module HostApiDoc end end end -end \ No newline at end of file +end diff --git a/documentation/api/v1/login_api_doc.rb b/documentation/api/v1/login_api_doc.rb index 5b60e51d56..a89bf82f76 100644 --- a/documentation/api/v1/login_api_doc.rb +++ b/documentation/api/v1/login_api_doc.rb @@ -61,6 +61,13 @@ module LoginApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -101,6 +108,13 @@ module LoginApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -127,6 +141,14 @@ module LoginApiDoc end end end + + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + end end @@ -154,6 +176,13 @@ module LoginApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -188,6 +217,13 @@ module LoginApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -196,4 +232,4 @@ module LoginApiDoc end end end -end \ No newline at end of file +end diff --git a/documentation/api/v1/loot_api_doc.rb b/documentation/api/v1/loot_api_doc.rb index e99422c196..285f615cc2 100644 --- a/documentation/api/v1/loot_api_doc.rb +++ b/documentation/api/v1/loot_api_doc.rb @@ -57,6 +57,13 @@ module LootApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -97,6 +104,13 @@ module LootApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -124,6 +138,13 @@ module LootApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -157,6 +178,13 @@ module LootApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -191,6 +219,13 @@ module LootApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -199,4 +234,4 @@ module LootApiDoc end end end -end \ No newline at end of file +end diff --git a/documentation/api/v1/module_search_api_doc.rb b/documentation/api/v1/module_search_api_doc.rb index fb5b6c25c3..32c0c9e7a7 100644 --- a/documentation/api/v1/module_search_api_doc.rb +++ b/documentation/api/v1/module_search_api_doc.rb @@ -167,6 +167,13 @@ module ModuleSearchApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do diff --git a/documentation/api/v1/msf_api_doc.rb b/documentation/api/v1/msf_api_doc.rb index a5701710ec..e514e3aa60 100644 --- a/documentation/api/v1/msf_api_doc.rb +++ b/documentation/api/v1/msf_api_doc.rb @@ -18,6 +18,13 @@ module MsfApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do diff --git a/documentation/api/v1/nmap_api_doc.rb b/documentation/api/v1/nmap_api_doc.rb index 349ac24091..8081e54b60 100644 --- a/documentation/api/v1/nmap_api_doc.rb +++ b/documentation/api/v1/nmap_api_doc.rb @@ -29,6 +29,13 @@ module NmapApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do diff --git a/documentation/api/v1/note_api_doc.rb b/documentation/api/v1/note_api_doc.rb index 1014c04e56..8ca1baf566 100644 --- a/documentation/api/v1/note_api_doc.rb +++ b/documentation/api/v1/note_api_doc.rb @@ -49,6 +49,13 @@ module NoteApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -86,6 +93,13 @@ module NoteApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -113,6 +127,13 @@ module NoteApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -146,6 +167,13 @@ module NoteApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -180,6 +208,13 @@ module NoteApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -188,4 +223,4 @@ module NoteApiDoc end end end -end \ No newline at end of file +end diff --git a/documentation/api/v1/service_api_doc.rb b/documentation/api/v1/service_api_doc.rb index 3129f8e351..3b037c14d0 100644 --- a/documentation/api/v1/service_api_doc.rb +++ b/documentation/api/v1/service_api_doc.rb @@ -50,6 +50,13 @@ module ServiceApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -88,6 +95,13 @@ module ServiceApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -115,6 +129,13 @@ module ServiceApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -149,6 +170,13 @@ module ServiceApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -183,6 +211,13 @@ module ServiceApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -191,4 +226,4 @@ module ServiceApiDoc end end end -end \ No newline at end of file +end diff --git a/documentation/api/v1/session_api_doc.rb b/documentation/api/v1/session_api_doc.rb index b1bd95a46f..e24c64ca11 100644 --- a/documentation/api/v1/session_api_doc.rb +++ b/documentation/api/v1/session_api_doc.rb @@ -41,6 +41,13 @@ module SessionApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -102,6 +109,13 @@ module SessionApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do diff --git a/documentation/api/v1/session_event_api_doc.rb b/documentation/api/v1/session_event_api_doc.rb index a325bc0faf..7a2ea530d6 100644 --- a/documentation/api/v1/session_event_api_doc.rb +++ b/documentation/api/v1/session_event_api_doc.rb @@ -44,6 +44,13 @@ module SessionEventApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -81,6 +88,13 @@ module SessionEventApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -114,6 +128,13 @@ module SessionEventApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do diff --git a/documentation/api/v1/user_api_doc.rb b/documentation/api/v1/user_api_doc.rb index 553e715918..e8d03aeb68 100644 --- a/documentation/api/v1/user_api_doc.rb +++ b/documentation/api/v1/user_api_doc.rb @@ -60,6 +60,17 @@ module UserApiDoc end end + response 200 do + key :description, 'Authenticate to access this resource' + end + + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -101,6 +112,13 @@ module UserApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do diff --git a/documentation/api/v1/vuln_api_doc.rb b/documentation/api/v1/vuln_api_doc.rb index 9acfcb1e48..c6345569a6 100644 --- a/documentation/api/v1/vuln_api_doc.rb +++ b/documentation/api/v1/vuln_api_doc.rb @@ -98,6 +98,13 @@ module VulnApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -141,6 +148,13 @@ module VulnApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -168,6 +182,13 @@ module VulnApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -201,6 +222,13 @@ module VulnApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -235,6 +263,13 @@ module VulnApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -243,4 +278,4 @@ module VulnApiDoc end end end -end \ No newline at end of file +end diff --git a/documentation/api/v1/vuln_attempt_api_doc.rb b/documentation/api/v1/vuln_attempt_api_doc.rb index fc18f275b8..d6cda8c4ba 100644 --- a/documentation/api/v1/vuln_attempt_api_doc.rb +++ b/documentation/api/v1/vuln_attempt_api_doc.rb @@ -50,6 +50,13 @@ module VulnAttemptApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -89,6 +96,13 @@ module VulnAttemptApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -122,6 +136,13 @@ module VulnAttemptApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -130,4 +151,4 @@ module VulnAttemptApiDoc end end end -end \ No newline at end of file +end diff --git a/documentation/api/v1/workspace_api_doc.rb b/documentation/api/v1/workspace_api_doc.rb index e3094b5fbd..dffdbf19ed 100644 --- a/documentation/api/v1/workspace_api_doc.rb +++ b/documentation/api/v1/workspace_api_doc.rb @@ -43,6 +43,13 @@ module WorkspaceApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -75,6 +82,13 @@ module WorkspaceApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -102,6 +116,13 @@ module WorkspaceApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -135,6 +156,13 @@ module WorkspaceApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -169,6 +197,13 @@ module WorkspaceApiDoc end end + response 401 do + key :description, 'Authenticate to access this resource.' + schema do + key :'$ref', :AuthErrorModel + end + end + response 500 do key :description, 'An error occurred during the operation. See the message for more details.' schema do @@ -177,4 +212,4 @@ module WorkspaceApiDoc end end end -end \ No newline at end of file +end