Update swagger docs to be compliant with new notes field
parent
e753eddb6b
commit
b1479ec350
|
@ -3,6 +3,7 @@ require 'swagger/blocks'
|
|||
module ModuleSearchApiDoc
|
||||
include Swagger::Blocks
|
||||
|
||||
AKA_DESC = 'Filter modules with a matching AKA name.'
|
||||
APP_DESC = 'Filter modules that are client or server attacks. (Accepts strings \'client\' or \'server\').'
|
||||
ARCH_DESC = 'Filter modules with a matching architecture.'
|
||||
AUTHOR_DESC = 'Filter modules written by a matching author.'
|
||||
|
@ -33,7 +34,8 @@ module ModuleSearchApiDoc
|
|||
TARGETS_DESC = 'Alias for \'target\'.'
|
||||
TEXT_DESC = 'Filter modules matching any one of name, full name, description, reference, author, or targets.'
|
||||
TYPE_DESC = 'Filter modules with a matching type (exploit, auxiliary, payload, etc.).'
|
||||
FIELDS_DESC = 'Provide a comma-delimited list of metadata fields you would like to return. If left blank, all fields will be returned. Valid field names are: \'name\', \'full_name\', \'fullname\', \'arch\', \'author\', \'author\', \'description\', \'disclosure_date\', \'cve\', \'edb\', \'bid\', \'mod_time\', \'is_client\', \'is_server\', \'is_install_path\', \'os\', \'platform\', \'reference\', \'references\', \'ref_name\', \'ref\', \'path\', \'port\', \'rport\', \'rank\', \'type\', \'target\', \'targets\''
|
||||
FIELDS_DESC = 'Provide a comma-delimited list of metadata fields you would like to return. If left blank, all fields will be returned. Valid field names are: \'name\', \'full_name\', \'fullname\', \'aka\', \'arch\', \'author\', \'author\', \'description\', \'disclosure_date\', \'cve\', \'edb\', \'bid\', \'mod_time\', \'is_client\', \'is_server\', \'is_install_path\', \'os\', \'platform\', \'reference\', \'references\', \'ref_name\', \'ref\', \'path\', \'port\', \'rport\', \'rank\', \'type\', \'target\', \'targets\''
|
||||
NOTES_DESC = 'Extra info for a module, such as AKA names or NOCVE explanations.'
|
||||
|
||||
TYPE_ENUM = [
|
||||
'auxiliary',
|
||||
|
@ -59,7 +61,6 @@ module ModuleSearchApiDoc
|
|||
'thelightcosine'
|
||||
]
|
||||
REFERENCES_EXAMPLE = [
|
||||
'AKA-ETERNALBLUE',
|
||||
'MSB-MS17-010',
|
||||
'CVE-2017-0143',
|
||||
'CVE-2017-0144',
|
||||
|
@ -81,6 +82,9 @@ module ModuleSearchApiDoc
|
|||
TARGETS_EXAMPLE = [
|
||||
'Windows 7 and Server 2008 R2 (x64) All Service Packs'
|
||||
]
|
||||
NOTES_EXAMPLE = {
|
||||
'AKA': [ 'ETERNALBLUE' ]
|
||||
}
|
||||
|
||||
|
||||
# Swagger documentation for Module Search model
|
||||
|
@ -103,6 +107,7 @@ module ModuleSearchApiDoc
|
|||
property :path, type: :string, description: PATH_DESC, example: PATH_EXAMPLE
|
||||
property :is_install_path, type: :boolean, description: IS_INSTALL_PATH_DESC, example: IS_INSTALL_PATH_EXAMPLE
|
||||
property :targets, description: TARGET_DESC, example: TARGETS_EXAMPLE, type: :array do items type: :string end
|
||||
property :notes, description: NOTES_DESC, example: NOTES_EXAMPLE, type: :hash do items type: :hash end
|
||||
end
|
||||
|
||||
|
||||
|
@ -114,6 +119,7 @@ module ModuleSearchApiDoc
|
|||
key :tags, [ 'module' ]
|
||||
|
||||
parameters = {
|
||||
:aka => AKA_DESC,
|
||||
:app => APP_DESC,
|
||||
:arch => ARCH_DESC,
|
||||
:author => AUTHOR_DESC,
|
||||
|
|
Loading…
Reference in New Issue