Commit 4c6543f1 authored by Russell Dickenson's avatar Russell Dickenson

Merge branch 'docs-fix-dast-api-docs' into 'master'

Minor fixes to DAST API documentation

See merge request gitlab-org/gitlab!69132
parents 81826be8 3ee6fddd
...@@ -328,6 +328,8 @@ Vulnerability rules in an API scan are different than those in a normal website ...@@ -328,6 +328,8 @@ Vulnerability rules in an API scan are different than those in a normal website
A new DAST API scanning engine is available in GitLab 13.12 and later. For more details, see [DAST API scanning engine](../dast_api). The new scanning engine supports REST, SOAP, GraphQL, and generic APIs using forms, XML, and JSON. Testing can be performed using OpenAPI, Postman Collections, and HTTP Archive (HAR) documents. A new DAST API scanning engine is available in GitLab 13.12 and later. For more details, see [DAST API scanning engine](../dast_api). The new scanning engine supports REST, SOAP, GraphQL, and generic APIs using forms, XML, and JSON. Testing can be performed using OpenAPI, Postman Collections, and HTTP Archive (HAR) documents.
The target API instance’s base URL is provided by using the `DAST_API_TARGET_URL` variable or an `environment_url.txt` file.
#### Specification format #### Specification format
API scans support OpenAPI V2 and OpenAPI V3 specifications. You can define these specifications using `JSON` or `YAML`. API scans support OpenAPI V2 and OpenAPI V3 specifications. You can define these specifications using `JSON` or `YAML`.
...@@ -339,7 +341,7 @@ The specification does not have to be hosted on the same host as the API being t ...@@ -339,7 +341,7 @@ The specification does not have to be hosted on the same host as the API being t
```yaml ```yaml
include: include:
- template: DAST.gitlab-ci.yml - template: DAST-API.gitlab-ci.yml
variables: variables:
DAST_API_OPENAPI: http://my.api/api-specification.yml DAST_API_OPENAPI: http://my.api/api-specification.yml
...@@ -390,7 +392,7 @@ the following DAST configuration can be used: ...@@ -390,7 +392,7 @@ the following DAST configuration can be used:
```yaml ```yaml
include: include:
- template: DAST.gitlab-ci.yml - template: DAST-API.gitlab-ci.yml
variables: variables:
DAST_API_OPENAPI: http://api-test.host.com/api-specification.yml DAST_API_OPENAPI: http://api-test.host.com/api-specification.yml
...@@ -405,7 +407,7 @@ Headers are applied to every request DAST makes. ...@@ -405,7 +407,7 @@ Headers are applied to every request DAST makes.
```yaml ```yaml
include: include:
- template: DAST.gitlab-ci.yml - template: DAST-API.gitlab-ci.yml
variables: variables:
DAST_API_OPENAPI: http://api-test.api.com/api-specification.yml DAST_API_OPENAPI: http://api-test.api.com/api-specification.yml
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment