Skip to content

fix: Improve documentation for DAST reports upload #2383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lventura-codacy merged 1 commit into from
Apr 17, 2025
Merged

fix: Improve documentation for DAST reports upload #2383

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/codacy-api/examples/uploading-dast-results.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@

1. Upload the report to Codacy using the API endpoint [<span class="skip-vale">uploadDASTReport</span>](https://app.codacy.com/api/api-docs#uploaddastreport):

!!! note
The DAST report must be under 20MB in size.
!!! important
The DAST report must be under 20MB in size. Please also guarantee that @generated timestamps are in an English locale, and use the default ZAP format (EEE, d MMM yyyy HH:mm:ss), as otherwise the report won't be processed.

Check failure on line 18 in docs/codacy-api/examples/uploading-dast-results.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'yyyy'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'yyyy'?", "location": {"path": "docs/codacy-api/examples/uploading-dast-results.md", "range": {"start": {"line": 18, "column": 171}}}, "severity": "ERROR"}

```bash
curl -X POST https://app.codacy.com/api/v3/organizations/<GIT_PROVIDER>/<ORGANIZATION>/security/tools/dast/<TOOL_NAME>/reports \
Expand Down
Loading