This is a service to validate documents against the CSAF standard.
Retrieve all tests. (apiV1TestsGet)
This endpoint is intended to be used to discover all available tests. For each tests it lists the name as well as the preset the test belongs to.
Return type
Example data
Content-Type: application/json
[ {
"name" : "name",
"preset" : "preset"
}, {
"name" : "name",
"preset" : "preset"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Default Response
Validate document. (apiV1ValidatePost)
This endpoint is intended to validate a document against the specified tests. In the list of tests provide at least one object, where each object is used to run either a single test or an entire preset. For 'name' provide the test's or the preset's name, and as 'type' provide accordingly either 'test' or 'preset'. For the value of the property 'document' just provide the json of your CSAF document.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"tests" : [ {
"warnings" : [ {
"instancePath" : "instancePath",
"message" : "message"
}, {
"instancePath" : "instancePath",
"message" : "message"
} ],
"isValid" : true,
"name" : "name",
"errors" : [ {
"instancePath" : "instancePath",
"message" : "message"
}, {
"instancePath" : "instancePath",
"message" : "message"
} ],
"infos" : [ {
"instancePath" : "instancePath",
"message" : "message"
}, {
"instancePath" : "instancePath",
"message" : "message"
} ]
}, {
"warnings" : [ {
"instancePath" : "instancePath",
"message" : "message"
}, {
"instancePath" : "instancePath",
"message" : "message"
} ],
"isValid" : true,
"name" : "name",
"errors" : [ {
"instancePath" : "instancePath",
"message" : "message"
}, {
"instancePath" : "instancePath",
"message" : "message"
} ],
"infos" : [ {
"instancePath" : "instancePath",
"message" : "message"
}, {
"instancePath" : "instancePath",
"message" : "message"
} ]
} ],
"isValid" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Default Response
_api_v1_validate_post_200_response