chore: add api reference to download report section #7243
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
You can check the documentation for this PR here -> Prowler Documentation |
AdriiiPRodri
force-pushed
the
add-api-reference-link-export
branch
from
10792c2 to
2578d91
Compare
|
You can check the documentation for this PR here -> Prowler Documentation |
toniblyx
reviewed
Mar 14, 2025
|
You can check the documentation for this PR here -> Prowler Documentation |
vicferpoy
approved these changes
Mar 14, 2025
toniblyx
requested changes
Mar 14, 2025
| @@ -184,3 +184,6 @@ To download these files, click the **Download** button. This button becomes avai | |||
| This action downloads a `zip` file containing an `output` folder, which includes the files mentioned above: CSV, JSON-OSCF, and HTML reports. | |||
|
|
|||
| <img src="../../img/output_folder.png" alt="Output folder" width="700"/> | |||
|
|
|||
| ???+ note | |||
| To learn more about the API endpoint used to perform the download check: [Prowler API Reference](https://api.prowler.com/api/v1/docs#tag/Scan/operation/scans_report_retrieve) | |||
There was a problem hiding this comment.
Suggested change
| To learn more about the API endpoint used to perform the download check: [Prowler API Reference](https://api.prowler.com/api/v1/docs#tag/Scan/operation/scans_report_retrieve) | |
| To learn more about the API endpoint to download reports via API see public reference: [Prowler API Reference - Scan/operation/scans_report_retrieve](https://api.prowler.com/api/v1/docs#tag/Scan/operation/scans_report_retrieve) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In this PR we added the API reference for the download report part.
Checklist
API
License
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.