Commit 515a9f8a authored by Craig Norris's avatar Craig Norris

Merge branch 'russell/edit-fuzzing-docs-metadata' into 'master'

Edit Fuzzing docs metadata

See merge request gitlab-org/gitlab!62357
parents a0dda238 23d71d88
--- ---
stage: Secure stage: Secure
group: Fuzz Testing group: Dynamic Analysis
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
type: howto type: howto
--- ---
......
--- ---
stage: Secure stage: Secure
group: Fuzz Testing group: Dynamic Analysis
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
type: reference, howto type: reference, howto
--- ---
...@@ -116,8 +116,8 @@ To generate an API Fuzzing configuration snippet: ...@@ -116,8 +116,8 @@ To generate an API Fuzzing configuration snippet:
> Support for OpenAPI Specification v3.0 was > Support for OpenAPI Specification v3.0 was
> [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/228652) in GitLab 13.9. > [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/228652) in GitLab 13.9.
The [OpenAPI Specification](https://www.openapis.org/) (formerly the Swagger Specification) is an API description format for REST APIs. The [OpenAPI Specification](https://www.openapis.org/) (formerly the Swagger Specification) is an API description format for REST APIs.
This section shows you how to configure API fuzzing using an OpenAPI Specification to provide information about the target API to test. This section shows you how to configure API fuzzing using an OpenAPI Specification to provide information about the target API to test.
OpenAPI Specifications are provided as a file system resource or URL. Both JSON and YAML OpenAPI formats are supported. OpenAPI Specifications are provided as a file system resource or URL. Both JSON and YAML OpenAPI formats are supported.
API fuzzing uses an OpenAPI document to generate the request body. When a request body is required, API fuzzing uses an OpenAPI document to generate the request body. When a request body is required,
...@@ -1171,7 +1171,7 @@ The best-suited solution will depend on whether or not your target API changes f ...@@ -1171,7 +1171,7 @@ The best-suited solution will depend on whether or not your target API changes f
#### Static environment solution #### Static environment solution
This solution is for pipelines in which the target API URL doesn't change (is static). This solution is for pipelines in which the target API URL doesn't change (is static).
**Add environmental variable** **Add environmental variable**
...@@ -1188,7 +1188,7 @@ include: ...@@ -1188,7 +1188,7 @@ include:
#### Dynamic environment solutions #### Dynamic environment solutions
In a dynamic environment your target API changes for each different deployment. In this case, there is more than one possible solution, we recommend to use the `environment_url.txt` file when dealing with dynamic environments. In a dynamic environment your target API changes for each different deployment. In this case, there is more than one possible solution, we recommend to use the `environment_url.txt` file when dealing with dynamic environments.
**Use environment_url.txt** **Use environment_url.txt**
......
--- ---
stage: Secure stage: Secure
group: Fuzz Testing group: Dynamic Analysis
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
type: reference, howto type: reference, howto
--- ---
......
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