endpoint_analysis_format.md

Endpoint Analysis Format

Endpoint Analysis JSON Format

{
    "{endpoint}": {
        "status": "{status}",
        "endpoint": "{endpoint}",
        "data_sets": {},
        "parameters": [],
        "required_parameters": [],
        "nullable_parameters": [],
        "parameters_patterns": {
            "{property}": "{pattern}",
        }
    }
}

Name	Explanation
status	This field will be 'success' or 'fail'. Success statuses have passed all tests required by the endpoint analysis.
endpoint	The name of the endpoint.
data_sets	The data sets that are returned by the endpoint and their data headers.
parameters	All parameters for the endpoint.
required_parameters	All parameters for the endpoint that throw a required flag. Please note, required parameters can also be nullable. They just require a parameter to be passed.
nullable_parameters	All parameters for the endpoint that do not require a value.
parameter_patterns	Regular expression patterns for each parameter.