Module: Msf::WebServices::Documentation::Api::V1::RootApiDoc

Includes:

Swagger::Blocks

Defined in:

lib/msf/core/web_services/documentation/api/v1/root_api_doc.rb

Constant Summary

ID_DESC =

'The primary key used to identify this object in the database.'

CREATED_AT_DESC =

'The date and time this record was added to the database.'

UPDATED_AT_DESC =

'The date and time this record was last updated in the database.'

WORKSPACE_ID_DESC =

'The ID of the workspace this credential belongs to.'

WORKSPACE_POST_DESC =

'The name of the workspace where this record should be created.'

WORKSPACE_POST_EXAMPLE =

'default'

HOST_EXAMPLE =

'127.0.0.1'

CODE_DESC =

'The error code that was generated.'

CODE_EXAMPLE =

500

MESSAGE_DESC =

'A message describing the error that occurred.'

MESSAGE_EXAMPLE =

'Undefined method \'empty?\' for nil:NilClass'

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.'

LIMIT_DEFAULT =

100

LIMIT_DESC =

"The maximum number of results that will be retrieved from the query. (Default: #{LIMIT_DEFAULT})"

OFFSET_DEFAULT =

0

OFFSET_DESC =

"The number of results the query will begin reading from the beginning of the set. (Default: #{OFFSET_DEFAULT})"

ORDER_DESC =

'The order in which results are returned, based on the created_at datetime. (Default: desc)'

ORDER_ENUM =

[
    'asc',
    'desc'
]

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.'