From a70c5f0c370e9efb7462e9f17afd84a3e7eb244b Mon Sep 17 00:00:00 2001 From: Erin Bleiweiss Date: Wed, 15 Aug 2018 15:26:35 -0500 Subject: [PATCH] Replace strings with reusable constants --- documentation/api/v1/auth_api_doc.rb | 4 ++-- documentation/api/v1/credential_api_doc.rb | 24 +++++++++---------- documentation/api/v1/db_export_api_doc.rb | 4 ++-- documentation/api/v1/event_api_doc.rb | 6 ++--- documentation/api/v1/exploit_api_doc.rb | 6 ++--- documentation/api/v1/host_api_doc.rb | 22 ++++++++--------- documentation/api/v1/login_api_doc.rb | 22 ++++++++--------- documentation/api/v1/loot_api_doc.rb | 24 +++++++++---------- documentation/api/v1/module_search_api_doc.rb | 4 ++-- documentation/api/v1/msf_api_doc.rb | 4 ++-- documentation/api/v1/nmap_api_doc.rb | 4 ++-- documentation/api/v1/note_api_doc.rb | 24 +++++++++---------- documentation/api/v1/root_api_doc.rb | 7 ++++-- documentation/api/v1/service_api_doc.rb | 24 +++++++++---------- documentation/api/v1/session_api_doc.rb | 10 ++++---- documentation/api/v1/session_event_api_doc.rb | 14 +++++------ documentation/api/v1/user_api_doc.rb | 10 ++++---- documentation/api/v1/vuln_api_doc.rb | 20 ++++++++-------- documentation/api/v1/vuln_attempt_api_doc.rb | 14 +++++------ documentation/api/v1/workspace_api_doc.rb | 24 +++++++++---------- 20 files changed, 137 insertions(+), 134 deletions(-) diff --git a/documentation/api/v1/auth_api_doc.rb b/documentation/api/v1/auth_api_doc.rb index d647dbc6fa..9b5ea9ab0b 100644 --- a/documentation/api/v1/auth_api_doc.rb +++ b/documentation/api/v1/auth_api_doc.rb @@ -47,14 +47,14 @@ module AuthApiDoc end response 401 do - key :description, 'Invalid username or password. Authenticate to access this resource.' + key :description, 'Invalid username or password. ' + RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/credential_api_doc.rb b/documentation/api/v1/credential_api_doc.rb index bc959d23f1..a8f527aa3a 100644 --- a/documentation/api/v1/credential_api_doc.rb +++ b/documentation/api/v1/credential_api_doc.rb @@ -168,14 +168,14 @@ module CredentialApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -211,7 +211,7 @@ module CredentialApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Credential @@ -220,14 +220,14 @@ module CredentialApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -252,14 +252,14 @@ module CredentialApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -296,14 +296,14 @@ module CredentialApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -328,7 +328,7 @@ module CredentialApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Credential @@ -337,14 +337,14 @@ module CredentialApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/db_export_api_doc.rb b/documentation/api/v1/db_export_api_doc.rb index 165498d1a1..9a90333670 100644 --- a/documentation/api/v1/db_export_api_doc.rb +++ b/documentation/api/v1/db_export_api_doc.rb @@ -37,14 +37,14 @@ module DbExportApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/event_api_doc.rb b/documentation/api/v1/event_api_doc.rb index 33f6039370..434bbc745a 100644 --- a/documentation/api/v1/event_api_doc.rb +++ b/documentation/api/v1/event_api_doc.rb @@ -48,7 +48,7 @@ module EventApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Event @@ -57,14 +57,14 @@ module EventApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/exploit_api_doc.rb b/documentation/api/v1/exploit_api_doc.rb index 535ac35100..aa507390fb 100644 --- a/documentation/api/v1/exploit_api_doc.rb +++ b/documentation/api/v1/exploit_api_doc.rb @@ -56,7 +56,7 @@ module ExploitApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Exploit @@ -65,14 +65,14 @@ module ExploitApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/host_api_doc.rb b/documentation/api/v1/host_api_doc.rb index e1564c6640..11ad48b079 100644 --- a/documentation/api/v1/host_api_doc.rb +++ b/documentation/api/v1/host_api_doc.rb @@ -114,14 +114,14 @@ module HostApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -167,7 +167,7 @@ module HostApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Host @@ -176,14 +176,14 @@ module HostApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -210,14 +210,14 @@ module HostApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -250,14 +250,14 @@ module HostApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -291,14 +291,14 @@ module HostApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/login_api_doc.rb b/documentation/api/v1/login_api_doc.rb index a89bf82f76..b100e62383 100644 --- a/documentation/api/v1/login_api_doc.rb +++ b/documentation/api/v1/login_api_doc.rb @@ -62,14 +62,14 @@ module LoginApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -100,7 +100,7 @@ module LoginApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Login @@ -109,14 +109,14 @@ module LoginApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -143,7 +143,7 @@ module LoginApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end @@ -177,14 +177,14 @@ module LoginApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -209,7 +209,7 @@ module LoginApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Login @@ -218,14 +218,14 @@ module LoginApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/loot_api_doc.rb b/documentation/api/v1/loot_api_doc.rb index 285f615cc2..9fd6737052 100644 --- a/documentation/api/v1/loot_api_doc.rb +++ b/documentation/api/v1/loot_api_doc.rb @@ -58,14 +58,14 @@ module LootApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -96,7 +96,7 @@ module LootApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Loot @@ -105,14 +105,14 @@ module LootApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -139,14 +139,14 @@ module LootApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -179,14 +179,14 @@ module LootApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -211,7 +211,7 @@ module LootApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Loot @@ -220,14 +220,14 @@ module LootApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/module_search_api_doc.rb b/documentation/api/v1/module_search_api_doc.rb index 32c0c9e7a7..b85e128316 100644 --- a/documentation/api/v1/module_search_api_doc.rb +++ b/documentation/api/v1/module_search_api_doc.rb @@ -168,14 +168,14 @@ module ModuleSearchApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/msf_api_doc.rb b/documentation/api/v1/msf_api_doc.rb index e514e3aa60..d1f3b51475 100644 --- a/documentation/api/v1/msf_api_doc.rb +++ b/documentation/api/v1/msf_api_doc.rb @@ -19,14 +19,14 @@ module MsfApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/nmap_api_doc.rb b/documentation/api/v1/nmap_api_doc.rb index 8081e54b60..282500ae55 100644 --- a/documentation/api/v1/nmap_api_doc.rb +++ b/documentation/api/v1/nmap_api_doc.rb @@ -30,14 +30,14 @@ module NmapApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/note_api_doc.rb b/documentation/api/v1/note_api_doc.rb index 8ca1baf566..e6edecf8b9 100644 --- a/documentation/api/v1/note_api_doc.rb +++ b/documentation/api/v1/note_api_doc.rb @@ -50,14 +50,14 @@ module NoteApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -85,7 +85,7 @@ module NoteApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Note @@ -94,14 +94,14 @@ module NoteApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -128,14 +128,14 @@ module NoteApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -168,14 +168,14 @@ module NoteApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -200,7 +200,7 @@ module NoteApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Note @@ -209,14 +209,14 @@ module NoteApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/root_api_doc.rb b/documentation/api/v1/root_api_doc.rb index b4e5069084..48b3c858e2 100644 --- a/documentation/api/v1/root_api_doc.rb +++ b/documentation/api/v1/root_api_doc.rb @@ -17,7 +17,10 @@ module RootApiDoc AUTH_CODE_DESC = 'The authentication error code that was generated.' AUTH_CODE_EXAMPLE = 401 AUTH_MESSAGE_DESC = 'A message describing the authentication error that occurred.' - AUTH_MESSAGE_EXAMPLE = 'Authenticate to access this resource' + + DEFAULT_RESPONSE_200 = 'Successful operation.' + DEFAULT_RESPONSE_401 = 'Authenticate to access this resource.' + DEFAULT_RESPONSE_500 = 'An error occurred during the operation. See the message for more details.' swagger_root do key :swagger, '2.0' @@ -155,7 +158,7 @@ module RootApiDoc property :message do key :type, :string key :description, AUTH_MESSAGE_DESC - key :example, AUTH_MESSAGE_EXAMPLE + key :example, DEFAULT_RESPONSE_401 end end end diff --git a/documentation/api/v1/service_api_doc.rb b/documentation/api/v1/service_api_doc.rb index 3b037c14d0..6aff443943 100644 --- a/documentation/api/v1/service_api_doc.rb +++ b/documentation/api/v1/service_api_doc.rb @@ -51,14 +51,14 @@ module ServiceApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -87,7 +87,7 @@ module ServiceApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Service @@ -96,14 +96,14 @@ module ServiceApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -130,14 +130,14 @@ module ServiceApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -171,14 +171,14 @@ module ServiceApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -203,7 +203,7 @@ module ServiceApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Service @@ -212,14 +212,14 @@ module ServiceApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/session_api_doc.rb b/documentation/api/v1/session_api_doc.rb index e24c64ca11..6b40f323da 100644 --- a/documentation/api/v1/session_api_doc.rb +++ b/documentation/api/v1/session_api_doc.rb @@ -42,14 +42,14 @@ module SessionApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -76,7 +76,7 @@ module SessionApiDoc # end # # response 200 do - # key :description, 'Successful operation.' + # key :description, RootApiDoc::DEFAULT_RESPONSE_200 # schema do # key :type, :object # key :'$ref', :Session @@ -110,14 +110,14 @@ module SessionApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/session_event_api_doc.rb b/documentation/api/v1/session_event_api_doc.rb index 7a2ea530d6..c55e3b2ed6 100644 --- a/documentation/api/v1/session_event_api_doc.rb +++ b/documentation/api/v1/session_event_api_doc.rb @@ -45,14 +45,14 @@ module SessionEventApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -80,7 +80,7 @@ module SessionEventApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :SessionEvent @@ -89,14 +89,14 @@ module SessionEventApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -129,14 +129,14 @@ module SessionEventApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/user_api_doc.rb b/documentation/api/v1/user_api_doc.rb index 92aa3acd7e..7ad65469fb 100644 --- a/documentation/api/v1/user_api_doc.rb +++ b/documentation/api/v1/user_api_doc.rb @@ -61,14 +61,14 @@ module UserApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -97,7 +97,7 @@ module UserApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :type, :array @@ -109,14 +109,14 @@ module UserApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/vuln_api_doc.rb b/documentation/api/v1/vuln_api_doc.rb index c6345569a6..a71512b2c2 100644 --- a/documentation/api/v1/vuln_api_doc.rb +++ b/documentation/api/v1/vuln_api_doc.rb @@ -99,14 +99,14 @@ module VulnApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -149,14 +149,14 @@ module VulnApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -183,14 +183,14 @@ module VulnApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -223,14 +223,14 @@ module VulnApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -264,14 +264,14 @@ module VulnApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/vuln_attempt_api_doc.rb b/documentation/api/v1/vuln_attempt_api_doc.rb index d6cda8c4ba..a83e8f4b8a 100644 --- a/documentation/api/v1/vuln_attempt_api_doc.rb +++ b/documentation/api/v1/vuln_attempt_api_doc.rb @@ -51,14 +51,14 @@ module VulnAttemptApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -88,7 +88,7 @@ module VulnAttemptApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :VulnAttempt @@ -97,14 +97,14 @@ module VulnAttemptApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -137,14 +137,14 @@ module VulnAttemptApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end diff --git a/documentation/api/v1/workspace_api_doc.rb b/documentation/api/v1/workspace_api_doc.rb index dffdbf19ed..2232fb365c 100644 --- a/documentation/api/v1/workspace_api_doc.rb +++ b/documentation/api/v1/workspace_api_doc.rb @@ -44,14 +44,14 @@ module WorkspaceApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -74,7 +74,7 @@ module WorkspaceApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Workspace @@ -83,14 +83,14 @@ module WorkspaceApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -117,14 +117,14 @@ module WorkspaceApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -157,14 +157,14 @@ module WorkspaceApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end @@ -189,7 +189,7 @@ module WorkspaceApiDoc end response 200 do - key :description, 'Successful operation.' + key :description, RootApiDoc::DEFAULT_RESPONSE_200 schema do property :data do key :'$ref', :Workspace @@ -198,14 +198,14 @@ module WorkspaceApiDoc end response 401 do - key :description, 'Authenticate to access this resource.' + key :description, RootApiDoc::DEFAULT_RESPONSE_401 schema do key :'$ref', :AuthErrorModel end end response 500 do - key :description, 'An error occurred during the operation. See the message for more details.' + key :description, RootApiDoc::DEFAULT_RESPONSE_500 schema do key :'$ref', :ErrorModel end