infosecn1nja
/
metasploit-framework
mirror of https://github.com/infosecn1nja/metasploit-framework.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add 401 responses for all endpoints

GSoC/Meterpreter_Web_Console
Erin Bleiweiss 2018-08-14 13:35:59 -05:00
parent 66b761db15
commit 2abc49641c
19 changed files with 414 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
documentation/api/v1/auth_api_doc.rb
View File

@ -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

35
documentation/api/v1/credential_api_doc.rb
View File

@ -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

7
documentation/api/v1/db_export_api_doc.rb
View File

@ -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

9
documentation/api/v1/event_api_doc.rb
View File

@ -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
end

7
documentation/api/v1/exploit_api_doc.rb
View File

@ -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

37
documentation/api/v1/host_api_doc.rb
View File

@ -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
end

38
documentation/api/v1/login_api_doc.rb
View File

@ -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
end

37
documentation/api/v1/loot_api_doc.rb
View File

@ -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
end

7
documentation/api/v1/module_search_api_doc.rb
View File

@ -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

7
documentation/api/v1/msf_api_doc.rb
View File

@ -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

7
documentation/api/v1/nmap_api_doc.rb
View File

@ -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

37
documentation/api/v1/note_api_doc.rb
View File

@ -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
end

37
documentation/api/v1/service_api_doc.rb
View File

@ -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
end

14
documentation/api/v1/session_api_doc.rb
View File

@ -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

21
documentation/api/v1/session_event_api_doc.rb
View File

@ -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

18
documentation/api/v1/user_api_doc.rb
View File

@ -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

37
documentation/api/v1/vuln_api_doc.rb
View File

@ -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
end

23
documentation/api/v1/vuln_attempt_api_doc.rb
View File

@ -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
end

37
documentation/api/v1/workspace_api_doc.rb
View File

@ -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
end